j1-template 2020.0.22 → 2020.0.24

data/lib/starter_web/_data/j1_config.yml

@@ -297,12 +297,13 @@ rouge:
 #                                         ]
 
 font:
-  preload:                              true
+  preload:                              false
   cors:                                 crossorigin
-  fonts:                                [
-                                          /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Regular.woff,
-                                          /assets/themes/j1/core/fonts/materialdesign_icons/fonts/materialdesignicons-webfont.woff
-                                        ]
+  fonts:                                []
+  # fonts:                              [
+  #                                         /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Regular.woff,
+  #                                         /assets/themes/j1/core/fonts/materialdesign_icons/fonts/materialdesignicons-webfont.woff
+  #                                     ]
 css:
   preload:                              true
   css:                                  [
@@ -325,7 +326,7 @@ js:
                                           /assets/themes/j1/adapter/js/navigator.js
                                         ]
 image:
-  preload:                              true
+  preload:                              false
   files:                                [ /assets/images/modules/icons/j1/j1-512x512.png ]
 
 # ------------------------------------------------------------------------------

data/lib/starter_web/_data/layouts/home.yml

@@ -179,11 +179,11 @@ lanes:
   # DIVIDER banner
   #
   - lane:
-      enabled:                          true
+      enabled:                          false
       id:                               divider-1
       region:                           body-main
       type:                             async
-      properties:                       mt-4 mb-4
+      properties:                       mt-4 mr-5 mb-4 ml-5
 
   # ----------------------------------------------------------------------------
   # INTRO panel
@@ -233,7 +233,7 @@ lanes:
       id:                               divider-2
       region:                           body-main
       type:                             async
-      properties:                       mt-4 mb-4
+      properties:                       mt-4 mr-5 mb-4 ml-5
 
   # ----------------------------------------------------------------------------
   # NEWS panel
@@ -245,5 +245,15 @@ lanes:
       type:                             async
       properties:                       mt-3 mr-5 mb-3 ml-3
 
+  # ----------------------------------------------------------------------------
+  # FAM
+  #
+  - lane:
+      enabled:                          true
+      id:                               fam-container
+      region:                           body-main
+      type:                             async
+      properties:                       fam-container                           # fam-btn
+
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/layouts/page.yml

@@ -181,5 +181,15 @@ lanes:
       path:                             modules/connectors
       file:                             comments
 
+  # ----------------------------------------------------------------------------
+  # FAM
+  #
+  - lane:
+      enabled:                          true
+      id:                               fam-container                           # page_fam
+      region:                           body-main
+      type:                             async
+      properties:                       fam-container                           # fam-btn
+
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/layouts/post.yml

@@ -182,5 +182,15 @@ lanes:
       path:                             modules/connectors
       file:                             comments
 
+  # ----------------------------------------------------------------------------
+  # FAM
+  #
+  - lane:
+      enabled:                          true
+      id:                               fam-container                           # page_fam
+      region:                           body-main
+      type:                             async
+      properties:                       fam-container                           # fam-btn
+
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/modules/defaults/{ssm.yml → fam.yml}

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------
-# ~/_data/modules/ssm.yml
-# Default Configuration of the SSC Module (Sticky Side Menu)
+# ~/_data/modules/fam.yml
+# Default Configuration of the FAM Module (Floating Action Menu)
 #
 # Product/Info:
 # https://jekyll.one
@@ -19,32 +19,29 @@
 # About this configuration (used for J1 CC only)
 #
 about_config:
-  title:                                Sticky Side Menu
+  title:                                Floating Action Menu
   scope:                                Default settings
-  location:                             _data/modules/defaults/ssm.yml
+  location:                             _data/modules/defaults/fam.yml
 
 # ------------------------------------------------------------------------------
 # Default settings
 #
 defaults:
   enabled:                              false
+  mode:                                 icon
 
-  xhr_container_id:                     ssm-container
-  xhr_data_path:                        /assets/data/ssm/index.html
-  menu_id:                              ssm_menu
+  xhr_container_id:                     fam-container
+  xhr_data_path:                        /assets/data/fam/index.html
 
   icon_family:                          MDI
   icon_color:                           mdi-md-grey
   icon_size:                            mdi-2x
+  raised_level:                         5
 
-  min_width:                            200
-  margin:                               -140
-  mode:                                 menu
-
-  # ----------------------------------------------------------------------------
-  # CONTAINER elements (empty for default)
-  #
-  items:
+  menu_options:
+    direction:                          top
+    hoverEnabled:                       false
+    toolbarEnabled:                     false
 
 # ------------------------------------------------------------------------------
 # END config

data/lib/starter_web/_data/modules/defaults/lunr_search.yml

@@ -0,0 +1,171 @@
+# ------------------------------------------------------------------------------
+#  ~/_data/modules/defaults/jekyll_search.yml
+#  Default configuration settings for J1 SimpleJekyllSearch module
+#
+#  Product/Info:
+#  https://jekyll.one
+#
+#  Copyright (C) 2020 Juergen Adams
+#
+#  J1 Template is licensed under the MIT License.
+#  See: https://github.com/jekyll-one/J1 Template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# About this configuration (used for J1 CC only)
+#
+about_config:
+  title:                                J1LunrSearch
+  scope:                                Default settings
+  location:                             _data/modules/defaults/lunr_search.yml
+
+# ------------------------------------------------------------------------------
+# J1LunrSearch settings
+#
+#   enabled
+#   ----------------------------------------------------------------------------
+#   Enables|Disables the use of J1 Search Manager
+#
+#   values:                         boolean (true|false)
+#   default:                        false
+#
+#   placement
+#   ----------------------------------------------------------------------------
+#   Enables|Disables the console log
+#
+#   values:                         boolean (true|false)
+#   default:                        false
+#
+#   target
+#   ----------------------------------------------------------------------------
+#   The ID used for the bootstrap theme css file
+#
+#   values:                         string
+#   default:                        bootstrapTheme
+#
+#   searchInput
+#   ----------------------------------------------------------------------------
+#   If true, a cookie will be saved with the currently selected theme
+#
+#   values:                         boolean (true|false)
+#   default:                        true
+#
+#   resultsOutput
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   resultsContainer
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   indexData
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   resultTemplate
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   resultLimit
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   minSearchItemLen
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   searchFuzzy
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+#   searchExlude
+#   ----------------------------------------------------------------------------
+#   TBD
+#
+#   values:                         string
+#   default:
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# About this configuration (used for J1 CC only)
+#
+about_config:
+
+  title:                                J1LunrSearch
+  scope:                                Default settings
+  location:                             _data/modules/defaults/jekyll_search.yml
+
+# ------------------------------------------------------------------------------
+# Default settings
+#
+defaults:
+
+  enabled:                              false
+  placement:                            navbar
+  target:                               _blank
+
+  excludes:                             [ /assets/*, /apps/*, /log/* , /node_modules/*, '/*\.htm*/' ]
+  stopwords:                            /assets/themes/j1/modules/lunrSearch/stopwords.txt
+  stopwords_locale:                     de
+  strip_index_html:                     false
+  min_length:                           3
+  date_format:                          mmm dd, yyyy
+
+  module_dir:                           /assets/themes/j1/modules/lunrSearch/js
+  index_dir:                            /assets/data
+  index_name:                           lunr-index.json
+  index_file:                           /assets/data/lunr-index.json
+
+  search_input:                         '#search-query'                         # '#jss-input'
+  results:                              '#search-results'                       # selector for containing search results element
+  template:                             '#search-results-template'              # selector for Mustache.js template
+  titleMsg:                                                                     # '<h1>Search results<h1>' message attached in front of results (can be empty)
+  emptyMsg:                                                                     # '<p>Nothing found.</p>' # shown message if search returns no results
+
+
+  # search_input:                         jss-input
+  # results_output:                       jss-panel
+  # results_container:                    jss-results
+  # index_data:                           /assets/data/search.json
+  # result_limit:                         1000
+  # result_truncate:                      100
+  # no_results_text:                      The search has no results
+  # min_search_item_len:                  5
+  # search_fuzzy:                         false
+  # search_exlude:                        [ Impress ]
+  # result_template: >
+  #                                       <li>
+  #                                         <div>
+  #                                           <h4 class="result-item"> <a href="{url}" target="{target}">{title} - {tagline}</a> </h4>
+  #                                           <p class="result-group-item-text">{excerpt}</p>
+  #                                           <p class="result-group-item-text small text-muted mb-3">
+  #                                             <i class="mdi mdi-calendar-blank mdi-18px mr-1"></i>{date}
+  #                                             <i class="mdi mdi-tag mdi-18px ml-2 mr-1"></i>{tags}
+  #                                           </p>
+  #                                         </div>
+  #                                       </li>
+
+# ------------------------------------------------------------------------------
+# END config

data/lib/starter_web/_data/modules/defaults/navigator.yml

@@ -118,7 +118,7 @@ defaults:
     xhr_container_id:                   navigator_nav_menu
     xhr_data_path:                      /assets/data/menu/index.html
 
-    raised_level:                       15                                      # level
+    raised_level:                       5                                       # level
     delay_menu_open:                    200                                     # milli seconds
     max_height:                         550                                     # px
     menu_font_size:                     larger
@@ -136,13 +136,13 @@ defaults:
     dropdown_animate_out:               fadeOutDown
     dropdown_animate_duration:          .75                                     # seconds
     dropdown_item_min_width:            15                                      # rem
-    dropdown_menu_max_height:           25                                      # rem
+    dropdown_menu_max_height:           35                                      # rem
     dropdown_font_size:                 small
-    dropdown_padding_x:                 15                                      # px
+    dropdown_padding_x:                 18                                      # rem
     dropdown_padding_y:                 10                                      # px
     dropdown_item_color:                "#212121"                               # md-grey-900
     dropdown_border_color:              "#3f51b5"                               # BS bg-primary
-    dropdown_border_top:                3                                       # px
+    dropdown_border_top:                0                                       # 3, px
     dropdown_border_radius:             0                                       # px
     dropdown_background_color_hover:    "#ECEFF1"                               # md-bluegrey-50
     dropdown_background_color_active:   "#CFD8DC"                               # md-bluegrey-100

data/lib/starter_web/_data/modules/defaults/toccer.yml

@@ -156,11 +156,13 @@ defaults:
   contentSelector:                      .js-toc-content
   headingSelector:                      "h2, h3, h4, h5, h6"
   ignoreSelector:                       .notoc
-  collapseDepth:                        2
-  throttleTimeout:                      50
+  collapseDepth:                        3
+  activeLinkColor:                      "#f44336"
+  throttleTimeout:                      150
   scrollSmooth:                         true
   scrollSmoothDuration:                 300
   scrollSmoothOffset:                   -90                                     # TODO: to be removed, calculated dynamically
+  scrollContainer:                      null                                    # ??? scrollContainer
 
 # ------------------------------------------------------------------------------
 # END config

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

@@ -0,0 +1,158 @@
+# ------------------------------------------------------------------------------
+# ~/_data/modules/fam.yml
+# User Configuration of the FAM Module (Floating Action Menu)
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2020 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+# NOTE:
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# About this configuration (used for J1 CC only)
+#
+about_config:
+  title:                                Floating Action Menu
+  scope:                                User settings
+  location:                             _data/modules/fam.yml
+
+# ------------------------------------------------------------------------------
+# User settings
+#
+settings:
+  enabled:                              true
+
+  menu_options:
+    hoverEnabled:                       true
+
+  # ----------------------------------------------------------------------------
+  # User defined FAM buttons
+  #
+  menus:
+
+    # --------------------------------------------------------------------------
+    # FAM for scrolling to the page top position (default)
+    #
+    - name:                             Scroll to top
+      enabled:                          true
+      id:                               default
+      icon:                             plus
+      icon_hover:                       chevron-up
+      color:                            md-blue
+
+      # ------------------------------------------------------------------------
+      # MENU items
+      #
+      items:
+        - item:
+          enabled:                      true
+          event_handler:                scroll_to_top
+
+    # --------------------------------------------------------------------------
+    # FAM to open sidebar-based (Mmenu Drawer) table of contents (toccer)
+    #
+    - name:                             Open TOC
+      enabled:                          true
+      id:                               open_toc
+      icon:                             plus
+      icon_hover:                       wrap
+      color:                            md-blue
+
+      # ------------------------------------------------------------------------
+      # MENU items
+      #
+      items:
+        - item:
+          enabled:                      true
+          event_handler:                open_mmenu_toc
+
+    # --------------------------------------------------------------------------
+    # FAM for in-page navigation
+    #
+    - name:                             in-page control
+      enabled:                          true
+      id:                               page_ctrl
+#     menu:
+#     mode:                             menu
+      icon:                             plus
+      icon_hover:                       cursor-pointer
+      color:                            md-blue
+
+      # ------------------------------------------------------------------------
+      # MENU items
+      #
+      items:
+
+        - item:                         Reload Page
+          enabled:                      true
+          id:                           fam_reload_page
+          color:                        md-red
+          event_handler:                reload_page
+          icon:                         reload
+          icon_properties:
+
+        - item:                         Table of Contents
+          enabled:                      true
+          id:                           open_mmenu_toc
+          color:                        md-blue
+          event_handler:                open_mmenu_toc
+          icon:                         wrap
+          icon_properties:
+
+        - item:                         To Top
+          enabled:                      true
+          id:                           fam_scroll_to_top
+          color:                        md-green
+          event_handler:                scroll_to_top
+          icon:                         step-backward-2
+          icon_properties:              rotate-90
+
+        - item:                         Previous Section
+          enabled:                      true
+          id:                           fam_previous_section
+          color:                        md-green
+          event_handler:                scroll_previous_section
+          icon:                         step-backward
+          icon_properties:              rotate-90
+
+        - item:                         Next Section
+          enabled:                      true
+          id:                           fam_next_section
+          color:                        md-green
+          event_handler:                scroll_next_section
+          icon:                         step-forward
+          icon_properties:              rotate-90
+
+        - item:                         To bottom
+          enabled:                      true
+          id:                           fam_scroll_to_bottom
+          color:                        md-green
+          event_handler:                scroll_to_bottom
+          icon:                         step-forward-2
+          icon_properties:              rotate-90
+
+      # - item:                         Leave a Comment
+      #   enabled:                      false
+      #   id:                           fam_scroll_to_comments
+      #   properties:
+      #   event_handler:                scroll_to_comments
+      #   icon:                         comment
+      #   icon_properties:
+      #
+      # - item:                         Tester
+      #   enabled:                      false
+      #   id:                           fam_test
+      #   properties:
+      #   event_handler:                alert_me
+      #   icon:                         alert
+      #   icon_properties:
+
+# ------------------------------------------------------------------------------
+# END config