j1-template 2022.1.0 → 2022.1.3

data/lib/starter_web/_plugins/lunr_index.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------
 # ~/_plugins/lunr_index.rb
-# Creates an lunr index file (json) to be used by J1LunrSearch
+# Creates an Lunr index file (json) to be used by J1 Lunr
 #
 # Product/Info:
 # http://jekyll.one
@@ -28,11 +28,14 @@ module Jekyll
         @template = config['theme']
 
         @module_path = File.join(File.dirname(__FILE__))
-        @module_path.slice! "_plugins"
+        @module_path.slice! '_plugins'
         @module_config_path = File.join(@module_path, config['data_dir'], 'modules')
+        @j1_config_path = config['data_dir']
 
-        @module_config_default = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'quicksearch.yml')))
-        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'quicksearch.yml')))
+        @j1_config = YAML::load(File.open(File.join(@j1_config_path, 'j1_config.yml')))
+
+        @module_config_default = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'lunr.yml')))
+        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'lunr.yml')))
 
         @module_config_default_settings = @module_config_default['defaults']
         @module_config_user_settings = @module_config_user['settings']
@@ -53,6 +56,8 @@ module Jekyll
           }
         }.merge!(@module_config || {})
 
+        @lunr_config.merge!(@j1_config['posts'])
+
         @module_dir = @lunr_config['module_dir']
         @index_dir  = @lunr_config['index_dir']
         @index_name = @lunr_config['index_name']
@@ -85,7 +90,7 @@ module Jekyll
 
         # @strip_categories configuration
         #
-        @strip_categories = @lunr_config['strip_categories']
+        @strip_categories = @lunr_config['category_blacklist']
         @stripped_categories = @strip_categories.join(',').gsub!(',', ' ')
 
         # stop word exclusion configuration
@@ -107,7 +112,7 @@ module Jekyll
 
         if @module_config['rebuild'] == false
           if File.exist?(index_file)
-            Jekyll.logger.info 'J1 QuickSearch:', 'recreate index disabled.'
+            Jekyll.logger.info 'J1 Lunr:', 'recreate index disabled.'
             # Keep the index file from being cleaned by Jekyll
             #
             site.static_files << SearchIndexFile.new(site, site.dest, '/', @module_config['index_file'])
@@ -115,7 +120,7 @@ module Jekyll
           end
         end
 
-        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
+        Jekyll.logger.info 'J1 Lunr:', 'creating search index ...'
 
         # gather posts and pages
         #
@@ -181,7 +186,7 @@ module Jekyll
         #
         FileUtils.mkdir_p(File.dirname(filepath))
         File.open(filepath, 'w') { |f| f.write(JSON.dump(total)) }
-        Jekyll.logger.info 'J1 QuickSearch:', "finished, index ready."
+        Jekyll.logger.info 'J1 Lunr:', "finished, index ready."
         added_files = [filename]
 
         # Keep the written files from being cleaned by Jekyll
@@ -364,6 +369,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2022.1.0'
+    VERSION = '2022.1.3'
   end
 end

data/lib/starter_web/collections/asciidoc_skeletons/simple-post/{yyyy-mm-dd-your-post-name.adoc → _posts/yyyy-mm-dd-your-post-name.asciidoc}

@@ -1,28 +1,39 @@
 ---
+layout:                                 post
+
 title:                                  Your title
 tagline:                                your tagline
-date:                                   YYYY-MM-DD 00:00:00 +0100
 keywords: >
                                         place, your, keywords, here
 
-categories:                             [ Featured, Post ]
-tags:                                   [ J1, Jekyll ]
+categories:                             [ Template ]
+tags:                                   [ Simple Post ]
+
+image:                                  /assets/images/modules/attics/sigmund-1920x1280.jpg
 
-image:                                  /assets/images/modules/attics/katie-moum-1920x1280.jpg
+#personalization:                       false
+#exclude_from_search:                   false
+#series:                                false
+#toc:                                   true
+#fab_menu_id:                           page_ctrl_simple
+#scrollbar:                             false
 
 regenerate:                             false
-resources:                              [ animate ]
+
+resources:                              []
 resource_options:
   - attic:
+      padding_top:                      400
+      padding_bottom:                   50
       opacity:                          0.5
       slides:
-        - url:                          /assets/images/modules/attics/katie-moum-1920x1280.jpg
-          alt:                          Photo by Katie Moum on Unsplash
+        - url:                          /assets/images/modules/attics/sigmund-1920x1280.jpg
+          alt:                          Photo by Sigmund on Unsplash
           alignY:                       0.3
           badge:
             type:                       unsplash
-            author:                     Katie Moum
-            href:                       https://unsplash.com/@katiemoum
+            author:                     Sigmund
+            href:                       https://unsplash.com/@sigmund
 ---
 
 // Page Initializer
@@ -33,13 +44,13 @@ resource_options:
 // Set (local) page attributes here
 // -----------------------------------------------------------------------------
 // :page--attr:                         <attr-value>
+// :post-image:                         /assets/images/modules/attics/sigmund-1920x1280.jpg
 
 // Place an excerpt at the most top position
 // -----------------------------------------------------------------------------
 [role="dropcap"]
-All you’re doing at the end of the day is writing your content, and the J1
-Template does all the tricky things: putting out HTML, Javascript, and CSS.
-As a result, the site creation process gets out of your way.
+The Asciidoc skeleton *simple-post* a helper for setting up a base file
+and folder structure for post articles.
 
 excerpt__end
 
@@ -58,6 +69,9 @@ excerpt__end
 // Include sub-documents (if any)
 // -----------------------------------------------------------------------------
 
+// [role="mt-3 mb-5"]
+// image::{post-image}[{{page.title}}]
+
 [[readmore]]
 == What is a static site?
 

data/lib/starter_web/collections/posts/public/featured/_posts/2021-02-01-site-generators.adoc

@@ -2,8 +2,8 @@
 title:                                  Site Generators
 tagline:                                top open source tools
 
-categories:                             [ Knowledge ]
-tags:                                   [ Jekyll, Generators ]
+categories:                             [ Knowledge, Jekyll ]
+tags:                                   [ Static Site, Generators ]
 
 image:                                  /assets/images/modules/attics/machine-generator-1920x1280.jpg
 

data/lib/starter_web/collections/posts/public/featured/_posts/2022-02-28-about-j1.adoc

@@ -2,7 +2,7 @@
 title:                                  J1 Template
 tagline:                                first version for the public is out
 
-categories:                             [ Knowledge ]
+categories:                             [ Knowledge, Jekyll ]
 tags:                                   [ J1, Template ]
 
 image:                                  /assets/images/modules/attics/runner-1920x1200.jpg

data/lib/starter_web/collections/posts/public/series/_posts/2020-01-01-post-wiki-series.adoc

@@ -2,8 +2,8 @@
 title:                                  Minneapolis
 tagline:                                largest city in the state of minnesota
 
-categories:                             [ Examples ]
-tags:                                   [ Series, USA, Minnesota, Cities, Minneapolis ]
+categories:                             [ Examples, Series ]
+tags:                                   [ USA, Minnesota, Cities, Minneapolis ]
 
 series:                                 wiki-series
 image:                                  /assets/images/collections/blog/wikipedia/minneapolis.1200x400.jpg

data/lib/starter_web/collections/posts/public/series/_posts/2020-01-02-post-wiki-series.adoc

@@ -2,8 +2,8 @@
 title:                                  Narcisse Snake Dens
 tagline:                                largest snake population
 
-categories:                             [ Examples ]
-tags:                                   [ Series, Canada, Cities, Narcisse ]
+categories:                             [ Examples, Series ]
+tags:                                   [ Canada, Cities, Narcisse ]
 
 series:                                 wiki-series
 image:                                  /assets/images/collections/blog/wikipedia/narcise-snake-pits.1200x400.jpg

data/lib/starter_web/collections/posts/public/series/_posts/2020-01-03-post-wiki-series.adoc

@@ -2,8 +2,8 @@
 title:                                  Columbia River
 tagline:                                largest river in the pacific northwest
 
-categories:                             [ Examples ]
-tags:                                   [ Series, USA, Rivers ]
+categories:                             [ Examples, Series ]
+tags:                                   [ USA, Rivers ]
 
 series:                                 wiki-series
 image:                                  /assets/images/collections/blog/wikipedia/columbia-river.1200x400.jpg

data/lib/starter_web/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "j1",
-  "version": "2022.1.0",
+  "version": "2022.1.3",
   "description": "J1 Template Starter Web",
   "homepage": "https://your.site",
   "author": {

data/lib/starter_web/pages/public/_blog/navigator/archive/categoryview.html

@@ -0,0 +1,254 @@
+---
+layout:                                 page
+title:                                  Starter Blog
+tagline:                                posts by category
+date:                                   2023-01-01 01:00:00 +100
+description:                            Browse articles by category
+
+categories:                             [ Blog ]
+tags:                                   [ Navigator, Categories ]
+
+sort:                                   date
+toc:                                    true
+fab_menu_id:                            open_toc
+
+pagination:
+  enabled:                              false
+  permalink:                            /page:num/
+
+analytics:                              true
+comments:                               false
+
+exclude_from_search:                    true
+regenerate:                             true                                    # needed to update pages
+
+resources:                              [ animate ]
+resource_options:
+  - attic:
+      padding_top:                      400
+      padding_bottom:                   50
+      opacity:                          0.5
+      slides:
+        - url:                          /assets/images/modules/attics/matthaeus-1920x1280.jpg
+          alt:                          Photo by Matthaeus
+          alignY:                       top
+          badge:
+            type:                       unsplash
+            author:                     Matthaeus
+            href:                       https://unsplash.com/@matthaeus123
+---
+
+{% comment %} Liquid procedures
+-------------------------------------------------------------------------------- {% endcomment %}
+{% capture get_page_path %}themes/{{site.template.name}}/procedures/global/get_page_path.proc{% endcapture %}
+{% capture select_icon_size %}themes/{{site.template.name}}/procedures/global/select_icon_size.proc{% endcapture %}
+{% capture get_category_item %}themes/{{site.template.name}}/procedures/global/get_category_item.proc{% endcapture %}
+{% capture create_word_cloud %}themes/{{site.template.name}}/procedures/global/create_word_cloud.proc{% endcapture %}
+
+{% comment %} Set config files
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign template_config         = site.data.j1_config %}
+{% assign blocks                  = site.data.blocks %}
+{% assign modules                 = site.data.modules %}
+{% assign builder                 = site.data.builder %}
+{% assign plugins                 = site.data.plugins %}
+
+{% comment %} Set config data
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign blog_navigator_defaults = builder.defaults.blog_navigator.defaults %}
+{% assign blog_navigator_settings = builder.blog_navigator.settings %}
+
+{% comment %} Set config options
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign blog_navigator_options  = blog_navigator_defaults | merge: blog_navigator_settings %}
+
+{% comment %} Variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign truncate_words          = site.excerpt_truncate_words %}
+{% assign category_blacklist      = template_config.posts.category_blacklist %}
+
+
+{% if site.permalink == 'none' %}
+  {% capture browser_page_url %}{{page.url}}.html{% endcapture %}
+{% else %}
+  {% capture browser_page_url %}{{page.url}}{% endcapture %}
+{% endif %}
+
+{% include {{get_page_path}} mode='absolute' %}
+{% assign navigator_path = page_path|remove_first:'archive' %}
+
+{% capture navigator %}{{navigator_path}}{% endcapture %}
+{% capture date_view %}{{page_path}}/dateview/{% endcapture %}
+{% capture category_view %}{{page_path}}/categoryview/{% endcapture %}
+{% capture tag_view %}{{page_path}}/tagview/{% endcapture %}
+{% capture all_view %}{{page_path}}/{% endcapture %}
+
+{% if page.sort == 'title' %}
+  {% assign sorted_posts = site.posts|sort: 'title' %}
+{% elsif page.sort == 'date' %}
+  {% assign sorted_posts = site.posts|sort: 'date' %}
+{% else %}
+  {% assign sorted_posts = site.posts|sort: 'date' %}
+{% endif %}
+
+{% comment %} TODO: skip_words NOT longer needed? Already done
+by processing of categories
+--------------------------------------------------------------------------------
+{% capture skip_words %} Posts Public {% endcapture %}
+--------------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} category processing
+-------------------------------------------------------------------------------- {% endcomment %}
+{% for category in category_blacklist %}
+{% assign capitalized = category|capitalize %}
+  {% capture black_list %}{{black_list|append: capitalized}}{% unless forloop.last %},{% endunless %}{% endcapture %}
+{% endfor %}
+{% assign skip_categories = black_list | split: "," | join: " " %}
+
+{% capture site_category_word_list %}{% for category in site.categories %}{{category|first|capitalize|lstrip|rstrip}}{% unless forloop.last %},{% endunless %}{% endfor %}{% endcapture %}
+{% assign category_words = site_category_word_list|split:',' %}
+{% assign categories = category_words|uniq %}
+
+{% for category in categories %}
+  {% if skip_categories contains category %} {% continue %} {% endif %}
+  {% capture category_list %}{{category_list|append: category}}{% unless forloop.last %},{% endunless %}{% endcapture %}
+{% endfor %}
+
+{% comment %} language detection
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.language == "en" %}
+  {% assign language = "en" %}
+{% elsif site.language == "de"%}
+  {% assign language = "de" %}
+{% else %}
+  {% assign language = "en" %}
+{% endif %}
+
+{% if language == "en" %}
+  {% assign readmore_text               = "read" %}
+  {% assign category_view_button_text = blog_navigator_options.button_text.view_selector.category_view.en %}
+  {% assign date_view_button_text     = blog_navigator_options.button_text.view_selector.date_view.en %}
+  {% assign archive_view_button_text  = blog_navigator_options.button_text.view_selector.archive_view.en %}
+  {% assign tag_view_button_text      = blog_navigator_options.button_text.view_selector.tag_view.en %}
+
+  {% assign view_headline             = blog_navigator_options.category_view.page_text.en.headline %}
+  {% assign view_description_text     = blog_navigator_options.category_view.page_text.en.description %}
+{% endif %}
+
+{% if language == "de" %}
+  {% assign readmore_text               = "lesen" %}
+
+  {% assign category_view_button_text = blog_navigator_options.button_text.view_selector.category_view.de %}
+  {% assign date_view_button_text     = blog_navigator_options.button_text.view_selector.date_view.de %}
+  {% assign archive_view_button_text  = blog_navigator_options.button_text.view_selector.archive_view.de %}
+  {% assign tag_view_button_text      = blog_navigator_options.button_text.view_selector.tag_view.de %}
+
+  {% assign view_headline             = blog_navigator_options.category_view.page_text.de.headline %}
+  {% assign view_description_text     = blog_navigator_options.category_view.page_text.de.description %}
+{% endif %}
+
+{% comment %} Debugging
+--------------------------------------------------------------------------------
+skip_categories:            {{skip_categories | debug}}
+site_category_word_list:    {{site_category_word_list | debug}}
+--------------------------------------------------------------------------------
+{% endcomment %}
+
+
+{% comment %} Main
+-------------------------------------------------------------------------------- {% endcomment %}
+<!-- [INFO   ] [ {{page.url}} ] [Generate HTML}] -->
+{% include {{create_word_cloud}} source="categories" word_list=category_list %}
+
+<!-- [INFO   ] [ {{page.url}} ] [Generate HTML}] -->
+<div class="paginator ml-3">
+  <ul class="pagination raised-z0">
+    <li class="page-item"><a class="page-link" href="{{navigator|prepend: site.baseurl}}" alt="Blog Navigator">Navigator</a></li>
+    <li class="page-item"><a class="page-link" href="{{date_view}}" alt="View by Date">{{date_view_button_text}}</a></li>
+    <!-- li class="page-item"><a class="page-link" href="{{tag_view}}" alt="{{tag_view_button_text}}">By Tag</a></li -->
+    <li class="page-item"><a class="page-link" href="{{all_view}}" alt="View All">{{archive_view_button_text}}</a></li>
+  </ul>
+</div>
+
+<div class="post-search-results ml-3">
+  {% if blog_navigator_options.category_view.page_text.enabled %}
+  <div class="view-description">{{view_description_text}}</div>
+  {% endif %}
+
+  <div class="post-headline">
+    <h1 id="post-headline notoc" class="mt-5">{{view_headline}}</h1>
+  </div>
+  {% assign tags = site.categories|sort %}
+  {% for tag in tags %}
+    {% assign category = tag|first %}
+    {% unless category_list contains category %} {% continue %} {% endunless %}
+    <h2 id="{{tag|first|downcase}}" class="anchor-link mb-4"><i class="mdi mdi-pin mr-1"></i>{{tag|first|capitalize}}</h2>
+
+      {% for post in sorted_posts %}
+        {%if post.categories contains tag[0]%}
+          {% assign category = tag|first %}
+          {% include {{get_category_item}} category=category %}
+          {% include {{select_icon_size}} family=icon_family size=icon_size %}
+          {% assign icon_size = size %}
+          {% comment %} {% assign excerpt = post.excerpt|truncatewords: truncate_words|replace:'...',' ...'|strip_html %} {% endcomment %}
+          {% assign excerpt = post.excerpt|truncatewords: truncate_words|replace:'...',' ...' %}
+
+          <!-- Collect comment provider details -->
+          {% for sharing in builder_config.sharing_provider %}
+            {% assign provider      = sharing.provider %}
+            {% assign likes_count   = sharing.likes_count %}
+            {% assign comment_count = sharing.comment_count %}
+          {% endfor %}
+
+          <article class="card raised-z3 mb-5">
+            <h3 id="{{100000|rand}}" class="card-header bg-primary">{{post.title}}</h3>
+            <div class="row mx-0">
+
+              <!-- [INFO   ] [j1.pages.blog.navigator.archive          ] [Check if post image is available] -->
+              {% if post.image %}
+              <!-- [INFO   ] [j1.pages.blog.navigator.archive          ] [Post image is available] -->
+              <div class="col-md-6 img-bg--fill px-0"
+                style="border-right: 1px dotted rgba(0, 0, 0, 0.25); background-image: url({{post.image}});">
+              </div>
+              {% else %}
+              <!-- [INFO   ] [j1.pages.blog.navigator.archive          ] [Post image missing, using configured default image] -->
+              <div class="col-md-6 img-bg--fill px-0"
+                style="border-right: 1px dotted rgba(0, 0, 0, 0.25); background-image: url({{blog_navigator_options.post_image}});">
+              </div>
+              {% endif %}
+
+              <div class="col-md-6 p-0">
+                <div class="card-body r-text-300">{{excerpt}}</div>
+                <div class="card-footer not-rounded r-text-200">
+                  <div class="card-footer-text">
+
+                    {% if post.date %}
+                      {% if language == "en" %}
+                        <i class="mdi mdi-calendar-blank md-grey-600 mr-1"></i>{{post.date | localize: "%Y %B, %e"}}
+                      {% endif %}
+                      {% if language == "de" %}
+                        <i class="mdi mdi-calendar-blank md-grey-600 mr-1"></i>{{post.date | localize: "%-d. %B %Y"}}
+                      {% endif %}
+                    {% endif %}
+                    {% if likes_count %}
+                    <span class="font-weight-bold"> · </span>
+                    <i class="mdi mdi-heart mr-1"></i> {{likes_count}}
+                    {% endif %}
+                    {% if comment_count %}
+                    <span class="font-weight-bold"> · </span>
+                    <i class="mdi mdi-comment mr-1"></i> {{comment_count}}
+                    {% endif %}
+                  </div>
+                  <a class="card-link text-muted text-lowercase"
+                     href="{{post.url}}#readmore">
+                     {{readmore_text}} · {{post.tagline}}
+                  </a>
+                </div>
+              </div>
+            </div>
+          </article>
+        {% endif %}
+      {% endfor %}
+  {% endfor %}
+</div>