j1-template 2021.0.3 → 2021.0.4

data/lib/starter_web/_data/modules/{lunr_search.yml → quicksearch.yml}

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------
 #  ~/_data/modules/lunr_search.yml
-#  User configuration settings for J1LunrSearch module
+#  User configuration settings for J1 QuickSearch module
 #
 #  Product/Info:
 #  https://jekyll.one
@@ -16,7 +16,7 @@
 #
 about_config:
 
-  title:                                J1LunrSearch
+  title:                                J1 LunrSearch
   scope:                                User settings
   location:                             _data/modules/lunr_search.yml
 
@@ -29,7 +29,7 @@ settings:
   placement:                            navbar
   target:                               _blank
 
-  stopwords_locale:                     de
+  stopwords_locale:                     en
   min_length:                           3
 
 # ------------------------------------------------------------------------------

data/lib/starter_web/_data/modules/themer.yml

@@ -26,7 +26,7 @@ about_config:
 #
 settings:
 
-  enabled:                              false
+  enabled:                              true
   saveToCookie:                         true
   debug:                                false
 

data/lib/starter_web/_data/resources.yml

@@ -351,12 +351,11 @@ resources:
   #   5   log4javascript                log4javascript@1.4.15
   #   6   Bootstrap                     bootstrap@4.4.1
   #   6   bs_material_design            bootstrap-material-design@4.0.0-beta.4
-  #   7   j1_template                   j1_template_4@2021.0.3
+  #   7   j1_template                   j1_template_4@2021.0.4
   #   8   tocbot                        tocbot@4.12.0
-  #   9   jekyll_search                 simple_jekyll_search@1.1.5
   #   10  bs_theme_switcher             bs_theme_switcher@1.1.5
   #   11  backstretch                   backstretch@2.1.16
-  #   12  cookiebar                     cookiebar@2021.0.3
+  #   12  cookiebar                     cookiebar@2021.0.4
   #
   # ----------------------------------------------------------------------------
   #   J1 Template Core, integrated CSS Resources
@@ -576,29 +575,6 @@ resources:
         js:                             []
         init_function:                  [ j1.adapter.back2top.init ]
 
-  # ----------------------------------------------------------------------------
-  # SimpleSearch, search engine for Jekyll sites based on Simple-Jekyll-Search
-  # https://github.com/christian-fei/Simple-Jekyll-Search
-  #
-  #
-  - name:                               J1 SimpleSearch
-    resource:
-      id:                               simple_search
-      enabled:                          false                                   # NOT longer used (lunr search preferred)
-      comment:                          module quicksearch
-      region:                           head
-      layout:                           [ all ]
-      required:                         always
-      preload:                          false                                   # property currently unused
-      script_load:                      sync
-      dependencies:                     false
-      pass_init_data:                   false
-      data:
-        css:                            [ modules/jekyllSearch/css/jekyll-search ]
-        files:                          [ adapter/js/searcher.js ]
-        js:                             [ modules/jekyllSearch/js/simple-jekyll-search ]
-        init_function:                  [ j1.adapter.searcher.init ]
-
   # ----------------------------------------------------------------------------
   # CookieBar
   #
@@ -712,7 +688,7 @@ resources:
         init_function:                  []
 
   # ----------------------------------------------------------------------------
-  # Responsive HTML tables for J! Template (rtable)
+  # Responsive HTML tables for J1 Template (rtable)
   #
   - name:                               Responsive Tables
     resource:
@@ -1200,7 +1176,7 @@ resources:
       enabled:                          true
       comment:                          Floating Button Menu
       region:                           head
-      layout:                           [ all ]
+      layout:                           [ page, post, collection ]              # TODO: check if FAM makes sense for layout app
       required:                         always
       preload:                          false                                   # property currently unused
       script_load:                      sync
@@ -1220,14 +1196,14 @@ resources:
         init_function:                  [ j1.adapter.fam.init ]
 
   # ----------------------------------------------------------------------------
-  # lunr
+  # QuickSearch (lunr for J1 Template)
   # NOTE: This module is in state EXPERIMENTAL
   #
-  - name:                               lunr
+  - name:                               QuickSearch
     resource:
-      id:                               lunr
+      id:                               quicksearch
       enabled:                          true
-      comment:                          lunr search
+      comment:                          J1 QuickSearch
       region:                           head
       layout:                           [ all ]
       required:                         always                                  # always | ondemand
@@ -1236,17 +1212,38 @@ resources:
       dependencies:                     false
       pass_init_data:                   false
       data:
-        css:                            [ modules/lunrSearch/css/lunr_search ]
-        files:                          [ adapter/js/lunr_search.js ]
+        css:                            [ modules/lunrSearch/css/quicksearch ]
+        files:                          [ adapter/js/quicksearch.js ]
         js:                             [
                                           modules/lunrSearch/js/lunr,
                                           modules/lunrSearch/js/mustache,
                                           modules/lunrSearch/js/dateformat,
                                           modules/lunrSearch/js/uri,
-#                                         modules/jquery/js/require,            # property currently unused, conflicts with some modules
-                                          modules/lunrSearch/js/lunr_search
+#                                         modules/jquery/js/require,            # require.js currently unused, but conflicts with some modules
+                                          modules/lunrSearch/js/quicksearch
                                         ]
-        init_function:                  [ j1.adapter.lunr_search.init ]
+        init_function:                  [ j1.adapter.quicksearch.init ]
+
+  # ----------------------------------------------------------------------------
+  # Data tables for J1 Template
+  #
+  - name:                               Data Tables
+    resource:
+      id:                               datatables
+      enabled:                          false
+      comment:                          module datatables
+      region:                           head
+      layout:                           [ all ]
+      required:                         ondemand
+      preload:                          false                                   # property currently unused
+      script_load:                      async
+      dependencies:                     false
+      pass_init_data:                   false
+      data:
+        css:                            [ modules/datatables/css/datatables ]
+        files:                          [ modules/datatables/css/theme/uno.css ]
+        js:                             [ modules/datatables/js/datatables ]
+        init_function:                  []
 
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_includes/attributes.asciidoc

@@ -136,6 +136,7 @@ tag::tags[]
 :browser-window--new:                             window="_blank"
 :clipboard--noclip:                               noclip
 :level--beginner:                                 icon:battery-quarter[role="md-blue"]
+:level--intermediate:                             icon:battery-half[role="md-blue"]
 :level--advanced:                                 icon:battery-full[role="md-blue"]
 :figure-caption--text:                            Figure
 
@@ -143,6 +144,7 @@ tag::tags[]
 :icon-times:                                      icon:times[role="red"]
 :icon-file:                                       icon:file-alt[role="blue"]
 :icon-battery--quarter:                           icon:battery-quarter[role="md-blue"]
+:icon-battery--half:                              icon:battery-half[role="md-blue"]
 :icon-battery--full:                              icon:battery-full[role="md-blue"]
 
 :char-emdash:                                     —
@@ -182,7 +184,7 @@ end::tables[]
 // -----------------------------------------------------------------------------
 tag::products[]
 :j1-license:                                      MIT License
-:j1-version:                                      2021.0.3
+:j1-version:                                      2021.0.4
 end::products[]
 
 

data/lib/starter_web/_plugins/lunr_index.rb

@@ -31,8 +31,8 @@ module Jekyll
         @module_path.slice! "_plugins"
         @module_config_path = File.join(@module_path, config['data_dir'], 'modules')
 
-        @module_config_default = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'lunr_search.yml')))
-        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'lunr_search.yml')))
+        @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')))
 
         @module_config_default_settings = @module_config_default['defaults']
         @module_config_user_settings = @module_config_user['settings']
@@ -83,17 +83,23 @@ module Jekyll
         #
         @strip_index_html = @lunr_config['strip_index_html']
 
+        # @strip_categories configuration
+        #
+        @strip_categories = @lunr_config['strip_categories']
+        @stripped_categories = @strip_categories.join(',').gsub!(',', ' ')
+
         # stop word exclusion configuration
         #
         @min_length = @lunr_config['min_length']
         @stopwords_file = @lunr_config['stopwords']
+
       end
 
       # Index all pages except pages matching any value in config['lunr_excludes']
       # or with frontmatter settings (exclude_from_search: true)
       #
       def generate(site)
-        Jekyll.logger.info 'J1 LunrSearch:', 'creating search index ...'
+        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
 
         @site = site
         # gather posts and pages
@@ -103,7 +109,7 @@ module Jekyll
         # index = []
 
         index_js = open(@lunr_path).read
-        # all settings must be added within the index function
+        # NOTE: all settings must be added within the index function
         #
         index_js << 'var idx = lunr(function() {'
 
@@ -130,7 +136,11 @@ module Jekyll
             'body'        => entry.body
           }
 
+          # remove unwanted categories
+          doc['categories'] -= @strip_categories
+
           index_js << 'this.add(' << ::JSON.generate(doc, quirks_mode: true) << ');'
+
           # reduce the size of the doc array by deleting the body key
           doc.delete('body')
           @docs[i] = doc
@@ -146,12 +156,13 @@ module Jekyll
           'docs'  => @docs,
           'index' => ::JSON.parse(index, {:max_nesting => false})
         }
-
         filepath  = File.join(site.dest, filename)
+
         # create data path if not already exists
+        #
         FileUtils.mkdir_p(File.dirname(filepath))
         File.open(filepath, 'w') { |f| f.write(JSON.dump(total)) }
-        Jekyll.logger.info 'J1 LunrSearch:', "finished, index ready"
+        Jekyll.logger.info 'J1 QuickSearch:', "finished, index ready."
         added_files = [filename]
 
         # Keep the written files from being cleaned by Jekyll
@@ -250,7 +261,7 @@ module Jekyll
           elsif defined?(site.data['date'])
             date = site.data['date']
           else
-            date = '2020-01-01 00:00:00'
+            date = '2021-01-01 00:00:00'
           end
 
           tagline     = site.data['tagline']
@@ -311,6 +322,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '1.0.0'
+    VERSION = '2021.0.4'
   end
 end

data/lib/starter_web/assets/images/modules/icons/d1/scalable/d1.svg

@@ -14,7 +14,7 @@
    version="1.1"
    inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)"
    sodipodi:docname="d1.svg"
-   inkscape:export-filename="C:\Temp\d10n-2021.0.3\assets\images\modules\icons\d1\d1-256x256.png"
+   inkscape:export-filename="C:\Temp\d10n-2021.0.4\assets\images\modules\icons\d1\d1-256x256.png"
    inkscape:export-xdpi="49.152"
    inkscape:export-ydpi="49.152">
   <title

data/lib/starter_web/dot.gitattributes

@@ -12,20 +12,6 @@
 #
 # ------------------------------------------------------------------------------
 
-# Enforce Unix newlines
+# Enforce Unix newlines, all text files
 #
-*.css   text eol=lf
-*.html  text eol=lf
-*.js    text eol=lf
-*.json  text eol=lf
-*.md    text eol=lf
-*.py    text eol=lf
-*.rb    text eol=lf
-*.scss  text eol=lf
-*.svg   text eol=lf
-*.yml   text eol=lf
-# Don't diff or textually merge source maps
-*.map   binary
-
-bootstrap.css linguist-vendored=false
-bootstrap.js linguist-vendored=false
+* text=auto eol=lf

data/lib/starter_web/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "j1_starter",
-  "version": "2021.0.3",
+  "version": "2021.0.4",
   "description": "J1 Template Starter Web",
   "homepage": "https://your.site",
   "author": {
@@ -41,14 +41,14 @@
     "opt_skip_initial_build": "--skip-initial-build",
     "opt_webserver": "puma",
     "opt_interface": "0.0.0.0",
-    "opt_web_port": "4000",
-    "opt_web_url": "http://localhost:4000/",
-    "opt_app_port": "8000",
-    "opt_app_url": "http://localhost:8000/",
+    "opt_web_port": "40000",
+    "opt_web_url": "http://localhost:40000/",
+    "opt_app_port": "40010",
+    "opt_app_url": "http://localhost:40010/",
     "opt_profile": "",
     "opt_watch": "--watch",
     "opt_livereload": "--livereload",
-    "opt_livereload_port": "44000"
+    "opt_livereload_port": "40001"
   },
   "algolia": {
     "admin_key": "your-algolia-admin-key"

data/lib/starter_web/pages/protected/site_search.adoc

@@ -3,13 +3,8 @@ title:                                  Site Search
 tagline:                                Full-text search engine
 description:                            Algolia Index for all documents
 
-tags:                                   [
-                                          Doc, Post, Documents, Full, Text,
-                                          Site, Search, Engine, Algolia
-                                        ]
-index:                                  []
-categories:                             [ pages ]
-
+tags:                                   [ Algolia ]
+categories:                             [ Search ]
 toc:                                    false
 
 permalink:                              /pages/protected/site_search/

data/lib/starter_web/pages/public/learn/kickstarter/web_in_a_day/100_meet_and_greet_jekyll.adoc

@@ -9,7 +9,7 @@ description: >
                                         J1 Template which all people needs to know for a successful
                                         way to a modern static website using Jekyll and J1 Template
 
-tags:                                   [ Kickstarter, Introduction ]
+tags:                                   [ Introduction ]
 categories:                             [ Jekyll, Knowledge, Tutorial ]
 
 permalink:                              /pages/public/learn/kickstarter/web_in_a_day/meet_and_greet/

data/lib/starter_web/pages/public/learn/kickstarter/web_in_a_day/200_preparations.adoc

@@ -5,7 +5,7 @@ date:                                   2018-05-01 00:00:00
 description: >
                                         Modern static website in a day
 
-tags:                                   [ Kickstarter, Introduction ]
+tags:                                   [ Preparations ]
 categories:                             [ Jekyll, Knowledge, Tutorial ]
 
 permalink:                              /pages/public/learn/kickstarter/web_in_a_day/preparations/
@@ -42,7 +42,7 @@ resource_options:
 
 // Load page attributes
 // -----------------------------------------------------------------------------
-{% include {{load_attributes}} scope="none" %}
+{% include {{load_attributes}} scope="all" %}
 
 
 // Page content

data/lib/starter_web/pages/public/learn/kickstarter/web_in_a_day/300_first_awesome_web.adoc

@@ -5,7 +5,7 @@ date:                                   2018-05-01 00:00:00
 description: >
                                         Modern static website in a day
 
-tags:                                   [ Kickstarter, Introduction ]
+tags:                                   [ WebDesign ]
 categories:                             [ Jekyll, Knowledge, Tutorial ]
 
 permalink:                              /pages/public/learn/kickstarter/web_in_a_day/first_awesome_web/
@@ -42,7 +42,7 @@ resource_options:
 
 // Load page attributes
 // -----------------------------------------------------------------------------
-{% include {{load_attributes}} scope="none" %}
+{% include {{load_attributes}} scope="all" %}
 
 
 // Page content

data/lib/starter_web/pages/public/learn/roundtrip/600_lunr.adoc

@@ -3,10 +3,10 @@ title:                                  Lunr
 tagline:                                full index search
 date:                                   2020-11-08 12:00:00
 description: >
-                                        Learn the search query language used by Lunr. The DSL used by Lunr
-                                        is quite close to Solr to support a powerful search experience
-                                        for better result. Using search expressions with wildcards, conditions
-                                        like and|or and fuzzy search algorithms are supported.
+                                        The search engine Lunr is fully integrated with
+                                        J1 Template. Designed to be small, yet full featured,
+                                        to provide a great search experience without the
+                                        need for external, server-side, search services.
 
 tags:                                   [ Roundtrip, Introduction ]
 categories:                             [ Search ]
@@ -49,74 +49,173 @@ resource_options:
 // Page content
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-== Searching
+The search engine Lunr is fully integrated with J1 Template. Designed to be
+small, yet full featured, to provide a great search experience without the
+need for external, server-side search services.
 
-After you have built an index of your documents, the next step is to
-perform a search.
+Searching a website using Lunr a different in compare to search engines
+like Google or Microsoft Bing. These search platforms using complex algorithm
+to provide a simple interface to the public using a lot of artificial
+intelligence (AI) methods to make senseful results out of a handfull words
+given for a search.
 
-The simplest way to start is to pass the text on which you want to
-search into the search method:
+Nevertheless, a QuickSearch, the J1 implementation of Lunr, is simple like
+searching at Google, but offers additional features to do searches more
+specific. QuickSearch provides a easy to use query language for better results.
 
-[source, javascript]
+== Core concepts
+
+Understanding some of the concepts and terminology that QuickSearch (based on
+Lunr) uses will allow you to provide powerful search functionality to get more
+relevant search results.
+
+=== Indexing documnents
+
+QuickSearch, the J1 implementation of Lunr, offers searches on *all* documents
+of website generated by J1, but only for this site. No internet access is done,
+or needed. Searches are based on a pre-build *local index* generated by the
+Jekyll plugin `lunr_index.rb` located in the `_plugins` folder.
+
+The index is generated at build-time:
+
+.Index creation at buildtime
 ----
-idx.search('foo')
+Startup the site ..
+Configuration file: ...
+
+ Incremental build: enabled
+      Generating...
+     J1 LunrSearch: creating search index ...
+     J1 LunrSearch: finished, index ready.
+     ....
 ----
 
-The above will return details of all documents that match the term
-“foo”. Although it looks like a string, the `search` method parses the
-string into a search query. This supports special syntax for defining
-more complex queries.
+Or, if you're running a website in development mode, the index gets refreshed
+for all files added or modified.
 
-Searches for multiple terms are also supported. If a document matches
-_at least_ one of the search terms, it will show in the results. The
-search terms are combined with OR.
+.Index creation if files added, or modified
+----
+site:       Regenerating: n file(s) changed at ...
+site:       ...
+site:      J1 LunrSearch: creating search index ...
+site:      J1 LunrSearch: finished, index ready.
+           ...
+----
 
-[source, javascript]
+=== Documents
+
+The searchable data in an index is organized as documents that contains the
+text that you want to be able to search. A document is a JSON object with one
+or more fields and an identifier that is returned in the results from a search.
+A document representing an article might look like this:
+
+[ source, json ]
 ----
-idx.search('foo bar')
+{
+  "id": 0,
+  "title": "Web in a Day",
+  "tagline": "meet & greet jekyll",
+  "url": "/pages/public/learn/kickstarter/web_in_a_day/meet_and_greet/",
+  "date": "2018-05-01 00:00:00 +0000",
+  "tags": [
+    "Introduction"
+  ],
+  "categories": [
+    "Jekyll",
+    "Knowledge",
+    "Tutorial"
+  ],
+  "description": "Web in a Day is the first in a series of tutorials ... J1 Template\n",
+  "is_post": false
+}
 ----
 
-The above example will match documents that contain either “foo” or
-“bar”. Documents that contain _both_ will score more highly and will be
-returned first.
+In this document there are several fields, like `title`, `tagline`, or
+`description` that could be used for *full-text* searches. But additional
+fields are available, like `tags` or `categories` that can be used for
+more specific searches based on `identifiers`.
+
+To do a simple full-text search as well as more specific searches, QuickSearch
+offers a query language, a DSL (domain specific language). Find more about
+*QuickSearch DSL* queries below.
 
 === Scoring
 
-The score (also known as relevance) of a document is calculated by the
-https://en.wikipedia.org/wiki/Okapi_BM25[BM25] algorithm, along with
-other factors such as link:#Boosts[boosts]. You don’t need to worry too
-much about the details of how BM25 works; to summarize, the more a
-search term occurs in a single document, the more that term will
-increase that document’s score, but the more a search term occurs in the
-overall _collection_ of documents, the less that term will increase a
-document’s score.
-
-For example, let’s say you’re indexing a collection of documents about
-JavaScript testing libraries. The terms “JavaScript”, “library”, and
-“test” may occur very frequently throughout the entire collection, so
-finding a document that mentions one of these terms isn’t very
-significant. However, if you’re searching for “integration test”, only
-three documents in the collection have the term “integration” in them,
-and _one_ of them mentions “integration” many times, that will bring the
-score for that one document higher up.
+The relevance (the `score`) of a document is calculated by an algorithm
+called BM25, along with other factors. You don’t need to worry too much about
+the details of how BM25 works. To summarize, the more a search term occurs in
+a single document, the more that term will increase that document’s score,
+but the more a search term occurs in the *overall collection* of documents,
+the less that term will increase a document’s score. In other words: seldom
+words count, increase the score.
+
+Scoring information, generated by the BM25 algorithm, is added to the (local)
+index. This allows a very fast calculation of the relevance of documents for
+a query.
+
+For example, imagine you’re website contains documents about Jekyll. The
+term `Jekyll` may occur very frequently throughout the entire website
+(used quite often for the content), so finding a document that mentions the
+term Jekyll isn’t very significant.
+
+However, if you’re searching for `Jekyll Generator`, only some documents of
+the website have the term `Generator` in them, and that will bring the score
+(relevance) for documents having both terms (words) in them at a higher score,
+bring them higher up in your search results.
+
+Matching and scoring is used by all search engines; the same to J1 QuickSearch.
+You'll see for QuickSearch a similiar behavior in *sorting* search results as
+you already know from internet search engines like Google. The top results
+are the more relevant ones.
+
+== Searching
+
+Search queries looks like simple text. But the search `engine` Lunr under the
+hood transforms the given search string (text) always into a search query.
+This supports special syntax, the DSL, for defining more complex queries.
+
+As always: start simple!
+
+=== Simple searches
+
+The simplest way to run a search is to pass the text (words) on which you
+want to search on:
+
+----
+  jekyll
+----
+
+The above will return details of all documents that match the term
+`jekyll`. Searches for *multiple* terms (words) are also supported. If
+a document matches *at least* one of the search terms, it will show in the
+results. The search terms are combined with `OR`.
+
+----
+  jekyll generator
+----
+
+The above example will match documents that contain either `jekyll` *or*
+`generator`. Documents that contain _both_ will score more highly and will
+be returned first.
+
+NOTE: In difference to a Google search (terms are combined at Google by
+`AND`) a Quicksearch combines the terms by `OR`.
 
 === Wildcards
 
-Lunr supports wildcards when performing searches. A wildcard is
+QuickSearch supports wildcards when performing searches. A wildcard is
 represented as an asterisk (`*`) and can appear anywhere in a search
 term. For example, the following will match all documents with words
-beginning with “foo”:
+beginning with `Jek`:
 
-[source, javascript]
 ----
-idx.search('foo*')
+jek*
 ----
 
-This will match all documents that end with ‘oo’:
+This will match all documents that end with `kyll`:
 
-[source, javascript]
 ----
-idx.search('*oo')
+*kyll
 ----
 
 Leading wildcards, as in the above example, should be used sparingly.