j1-template 2020.0.4 → 2020.0.9

data/lib/j1/version.rb

@@ -1,3 +1,3 @@
 module J1
-  VERSION = '2020.0.4'
+  VERSION = '2020.0.9'
 end

data/lib/starter_web/Gemfile

@@ -51,7 +51,7 @@ gem 'jekyll', '~> 4.0'
 
 # Theme Rubies, default: J1 Template
 #
-gem 'j1-template', '~> 2020.0.4'
+gem 'j1-template', '~> 2020.0.9'
 
 # ------------------------------------------------------------------------------
 # PRODUCTION: Gem needed for the Jekyll and J1 prod environment
@@ -178,7 +178,7 @@ gem "puma", '>= 4.3.1'
 # authentication. For default, the Omniauth (authentication) strategies
 # for Github, Twitter, Facebook and Patreon are implemented.
 #
-# gem 'rack', '>= 2.0.8'
+# gem 'rack', '>= 2.2.3'
 # gem 'rack-protection', '~> 2.0'
 # gem 'rack-ssl-enforcer', '~> 0.2'
 # gem 'rest-client', '~> 2.0'

data/lib/starter_web/_config.yml

@@ -53,7 +53,7 @@ environment:                            production
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2020.0.4
+version:                                2020.0.9
 
 # version
 # ------------------------------------------------------------------------------

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

@@ -69,7 +69,7 @@ settings:
   #
   # ----------------------------------------------------------------------------
   j1_auth:
-    enabled:                            true
+    enabled:                            false
     ssl:                                false
 
     content:

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

@@ -0,0 +1,50 @@
+# ------------------------------------------------------------------------------
+# ~/_data/modules/ssm.yml
+# Default Configuration of the SSC Module (Sticky Side 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:                                Sticky Side Menu
+  scope:                                Default settings
+  location:                             _data/modules/defaults/ssm.yml
+
+# ------------------------------------------------------------------------------
+# Default settings
+#
+defaults:
+  enabled:                              false
+
+  xhr_container_id:                     ssm-container
+  xhr_data_path:                        /assets/data/ssm/index.html
+  menu_id:                              ssm_menu
+
+  icon_family:                          MDI
+  icon_color:                           mdi-md-grey
+  icon_size:                            mdi-2x
+
+  min_width:                            200
+  margin:                               -140
+  mode:                                 menu
+
+  # ----------------------------------------------------------------------------
+  # CONTAINER elements (empty for default)
+  #
+  items:
+
+# ------------------------------------------------------------------------------
+# END config

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

@@ -152,20 +152,15 @@ defaults:
   #       default:                      true
   #
   # ----------------------------------------------------------------------------
-  tocSelector:                        .js-toc
-  headingSelector:                    "h2, h3, h4, h5"
-  headingsOffset:                     500
-  ignoreSelector:                     .notoc
-  contentSelector:                    .js-toc-content
-  activeLinkColor:                    "#3F51B5"                                 # MD Indigo
-  collapseDepth:                      2
-  throttleTimeout:                    50
-  includeHtml:                        false
-  smoothScrollEnabled:                true
-  smoothScrollDuration:               300
-  smoothScrollOffset:                 90
-  headingsOffset:                     0
-  throttleTimeout:                    50
+  tocSelector:                          .js-toc
+  contentSelector:                      .js-toc-content
+  headingSelector:                      "h2, h3, h4, h5, h6"
+  ignoreSelector:                       .notoc
+  collapseDepth:                        2
+  throttleTimeout:                      50
+  scrollSmooth:                         true
+  scrollSmoothDuration:                 300
+  scrollSmoothOffset:                   -90
 
 
 # ------------------------------------------------------------------------------

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

@@ -67,10 +67,12 @@ settings:
             position:                   right
 
           content:
+            id:                         menu_mmenu
             type:                       navigation
             title:                      Starter Web
             theme:                      dark
-            toggler:                    "#navbar-toggler"
+            button:                     "#mmenu-button"
+            button_activated:           always
 
       # ------------------------------------------------------------------------
       # DRAWER Sidebar
@@ -85,12 +87,12 @@ settings:
             position:                   left
 
           content:
+            id:                         sidebar_mmenu
             type:                       drawer
             title:                      Site Info
             theme:                      dark
-            toggler:                    "#navbar-brand"
-            toggler_animation:          rotateIn
-            toggler_activated:          always
+            button:                     "#navbar-brand"
+            button_activated:           always
 
             boxes:
 
@@ -195,12 +197,12 @@ settings:
             position:                   right
 
           content:
+            id:                         toc_mmenu
             type:                       drawer
             title:                      Table of Contents
-            theme:                      light
-            toggler:                    "#toc-toggler"
-            toggler_animation:          rotateIn
-            toggler_activated:          "js-toc-content"
+            theme:                      dark
+            button:                     "#ssm_toc"
+            button_activated:           "js-toc-content"
 
   # ----------------------------------------------------------------------------
   # NavQuicklinks
@@ -211,8 +213,6 @@ settings:
     home_url:                           /                                       # none | URL
     back_url:                           none                                    # none | URL
 
-    toc_toggler:                        true
-
     r_text_sizer:                       false                                   # true | false
 
     github_url:                         https://github.com/jekyll-one

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

@@ -0,0 +1,142 @@
+# ------------------------------------------------------------------------------
+# ~/_data/modules/ssc.yml
+# User Configuration of the SSC Module (Sticky Side 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:                                Sticky Side Menu
+  scope:                                User settings
+  location:                             _data/modules/ssm.yml
+
+# ------------------------------------------------------------------------------
+# User settings
+#
+settings:
+  enabled:                              true
+  mode:                                 icon                                    # icon|menu
+
+  # ----------------------------------------------------------------------------
+  # CONTAINER elements
+  #
+  items:
+
+    # --------------------------------------------------------------------------
+    # TOPLEVEL items
+    #
+    - item:                             Reload Page
+      enabled:                          true
+      id:                               ssm_reload_page
+      href:
+      target:
+      event_handler:                    reload_page
+      icon:                             reload
+      icon_classes:
+
+    - item:                             Table of Contents
+      enabled:                          true
+      id:                               ssm_toc
+      href:
+      target:
+      event_handler:                    open_ssm_toc
+      icon:                             wrap
+      icon_classes:
+
+    - item:                             To Top
+      enabled:                          true
+      id:                               ssm_scroll_to_top
+      event_handler:                    scroll_to_top
+      href:
+      target:
+      icon:                             step-backward-2
+      icon_classes:                     mdi-rotate-90
+
+    - item:                             Previous Section
+      enabled:                          true
+      id:                               ssm_previous_section
+      event_handler:                    scroll_previous_section
+      href:
+      target:
+      icon:                             step-backward
+      icon_classes:                     mdi-rotate-90
+
+    - item:                             Next Section
+      enabled:                          true
+      id:                               ssm_next_section
+      event_handler:                    scroll_next_section
+      href:
+      target:
+      icon:                             step-forward
+      icon_classes:                     mdi-rotate-90
+
+    - item:                             To Bottom
+      enabled:                          true
+      id:                               ssm_scroll_to_bottom
+      event_handler:                    scroll_to_bottom
+      href:
+      target:
+      icon:                             step-forward-2
+      icon_classes:                     mdi-rotate-90
+
+    - item:                             Leave a Comment
+      enabled:                          false
+      id:                               ssm_scroll_to_comments
+      event_handler:                    scroll_to_comments
+      href:
+      target:
+      icon:                             comment
+      icon_classes:
+
+    - item:                             Tester
+      enabled:                          false
+      id:                               ssm_test
+      href:
+      target:
+      event_handler:                    alert_me
+      icon:                             alert
+      icon_classes:
+
+    # --------------------------------------------------------------------------
+    # MENU items
+    #
+    - item:                             Social Share
+      enabled:                          false
+      icon:                             menu
+      icon_classes:
+      sublevel:
+
+        - title:                        Facebook
+          enabled:                      true
+          id:                           ssm_facebook
+          href:                         https://www.facebook.com/sharer/sharer.php?u=http://demo.enigmaweb.com.au/
+          target:
+          event_handler:                window.open(this.href, 'facebook', 'left=60,top=40,width=500,height=500,toolbar=1,resizable=0'); return false;
+          icon:                         facebook
+          icon_classes:
+
+        - title:                        Twitter
+          enabled:                      true
+          id:                           ssm_twitter
+          href:                         https://twitter.com/home?status=http://demo.enigmaweb.com.au/
+          target:
+          event_handler:                window.open(this.href, 'twitter', 'left=60,top=40,width=500,height=500,toolbar=1,resizable=0'); return false;
+          icon:                         twitter
+          icon_classes:
+
+
+# ------------------------------------------------------------------------------
+# END config

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

@@ -32,8 +32,8 @@ settings:
   # ----------------------------------------------------------------------------
   #   Enables|Disables the use of J1 TocManager
   #
-  #   values:                         boolean (true|false)
-  #   default:                        false
+  #   values:                           boolean (true|false)
+  #   default:                          false
   #
   #   log
   #   --------------------------------------------------------------------------
@@ -45,7 +45,7 @@ settings:
   # ----------------------------------------------------------------------------
   enabled:                              true
   log:                                  false
-  delay:                                400                                     
+  delay:                                400
 
   # ----------------------------------------------------------------------------
   # MODULE settings
@@ -54,9 +54,9 @@ settings:
   # ----------------------------------------------------------------------------
   #   Specifies the <div> element where to render the table of contents.
   #
-  #   type:                           string (HTML class)
-  #   values:                         any HTML class
-  #   default:                        .js-toc
+  #   type:                             string (HTML class)
+  #   values:                           any HTML class
+  #   default:                          .js-toc
   #
   #   headingSelector
   #   --------------------------------------------------------------------------
@@ -110,64 +110,16 @@ settings:
   #     type:                           integer
   #     default:                        50
   #
-  #   scrollOptions
-  #   --------------------------------------------------------------------------
-  #   smooth-scroll options object, see more details at:
-  #   https://github.com/cferdinandi/smooth-scroll
-  #
-  #   values
-  #
-  #     easing                        Type|Speed of the scroll effect the heading|section
-  #                                   (of the content) is scrolled to if a toc element
-  #                                   has been selected.
-  #       Linear,                     moves at the same speed from start to finish.
-  #       EaseIn,                     gradually increases in speed.
-  #       EaseOut,                    gradually decreases in speed.
-  #       EaseInOut,                  gradually increases in speed, peaks, and then
-  #                                   gradually slows down.
-  #
-  #       values:                     Linear|
-  #                                   easeInQuad|easeInCubic|easeInQuart|easeInQuint
-  #                                   easeOutQuad|easeOutCubic|easeOutQuart|easeOutQuint
-  #                                   easeInOutQuad|easeInOutCubic|easeInOutQuart|easeInOutQuint
-  #
-  #       default:                    easeInOutCubic
-  #
-  #     offset
-  #       Amount of space (calculated as pixels) between the top of page and the
-  #       selected table of contents item after the page has been scrolled.
-  #
-  #       values:                     integer
-  #       default:                    0
-  #
-  #     speed
-  #       Overall time (measured in milliseconds) to complete the scroll.
-  #
-  #       values:                     integer
-  #       default:                    300
-  #
-  #     updateURL
-  #       ...
-  #
-  #       values:                     boolean (true|false)
-  #       default:                    true
-  #
   # ----------------------------------------------------------------------------
-  tocSelector:                      .js-toc
-  headingSelector:                  "h2, h3, h4, h5"
-  headingsOffset:                   500
-  ignoreSelector:                   .notoc
-  contentSelector:                  .js-toc-content
-  activeLinkColor:                  "#212121"                                   # md_bluegrey_900
-  collapseDepth:                    2
-  throttleTimeout:                  50
-  includeHtml:                      false
-  smoothScrollEnabled:              true
-  smoothScrollDuration:             300
-  smoothScrollOffset:               90
-  headingsOffset:                   0
-  throttleTimeout:                  50
-
+  tocSelector:                          .js-toc                                 # Where to render the table of contents
+  contentSelector:                      .js-toc-content                         # Where to grab the headings to build the table of contents
+  headingSelector:                      "h2, h3, h4, h5"                        # Which headings to grab inside of the contentSelector element
+  ignoreSelector:                       .notoc                                  # Headings that match the ignoreSelector will be skipped
+  collapseDepth:                        2                                       # How many heading levels should not be collapsed
+  throttleTimeout:                      50                                      # Timeout between firing events to make sure it's not too rapid
+  scrollSmooth:                         true
+  scrollSmoothDuration:                 300
+  scrollSmoothOffset:                   -80
 
 # ------------------------------------------------------------------------------
 # END config