RubyGems - j1_template_mde - Versions diffs - 2018.4.10 - Mend

j1_template_mde 2018.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (852) hide show

data/lib/starter_web/_data/layouts/default.yml ADDED Viewed

@@ -0,0 +1,230 @@
+# ------------------------------------------------------------------------------
+#    ~/_data/pages/base.yml
+#   Configuration data to specify the BASE (HTML) Layout of
+#   ALL content pages
+#
+#   Product/Info:
+#   https://jekyll-one.com
+#
+#   Copyright (C) 2019 Juergen Adams
+#
+#   J1 Template is licensed under the MIT License.
+#   See: https://github.com/jekyll-one/j1_template_mde/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+#  NOTE:
+#    By J1 template, "Liquid Procedures" are being used intensively. To load
+#    HTML data for a layout, the loader procedure places the data based this
+#    YAML data file into the REGION specified with a LANE.
+# ------------------------------------------------------------------------------
+# -------------------------------------------------------------------------
+# GLOBAL settings
+#
+# base
+# --------------------------------------------------------------------
+#   Defines a (canonical) base path.
+#
+#   core               (base) path for core components
+#   asset              (base) path for assets
+#
+# -------------------------------------------------------------------------
+# Layout configuration settings
+# lanes|lane
+# --------------------------------------------------------------------
+#   Set LANE specific configuration parameters for a page LAYOUT. The
+#   LANES array contains multiple (lane) hashes that describes the
+#   type of the component that is placed into a lane and their specific
+#   (placement) parameters.
+#
+# region
+# --------------------------------------------------------------------
+#   J1 Template defines, based on the general structure of a HTML
+#   page (head and body), more specific regions to place HTML data
+#   (lanes):
+#
+#   head              <HEAD> section. Contains (site-wide) meta
+#                     data (tags) and all CSS files to be loaded.
+#   body-navigation   <BODY> section. Contains the navigation bar
+#                     (NavManager). Placed a the BEGINNING of the
+#                     body region <body>.
+#   body-banner       <BODY> section. Contains the page banner
+#                     (header). Placed AFTER the page navigation
+#                     but BEFORE the page content.
+#   body-content      <BODY> section. J1 template puts a specific
+#                     <div> container element in the <BODY> section
+#                     to place the content. All content specific
+#                     elements are loaded into the region 'body-content'.
+#                     Content may e.g. boxes, panels, quotes and
+#                     the page content.
+#   body-footer       <BODY> section. J1 template puts a specific
+#                     <div> container element at the end of the
+#                     <BODY> section. The body-footer region contains
+#                     all elements that should be loaded at the
+#                     end of a page - typically the page footer.
+#
+#   values:                   head|body-navigation|body-banner|
+#                             body-content|body-footer
+#   default:                  no defaults
+#
+# type
+# --------------------------------------------------------------------
+#   The (HTML) CONTENT of a lane can be placed for sychronous (sync)
+#   or asychronous (async) load. If the content is placed synchronously,
+#   a core component of J1 Template (base = core) or an HTML adapter
+#   (base = module) generates the HTML code to be placed.
+#   If the content is placed asynchronously, only a <DIV> element, using
+#   an unique id, is placed for synchronous (page) load. The HTML code
+#   will be generated asynchronously (by a module) after the page is
+#   completely loaded (document-ready) and placed within the previously
+#   generated <DIV> element (e.g. by a module).
+#
+#   values:                   sync|async
+#   default:                  no defaults
+#
+# base
+# --------------------------------------------------------------------
+#   Type SYNC only. The parameter base defines a (canonical) BASE
+#   path.
+#
+#   values:                   core|asset
+#   default:                  no defaults
+#
+# path
+# --------------------------------------------------------------------
+#   Type SYNC only. The parameter path defines a PATH (relativ to BASE)
+#   to the data source to be placed.
+#
+#   values:                   string (path)
+#   default:                  no defaults
+#
+# file
+# --------------------------------------------------------------------
+#   Type SYNC only. Defines the FILE to be placed (and
+#   executed) for a lane.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# id
+# --------------------------------------------------------------------
+#   Type ASYNC only. Used for content placed asyncronously by (AJAX
+#   calls) on an DIV element using this id.
+#   the data on.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# class
+# --------------------------------------------------------------------
+#   Type ASYNC only. Additional CSS classes that are put on the
+#   DIV element using this id.
+#
+#   values:                   string (CSS class name)
+#   default:                  no defaults
+#
+# -------------------------------------------------------------------------
+# -------------------------------------------------------------------------
+# GLOBAL configuration settings
+#
+# -------------------------------------------------------------------------
+# Layout configuration settings
+#
+lanes:
+  # ------------------------------------------------------------------
+  # META data loader (head)
+  - lane:
+      enabled:                          true
+      region:                           head
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             layouts
+      file:                             layout_metadata_generator.html
+  # ------------------------------------------------------------------
+  # Module RESOURCE loader (head)
+  - lane:
+      enabled:                          true
+      region:                           head
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             layouts
+      file:                             layout_resource_generator.html
+  # ------------------------------------------------------------------
+  # THEME loader (head region)
+  - lane:
+      enabled:                          true
+      region:                           head
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             layouts
+      file:                             layout_theme_generator.html
+  # ------------------------------------------------------------------
+  #   NAV Module (body-navigation)
+  #
+  #   NOTE:
+  #   The Generator of the NAV Module (generator.html) is based
+  #   on several Liquid procedures to generate the HTML code for
+  #   all components of the navigation system (NAV Module) as:
+  #   MainMenu, Quicklinks, SideBar and TopSearch.
+  #
+  - lane:
+      enabled:                          true
+      region:                           body-navigation
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             modules/navigator
+      file:                             generator.html
+  # ------------------------------------------------------------------
+  #   FOOTER (body-footer)
+  #
+  #   NOTE:
+  #   The FOOTER component (default: footer_light_themes.html) is
+  #   a complex LOADER based on several Liquid procedures to LOAD
+  #   and INITIALIZE all parts of the page footer (cards) as:
+  #   About, News, Links and Contact.
+  #
+  - lane:
+      enabled:                          true
+      region:                           body-footer
+#     type:                             sync
+#     base:                             _includes/themes/j1
+#     path:                             modules/footers
+#     file:                             footer_light_generator.html
+      type:                             async
+      id:                               j1_footer
+  # ------------------------------------------------------------------
+  #   Module SHIM loader (body-footer)
+  #
+  #   NOTE:
+  #
+  - lane:
+      enabled:                          true
+      region:                           body-footer
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             layouts
+      file:                             layout_shim_generator.html
+  # ------------------------------------------------------------------
+  #   MODULE runner (body-footer)
+  #
+  #   NOTE:
+  #
+  #
+  - lane:
+      enabled:                          true
+      region:                           body-footer
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             layouts
+      file:                             layout_module_generator.html

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

@@ -0,0 +1,203 @@
+# ------------------------------------------------------------------------------
+#    ~/_data/layouts/home.yml
+#   Configuration data to specify the (HTML) Layout of all content
+#   pages of type HOME placed by the content loader
+#
+#   Product/Info:
+#   https://jekyll-one.com
+#
+#   Copyright (C) 2019 Juergen Adams
+#
+#   J1 Template is licensed under the MIT License.
+#   See: https://github.com/jekyll-one/j1_template_mde/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+#  NOTE:
+#    By J1 template, "Liquid Procedures" are being used intensively. To load
+#    HTML data for a layout, the loader procedure places the data based this
+#    YAML data file into the REGION specified with a LANE.
+# ------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
+# Layout configuration settings
+# ------------------------------------------------------------------------------
+# Layout configuration settings
+# lanes|lane
+# -------------------------------------
+#   Set LANE specific configuration parameters for a page LAYOUT. The
+#   LANES array contains multiple (lane) hashes that describes the type
+#   of the component that is loaded into a lane and their specific
+#   (placement) parameters.
+#
+# region
+# -------------------------------------
+#   J1 templates defines, based on the general structure of a HTML page
+#   (head|body), more specific REGIONS based on HTML5 semantic elements
+#   to place HTML data:
+#
+#   head              <head> section. Contains (site-wide) meta data and
+#                     all CSS and JS files are to be loaded for a page.
+#   body-navigation   <body> NAV section. Contains the main navigation bar.
+#                     Placed a the BEGINNING of the <body> section.
+#   body-header       <body> HEADER section. Contains the page banner (header).
+#                     Placed AFTER the page navigation but BEFORE the main
+#                     content (body-main) of a page.
+#   body-main         <body> MAIN section. J1 template puts a <main> container
+#                     element in the <body> section to place the (main) content.
+#                     All content related elements are loaded into the region
+#                     'body-main'. Content may components like boxes, panels,
+#                     quotes etc. and the document content like sections and
+#                     articles.
+#   body-footer       <body> FOOTER section. J1 template puts a <footer> element
+#                     at the end of the <BODY> section. The body-footer region
+#                     contains all elements that should be loaded at the end
+#                     of a page; typically the page footer.
+#
+#   values:           head|body-navigation|body-header|body-main|body-footer
+#   default:          no defaults
+#
+# comment
+# -------------------------------------
+#   Each lane should be commented for easier reading the HTML source code.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# type
+# -------------------------------------
+#   The (HTML) content of a lane can be included (from an include file) or
+#   loaded asychronously from a HTML data file by AJAX (get|load) calls.
+#   J1 template is using jQuery as an interface to AJAX calls.
+#
+#   values:                   include|load
+#   default:                  no defaults
+#
+# source
+# -------------------------------------
+#   The parameter source defines a (site root relativ) path to the data
+#   source to be included or loaded.
+#
+#   values:                   string (path)
+#   default:                  no defaults
+#
+# file
+# -------------------------------------
+#   Defines the data file to be included or loaded.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# id
+# -------------------------------------
+#   Used for AJAX load calls (see parameter type). The id is used twice. First,
+#   id references a HTML fragment as part of the (HTML) data file (see parameter
+#   data below). Second, the id is used to identify the placeholder (div)
+#   element where the AJAX call puts the data on.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# helper_classes
+# -------------------------------------
+#   Additional CSS classes that are put on the placeholder (div) element.
+#   Can be used for type 'load', only.
+#
+#   values:                   string (CSS class name)
+#   default:                  no defaults
+#
+# ------------------------------------------------------------------------------
+lanes:
+# ------------------------------------------------------------------------------
+# MASTER header
+#
+  - lane:
+      enabled:                          true
+      region:                           body-header
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             modules/headers
+      file:                             master_header_generator.html
+# ------------------------------------------------------------------------------
+# MASTER slider
+#
+  - lane:
+      enabled:                          false
+      region:                           body-header
+      type:                             async
+      id:                               master_slider
+      helper_classes:                   mb-0
+# ------------------------------------------------------------------------------
+#   PAGE CONTENT (region body-main)
+#
+#   NOTE:
+#     The CONTENT of a post or page may already rendered (page contains HTML
+#     data) or unrendered (page contains MARKUP data). In both cases, rendered
+#     or unrendered content, a valid FRONTMATTER is needed to pass the data.
+#
+#     The CONTENT generation for posts and pages depends on the data type,
+#     the MARKUP language (Markdown, Asciidoc) the page is using. The data
+#     type is specified by the file EXTENSION (e.g. ".md" for Markdown or
+#     ".adoc" for Asciidoc formatted content).
+#
+#     To enable Jekyll running the render phase, the respective processor
+#     (e.g.kramdown for MARKDOWN or asciidoctor for ASCIIDOC) needs to be
+#     loaded and configured (Gemfile and the side-wide configuration file
+#     _config.yml).
+#
+#   NOTE:
+#     The CONTENT of a PAGE is passed trough a (Liquid) wrapper procedure
+#     (page_content.html) to add or inject specific ADDITIONAL data like
+#     a TOC etc. that influences the resulting page.
+#
+#     To modify the wrapper, DO NOT CHANGE the template files. See with
+#     ***URL*** how to create your own wrapper (and OVERLOAD the J1 template
+#     system with the data you provided).
+#
+# ------------------------------------------------------------------------------
+# <!-- [INFO   ] [j1.layout.content_writer.proc      ] [load region 'body-main' for layout: home] -->
+# ------------------------------------------------------------------------------
+# TEASER banner
+#
+  - lane:
+      enabled:                            true
+      region:                             body-main
+      type:                               async
+      id:                                 home_teaser_banner
+      helper_classes:                     mt-3 mb-3
+# ------------------------------------------------------------------------------
+# INTRO panel
+#
+  - lane:
+      enabled:                            true
+      region:                             body-main
+      type:                               async
+      id:                                 home_intro_panel
+      helper_classes:                     mt-5 mb-5
+# ------------------------------------------------------------------------------
+# PARALLAX banner
+#
+  - lane:
+      enabled:                            true
+      region:                             body-main
+      type:                               async
+      id:                                 home_parallax_banner
+      helper_classes:                     mb-3
+# ------------------------------------------------------------------------------
+# NEWS panel
+#
+  - lane:
+      enabled:                            true
+      region:                             body-main
+      type:                               async
+      id:                                 home_news_panel
+      helper_classes:                     mb-0

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

@@ -0,0 +1,154 @@
+# ------------------------------------------------------------------------------
+#    ~/_data/layouts/page.yml
+#   Configuration data to create the (HTML) Layout (data) of all content
+#   pages of type PAGE
+#
+#   Product/Info:
+#   https://jekyll-one.com
+#
+#   Copyright (C) 2019 Juergen Adams
+#
+#   J1 Template is licensed under the MIT License.
+#   See: https://github.com/jekyll-one/j1_template_mde/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+#  NOTE:
+#    By J1 template, "Liquid Procedures" are being used intensively. To load
+#    HTML data for a layout, the loader procedure places the data based this
+#    YAML data file into the REGION specified with a LANE.
+# ------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
+# Layout configuration settings
+# lanes|lane
+# -------------------------------------
+#   Set LANE specific configuration parameters for a page LAYOUT. The
+#   LANES array contains multiple (lane) hashes that describes the type
+#   of the component that is loaded into a lane and their specific
+#   (placement) parameters.
+#
+# region
+# -------------------------------------
+#   J1 templates defines, based on the general structure of a HTML page
+#   (head|body), more specific REGIONS based on HTML5 semantic elements
+#   to place HTML data:
+#
+#   head              <head> section. Contains (site-wide) meta data and
+#                     all CSS and JS files are to be loaded for a page.
+#   body-navigation   <body> NAV section. Contains the main navigation bar.
+#                     Placed a the BEGINNING of the <body> section.
+#   body-header       <body> HEADER section. Contains the page banner (header).
+#                     Placed AFTER the page navigation but BEFORE the main
+#                     content (body-main) of a page.
+#   body-main         <body> MAIN section. J1 template puts a <main> container
+#                     element in the <body> section to place the (main) content.
+#                     All content related elements are loaded into the region
+#                     'body-main'. Content may components like boxes, panels,
+#                     quotes etc. and the document content like sections and
+#                     articles.
+#   body-footer       <body> FOOTER section. J1 template puts a <footer> element
+#                     at the end of the <BODY> section. The body-footer region
+#                     contains all elements that should be loaded at the end
+#                     of a page; typically the page footer.
+#
+#   values:           head|body-navigation|body-header|body-main|body-footer
+#   default:          no defaults
+#
+# type
+# -------------------------------------
+#   The (HTML) content of a lane can be included (from an include file) or
+#   loaded asychronously from a HTML data file by AJAX (get|load) calls.
+#   J1 template is using jQuery as an interface to AJAX calls.
+#
+#   values:                   include|load
+#   default:                  no defaults
+#
+# source
+# -------------------------------------
+#   The parameter source defines a (site root relativ) path to the data
+#   source to be included or loaded.
+#
+#   values:                   string (path)
+#   default:                  no defaults
+#
+# file
+# -------------------------------------
+#   Defines the data file to be included or loaded.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# id
+# -------------------------------------
+#   Used for AJAX load calls (see parameter type). The id is used twice. First,
+#   id references a HTML fragment as part of the (HTML) data file (see parameter
+#   data below). Second, the id is used to identify the placeholder (div)
+#   element where the AJAX call puts the data on.
+#
+#   values:                   string
+#   default:                  no defaults
+#
+# class
+# -------------------------------------
+#   Additional CSS classes that are put on the placeholder (div) element.
+#   Can be used for type 'load', only.
+#
+#   values:                   string (CSS class name)
+#   default:                  no defaults
+#
+# ------------------------------------------------------------------------------
+lanes:
+# ------------------------------------------------------------------------------
+#   Page HEADER (region body-header)
+#
+#   NOTE:
+#     All pages are using a specific banner to display a title and a
+#     tagline. Title and tagline are to be configured with the FRONTMATTER
+#     of a page for individual data (text).
+#
+# ------------------------------------------------------------------------------
+  - lane:
+      enabled:                          true
+      region:                           body-header
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             modules/headers
+      file:                             master_header_generator.html
+# ------------------------------------------------------------------------------
+#   PAGE CONTENT (region body-main)
+#
+#   NOTE:
+#     The CONTENT of a post or page may already rendered (page contains HTML
+#     data) or unrendered (page contains MARKUP data). In both cases, rendered
+#     or unrendered content, a valid FRONTMATTER is needed to pass the data.
+#
+#     The CONTENT generation for posts and pages depends on the data type,
+#     the MARKUP language (Markdown, Asciidoc) the page is using. The data
+#     type is specified by the file EXTENSION (e.g. ".md" for Markdown or
+#     ".adoc" for Asciidoc formatted content).
+#
+#     To enable Jekyll running the render phase, the respective processor
+#     (e.g.kramdown for MARKDOWN or asciidoctor for ASCIIDOC) needs to be
+#     loaded and configured (Gemfile and the side-wide configuration file
+#     _config.yml).
+#
+#   NOTE:
+#     The CONTENT of a PAGE is passed trough a (Liquid) wrapper procedure
+#     (page_content.html) to add or inject specific ADDITIONAL data like
+#     a TOC etc. that influences the resulting page.
+#
+#     To modify the wrapper, DO NOT CHANGE the template files. See with
+#     ***URL*** howto create your own wrapper (and OVERLOAD the J1 template
+#     system with the data you provided).
+#
+# ------------------------------------------------------------------------------
+  - lane:
+      enabled:                          true
+      region:                           body-main
+      type:                             sync
+      base:                             _includes/themes/j1
+      path:                             layouts
+      file:                             content_generator_page.html