j1_template_mde 2018.4.10

data/_includes/themes/j1/procedures/global/select_location.proc

@@ -0,0 +1,107 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #   ~/_includes/themes/j1/procedures/components/select_location.proc
+ #  Liquid PROCEDURE to select|extract a resource location from a locator
+ #  data set
+ #
+ #  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
+ #
+ # -----------------------------------------------------------------------------
+ #   Global procedure. Reads a locator data set and returns the location source
+ #   depending on preferred local|remote source
+ #
+ #    Usage:
+ #      1)  assign the 'color' variable to a color name. If the color (name)
+ #          couldn't be found, the color given with fallback is returned.
+ #      2)  include the select_color.proc procedure
+ #
+ #  Example:
+ #
+ #  {% capture select_location %}themes/{{site.template.name}}/procedures/global/select_location.proc{% endcapture %}
+ #  {% assign my_location   = "remote" %}
+ #  {% assign my_locator    = locator_data_set %}
+ #
+ #  {% include {{select_location}} location=my_location data_set=locator_data_set %}
+ #  {% assign my_location = {{location_source}} %}
+ #
+ #  or
+ #
+ #  {% include {{select_location}} location="local" data_set=locator_data_set %}
+ #  {% assign my_location = {{location_source}} %}
+ #
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  {{ liquid_var | debug }}
+ #  color:  {{ item[0] }}: {{ item[1] }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Variables
+   ------------------------------------------------------------ {% endcomment %}
+
+{% assign location = include.location %}
+{% assign locator  = include.locator %}
+
+
+{% comment %} Liquid procedures
+   ------------------------------------------------------------ {% endcomment %}
+
+
+{% comment %} Main
+   ------------------------------------------------------------ {% endcomment %}
+
+  {% if page.debug %}
+    <!-- [INFO   ] [j1.procedures.select_location.proc ] [location: {{location}}] -->
+    <!-- [INFO   ] [j1.procedures.select_location.proc ] [locator_data_set: {{locator}}] -->
+    <!-- [INFO   ] [j1.procedures.select_location.proc ] [base_path: {{base_path}}] -->
+  {% endif %}
+
+
+  {% for resource in locator %}
+      {% assign key = resource[0] %}
+      {% assign value = resource[1] %}
+      {% if key == 'remote' %} {% assign location_remote  = value %}  {% endif %}
+      {% if key == 'local' %}  {% assign location_local   = value %}  {% endif %}
+  {% endfor %}
+
+  {% case location %}
+
+      {% when 'remote' %}
+      {% comment %} Check location data for REMOTE
+         ------------------------------------------------------ {% endcomment %}
+      {% if location_remote and location_remote != "" %}
+           <!-- [INFO   ] [j1.procedures.select_location.proc ] [preferred location REMOTE detected: {{location_remote}}] -->
+          {% assign location_source = location_remote %}
+      {% elsif location_local and location_local != "" %}
+          <!-- [INFO   ] [j1.procedures.select_location.proc ] [fallback location LOCAL selected: {{location_local}}] -->
+          {% capture location_source %}{{base_path}}/{{location_local}}{% endcapture %}
+      {% else %}
+          <!-- [FATAL  ] [j1.procedures.select_location.proc ] [no valid resource locator for REMOTE found] -->
+          {% assign location_source = "no_valid_resource_locator_for_REMOTE_found" %}
+      {% endif %}
+
+      {% when 'local' %}
+      {% comment %} Check location data for LOCAL
+         ------------------------------------------------------ {% endcomment %}
+      {% if location_local and location_local != "" %}
+         <!-- [INFO   ] [j1.procedures.select_location.proc ] [preferred location LOCAL detected: {{location_local}}] -->
+         {% capture location_source %}{{base_path}}/{{location_local}}{% endcapture %}
+      {% else %}
+          <!-- [FATAL  ] [j1.procedures.select_location.proc ] [no valid resource locator for LOCAL found] -->
+          {% assign location_source = "no_valid_resource_locator_for_LOCAL_found" %}
+      {% endif %}
+
+      {% comment %} NO valid locator detected
+         ------------------------------------------------------ {% endcomment %}
+      {% else %}
+         <!-- [FATAL  ] [j1.procedures.select_location.proc ] [no valid resource locator found] -->
+         {% assign location_source = "no_valid_resource_locator_found" %}
+
+  {% endcase %}
+
+

data/_includes/themes/j1/procedures/global/set_env_entry_document.proc

@@ -0,0 +1,88 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #  ~/_includes/themes/j1/procedures/global/set_env_entry_document.proc
+ #  Liquid PROCEDURE to setup the environment for an (Asciidoc) entry documents
+ #  Initializes the all include paths for folders: images, documents and tables
+ #
+ #  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
+ # -----------------------------------------------------------------------------
+ #   Components procedure. Calculate the HTML code for a given button TYPE
+ #   based on the button_data (hash) (e.g. taken from the panel configuration)
+ #
+ #    Usage:
+ #      1)  capture the 'set_env_entry_document' variable by full path
+ #      2)  include|configure the set_env_entry_document.proc procedure
+ #
+ #    Example:
+ #      {% capture set_env_entry_document %}themes/{{site.template.name}}/procedures/global/set_env_entry_document.proc{%endcapture%}
+ #      {% include {{set_env_entry_document}} init_folders=all %}
+ #
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  liquid_var:  {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+-------------------------------------------------------------------------------- {% endcomment %}
+{% capture get_page_path %}themes/{{site.template.name}}/procedures/global/get_page_path.proc{% endcapture %}
+
+{% comment %} Variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign folders = include.init_folders %}
+
+
+{% comment %} Include directive (include::)
+--------------------------------------------------------------------------------
+// Note: The include directive looks like a >>block macro<< but it is a
+// >>preprocessor directive<< like ifdef and ifeval. It gets processed
+// before the lines are parsed into a document structure.
+//
+// If the path relative, the processor resolves the path using the following
+// rules:
+//
+// If the include directive is used in the main (top-level) document,
+// relative paths are resolved relative to the base directory. (The base
+// directory defaults to the directory of the main document and can be
+// overridden from the CLI or API).
+//
+// If the include directive is used in a file that has >>itself been included<<,
+// the path is resolved relative to the including (i.e. current) file.
+
+// NOTE: Calculation of Pathes
+// Web sources are loaded by the Web Server. The location imagesdir
+// is calculated relative to "web_root". Asciidoc resources are being
+// collected by AsciiDoctor relative to "page_root"
+-------------------------------------------------------------------------------- {% endcomment %}
+
+
+{% comment %} Variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.source.size %} {% assign source_dir = site.source %} {% else %} {% assign source_path = "." %} {% endif %}
+
+{% include {{get_page_path}} %}
+
+{% comment %} dot issue: Woraround - remove "./" from path if site.source = "."
+              TODO: Improve Liquid scripts to manage the "dot issue"
+-------------------------------------------------------------------------------- {% endcomment %}
+{% capture page_root %}{{ page_path | strip | remove_first: './' }}{% endcapture %}
+{% capture web_root %}{{ page_path  source_dir }}{% endcapture %}
+
+:includedir:                            {{page_root}}/000_includes
+:documentsdir:                          {includedir}/documents
+:tabledir:                              {includedir}/tables
+
+{% comment %} Moved imagesdir setting to the document
+--------------------------------------------------------------------------------
+{% if page.collection %}
+  {% assign imagesdir = site.asciidoc_attributes.imagesdir %}
+{% else %}
+  :imagesdir:                             {{web_root}}/000_includes/images
+{% endif %}
+--------------------------------------------------------------------------------
+{% endcomment %}

data/_includes/themes/j1/procedures/global/set_image_block.proc

@@ -0,0 +1,50 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #  ~/_includes/themes/j1/procedures/global/set_image_block.proc
+ #  Liquid PROCEDURE to place an image as an image_block
+ #
+ #  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
+ # -----------------------------------------------------------------------------
+ #   Components procedure. Place an image as an image_block using the the
+ #   default Lightbox "lightbox" to enlarge. The image source folder is
+ #   taken from :imagesdir: Asciidoc attribute.
+ #
+ #    Usage:
+ #      1)  capture the 'set_env_entry_document' variable by full path
+ #      2)  include|configure the set_env_entry_document.proc procedure
+ #
+ #    Example:
+ #      {% capture set_image_block %}themes/{{site.template.name}}/procedures/global/set_image_block.proc{%endcapture%}
+ #      {% include {{set_image_block}} image_name="name.png" image_title="Image title" image_width=800 %}
+ #
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  liquid_var:  {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+--------------------------------------------------------------- {% endcomment %}
+
+{% comment %} Variables
+   ------------------------------------------------------------ {% endcomment %}
+{% assign image_name  = include.image_name %}
+{% assign image_title = include.image_title %}
+{% assign image_width = include.image_width %}
+
+
+[subs=attributes]
+++++
+<div class="imageblock mt-4 mb-4">
+  <div class="title">{{image_title}}</div>
+  <a href="{imagesdir}/{{image_name}}"
+     data-lightbox="{{image_name}}" data-title="{{image_title}}">
+    <img src="{imagesdir}/{{image_name}}" alt="{{image_title}}" width="800">
+  </a>
+</div>
+++++

data/_includes/themes/j1/procedures/global/setup.proc

@@ -0,0 +1,61 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #   ~/_includes/themes/j1/procedures/global/setup.proc
+ #  Liquid PROCEDURE to initialize variables for URLs and Paths dynamically
+ #  used by several Liquid procedures
+ #
+ #  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
+ #
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  liquid_var:  {{ liquid_var | debug }}
+ #
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+
+{% comment %} Variables
+   ------------------------------------------------------------ {% endcomment %}
+
+
+{% comment %} Liquid procedures
+   ------------------------------------------------------------ {% endcomment %}
+
+
+{% comment %} Main
+   ------------------------------------------------------------ {% endcomment %}
+
+  {% if site.template.setup_provider == "custom" %}
+      {% include custom/functions/setup %}
+  {% else %}
+      {% if site.theme.safe and site.data.j1_config.base_path and site.data.j1_config.base_path != '' %}
+          {% assign base_path = site.data.j1_config.base_path %}
+          {% assign home_path = site.data.j1_config.base_path %}
+      {% else %}
+          {% assign base_path = nil %}
+          {% assign home_path = "/" %}
+      {% endif %}
+
+      {% if site.data.j1_config.asset_path %}
+          {% assign asset_path = site.data.j1_config.asset_path %}
+      {% else %}
+          {% capture asset_path %}{{ base_path }}/assets/themes/{{ page.theme.name }}{% endcapture %}
+      {% endif %}
+
+      {% if site.data.j1_config.app_path %}
+          {% assign app_path = site.data.j1_config.app_path %}
+      {% else %}
+          {% capture app_path %}{{ base_path }}/assets/apps{% endcapture %}
+      {% endif %}
+
+      {% if site.data.j1_config.image_path %}
+          {% assign image_path = site.data.j1_config.image_path %}
+      {% else %}
+          {% capture image_path %}{{ base_path }}/assets/images/{{ page.theme.name }}{% endcapture %}
+      {% endif %}
+  {% endif %}

data/_includes/themes/j1/procedures/layouts/content_writer.proc

@@ -0,0 +1,107 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #   ~/_includes/themes/j1/procedures/layouts/content_writer.proc
+ #  Liquid PROCEDURE to load and place the content portion for J1 layouts
+ #
+ #  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
+ #
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  liquid_var:  {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+--------------------------------------------------------------- {% endcomment %}
+{% include themes/{{site.template.name}}/procedures/global/setup.proc %}
+
+{% comment %} Variables
+--------------------------------------------------------------- {% endcomment %}
+{% assign items           = include.items %}
+{% assign placement       = include.region %}
+
+
+{% comment %} Main
+--------------------------------------------------------------- {% endcomment %}
+
+<!-- [INFO   ] [j1.layout.content_writer.proc      ] [start processing: load CONTENT portion for layout: {{page.layout}}] -->
+{% for lane in items %}
+  {% for items in lane %}
+
+    {% for parameters in items %}
+      {% for parameter in parameters %}
+        {% if parameter[0] %}
+          {% assign key   = parameter[0] %}
+          {% assign value = parameter[1] %}
+          {% if key == 'enabled' %}         {% assign enabled = value %}    {% endif %}
+          {% if key == 'region' %}          {% assign region = value %}     {% endif %}
+          {% if key == 'comment' %}         {% assign comment = value %}    {% endif %}
+          {% if key == 'type' %}            {% assign type = value %}       {% endif %}
+          {% if key == 'base' %}            {% assign base = value %}       {% endif %}
+          {% if key == 'path' %}            {% assign path = value %}       {% endif %}
+          {% if key == 'file' %}            {% assign file = value %}       {% endif %}
+          {% if key == 'id' %}              {% assign id = value %}         {% endif %}
+          {% if key == 'helper_classes' %}  {% assign class = value %}      {% endif %}
+          {% if key == 'data' %}            {% assign data = value %}       {% endif %}
+        {% endif %}
+      {% endfor %}
+    {% endfor %}
+
+    {% comment %}  Skip all regions should NOT placed
+    --------------------------------------------------------- {% endcomment %}
+    {% unless region == placement %} {% continue %} {% endunless %}
+
+
+    {% comment %}  Skip all lanes DISABLED
+    --------------------------------------------------------- {% endcomment %}
+    {% if enabled %}
+
+      {% assign base = base | remove_first: '_includes/' %}
+
+      {% comment %} Process all REGIONS for the given layout
+      ------------------------------------------------------- {% endcomment %}
+        {% case region %}
+
+          {% comment %} Collect the BODY-MAIN region
+          --------------------------------------------------- {% endcomment %}
+          {% when 'body-main' %}
+
+            {% if placement == 'body-main' %}
+              <!-- [INFO   ] [j1.layout.content_writer.proc      ] [load region 'body-main' for layout: {{page.layout}}] -->
+              {% if type == 'async' %}
+                <div id="{{ id }}" class="{{ class }}"></div>
+              {% elsif type == 'sync' %}
+                {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
+                {% include {{ path }} %}
+              {% endif %}
+            {% endif %}  {% comment %} END placement {% endcomment %}
+
+          {% comment %} Collect the BODY-FOOTER region
+          --------------------------------------------------- {% endcomment %}
+          {% when 'body-footer' %}
+
+            {% if placement == 'body-footer' %}
+              <!-- [INFO   ] [j1.layout.content_writer.proc   ] [load region body-footer for layout: {{page.layout}} ] -->
+              {% if type == 'async' %}
+                <div id="{{ id }}" class="{{ class }}"></div>
+              {% elsif type == 'sync' %}
+                {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
+                {% include {{ path }} region='body-footer' %}
+              {% endif %}
+            {% endif %} {% comment %} END if placement {% endcomment %}
+
+        {% endcase %}
+
+    {% endif %} {% comment %} END if (lane) enabled {% endcomment %}
+
+  {% endfor %}
+{% endfor %}
+<!-- [INFO   ] [j1.layout.content_writer.proc      ] [end processing] -->
+
+{% assign items = nil %}

data/_includes/themes/j1/procedures/layouts/default_writer.proc

@@ -0,0 +1,160 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #  ~/_includes/themes/j1/procedures/layouts/default_writer.proc
+ #  Liquid PROCEDURE to write|place the HTML markup for the layout DEFAULT
+ #
+ #  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
+ #
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  liquid_var:  {{ liquid_var | debug }}
+ #
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+--------------------------------------------------------------- {% endcomment %}
+{% include themes/{{site.template.name}}/procedures/global/setup.proc %}
+
+{% comment %} Variables
+--------------------------------------------------------------- {% endcomment %}
+{% assign placement   = include.region %}
+{% assign items       = include.items %}
+
+
+{% comment %} Main
+--------------------------------------------------------------- {% endcomment %}
+
+{% for lanes in items %}
+  {% for lane in lanes %}
+
+    {% for parameters in lane %}
+      {% for parameter in parameters %}
+        {% assign data_type = parameter | is_type %}
+        {% if data_type == 'array' %}
+          {% assign key = parameter[0] %}
+          {% assign value = parameter[1] %}
+          {% if key == 'enabled' %}     {% assign enabled = value %}    {% endif %}
+          {% if key == 'region' %}      {% assign region = value %}     {% endif %}
+          {% if key == 'type' %}        {% assign type = value %}       {% endif %}
+          {% if key == 'base' %}        {% assign base = value %}       {% endif %}
+          {% if key == 'path' %}        {% assign path = value %}       {% endif %}
+          {% if key == 'file' %}        {% assign file = value %}       {% endif %}
+          {% if key == 'id' %}          {% assign id = value %}         {% endif %}
+          {% if key == 'class' %}       {% assign class = value %}      {% endif %}
+          {% if key == 'data' %}        {% assign data = value %}       {% endif %}
+        {% endif %}
+      {% endfor %}
+    {% endfor %}
+
+
+    {% comment %}  Skip all regions should NOT placed
+    ----------------------------------------------------------- {% endcomment %}
+    {% unless region == placement %} {% continue %} {% endunless %}
+
+    {% comment %}  Skip all lanes DISABLED
+    ----------------------------------------------------------- {% endcomment %}
+    {% if enabled %}
+
+    {% comment %} Process all REGIONS for the given layout
+    ----------------------------------------------------------- {% endcomment %}
+       {% assign base = base | remove_first: '_includes/' %}
+
+    {% case region %}
+
+      {% comment %} Collect the HEAD region
+      --------------------------------------------------------- {% endcomment %}
+      {% when 'head' %}
+        {% if placement == 'head' %}
+          <!-- [INFO   ] [j1.layout.default_writer.proc    ] [start processing: load region head, layout: {{page.layout}} ] -->
+
+          {% if type == 'async' %}
+            <div id="{{ id }}" class="{{ class }}"></div>
+          {% elsif type == 'sync' %}
+            {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
+            {% include {{ path }} region='head' %}
+          {% endif %}
+        {% endif %} {% comment %} END placement {% endcomment %}
+
+      {% comment %} Collect the BODY-NAVIGATION region
+      --------------------------------------------------------- {% endcomment %}
+      {% when 'body-navigation' %}
+        {% if placement == 'body-navigation' %}
+          <!-- [INFO   ] [j1.layout.default_writer.proc    ] [start processing: load region body-navigation, layout: {{page.layout}} ] -->
+
+          {% if type == 'async' %}
+            <div id="{{ id }}" class="{{ class }}"></div>
+          {% elsif type == 'sync' %}
+            {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
+            {% include {{ path }} region='body-navigation' %}
+          {% endif %}
+        {% endif %}
+
+      {% comment %} Collect the BODY-HEADER region
+      --------------------------------------------------------- {% endcomment %}
+      {% when 'body-header' %}
+        {% if placement == 'body-header' %}
+          <!-- [INFO   ] [j1.layout.default_writer.proc    ] [start processing: load region body-header, layout: {{page.layout}} ] -->
+          <!-- [INFO   ] [j1.layout.default_writer.proc    ] [load page specific header data from yaml data file ] -->
+
+          {% if type == 'async' %}
+            <div id="{{ id }}" class="{{ class }}"></div>
+          {% elsif type == 'sync' %}
+            {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
+            {% include {{ path }} region='body-header' %}
+          {% endif %}
+        {% endif %} {% comment %} END if placement {% endcomment %}
+
+      {% comment %} Collect the BODY-FOOTER region
+      --------------------------------------------------------- {% endcomment %}
+      {% when 'body-footer' %}
+        {% if placement == 'body-footer' %}
+          <!-- [INFO   ] [j1.layout.default_writer.proc    ] [start processing: load region body-footer, layout: {{page.layout}} ] -->
+
+          {% if type == 'async' %}
+            <div id="{{ id }}" class="{{ class }}"></div>
+          {% elsif type == 'sync' %}
+            {% capture path %}{{base}}/{{path}}/{{file}}{% endcapture %}
+            {% include {{ path }} region='body-footer' %}
+          {% endif %}
+        {% endif %} {% comment %} END if placement {% endcomment %}
+
+      {% else %}
+          {% comment %} Exception: Unknown region
+          ----------------------------------------------------- {% endcomment %}
+          <div class="row mb-5">
+            <div class="col-md-6 col-md-offset-1">
+              <div class="card raised-z10 mt-5">
+                <div class="content content-danger">
+                  <h4 class="notoc">
+                    <i class="zmdi zmdi-alert-triangle zmdi-hc-3x pl-3"></i>
+                    Region <i>{{region}}</i> not allowed
+                  </h4>
+                  <h4 class="notoc card-title">Check your configuration</h4>
+                  <div class="card-description">
+                    Don't worry about this. May you've a typo in the LAYOUT
+                    configuration of this page ({{page.title}}). Check the
+                    (page) layout config file for the unsupported region. A
+                    line contains something wrong like:
+                    <br /><br /> <i>region: {{region}}</i><br /><br />
+                    Have a look at:
+                  </div>
+                  <div class="mb-5">
+                    <h5 class="notoc">_data/layout/[layout_name].yml</h5>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+
+      {% endcase %}
+    {% endif %} {% comment %} END if (lane) enabled {% endcomment %}
+
+  {% endfor %}
+{% endfor %}