j1-template 2021.0.4 → 2021.0.9

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/200_chapter.asciidoc

@@ -0,0 +1,5 @@
+// ~/document_base_folder/_includes/documents
+// Sublevel Entry Document: 200_chapter.asciidoc
+// -----------------------------------------------------------------------------
+
+include::200_chapter/200_chapter_document.asciidoc[]

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/200_chapter/200_chapter_document.asciidoc

@@ -0,0 +1,53 @@
+// ~/document_base_folder/_includes/documents/200_chapter/
+// Chapter document: 200_chapter_document.asciidoc
+// -----------------------------------------------------------------------------
+
+== Chapter 2
+
+A Lightbox, in general, is a helper which displays enlarged, almost
+screen-filling versions of pictures (or videos), while dimming the rest of the
+page. The technique, introduced by Lightbox V2, gained widespread popularity
+due to its simple and elegant style. The term lightbox is used since then for
+Javascript libraries to support such functionality.
+
+For J1 Template, two different lightboxes can be used:
+
+* Lightbox V2 (lightbox)
+* LightGallery
+
+The default lightbox used by J1 Template is Lightbox V2, a Javascript library
+written by _Lokesh Dhakar_. The name of that (build-in) is simply: lightbox.
+For more complex use cases, like a thumbnail gallery preview or video support,
+LightGallery can be used alternatively.
+
+NOTE: The name LightGallery implies a sort of a Gallery, but the library is a
+_lightbox_. And, LightGallery provides much more functionality on image-based
+data rather than enlarged displaying of images. See the examples below to check
+for the differences in comparison to the simpler Lightbox V2 lightbox.
+
+Both lightboxes are fully integrated to be used as standalone modules or to be
+used as helpers _under-the-hood_ by other apps or modules focussing on
+image-data like gallery or carousel, the build-in carousel module.
+
+=== Section
+
+Find below an example of using the lightbox Lightbox standalone. See how
+single (individual) images are linked for the use with Lightbox.
+
+.Lightbox block for standalone images
+lightbox::example-standalone[ 400, {data-images-standalone} ]
+
+For a group of images (image sets), Lightbox support image groups. Click
+on the images below to see how Lightbox manage image groups.
+
+.Lightbox block for grouped images
+lightbox::example-group[ 400, {data-images-group}, group ]
+
+==== Subsection
+
+LightGallery provides more complex functions on image data. The lightbox
+supports a gallery-style thumbnail preview plus image resizing, a dowload
+dialogue, sharing provider support and some more helpful. Check what
+LightGallery can do by the following example.
+
+gallery::jg_example[]

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/900_references.asciidoc

@@ -0,0 +1,23 @@
+// ~/document_base_folder/_includes/documents
+// Sublevel Entry Document: 900_sources.asciidoc
+// -----------------------------------------------------------------------------
+
+== References
+
+This section lists all references and sources used in all chapters of this
+document. The sections <<Articles>>, <<HowTos>> or <<Blogs and Platforms>>
+may give additional information for further reading.
+
+Some documents are using symbols. Find an explanation in section <<legend>>.
+
+
+// Include references by chapters
+// -----------------------------------------------------------------------------
+
+include::900_references/000_intro.asciidoc[]
+
+include::900_references/100_chapter_document.asciidoc[]
+
+include::900_references/200_chapter_document.asciidoc[]
+
+include::900_references/900_sources.asciidoc[]

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/900_references/000_intro.asciidoc

@@ -0,0 +1,23 @@
+// ~/document_base_folder/_includes/documents/900_sources/
+// Chapter document: 100_chapter_document.asciidoc
+// -----------------------------------------------------------------------------
+
+// URIs may moved to ~/000_includes/attributes.asciidoc
+// -----------------------------------------------------------------------------
+:url-wikipedia--introduction:           https://en.wikipedia.org/wiki/Introduction_(writing)
+
+=== Introduction
+
+.References - Introduction
+[cols="3,^.>5a,^1,^1,^1,^1", subs=+macros, options="header", role="rtable mt-3 mb-5"]
+|===============================================================================
+|Author |Title |Year |Level |Cite |Source
+
+|Wikipedia
+|{url-wikipedia--introduction}[Introduction (writing), {browser-window--new}]
+|na
+|{level--beginner}
+|{icon-checked}
+|{icon-checked}
+
+|===============================================================================

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/900_references/100_chapter_document.asciidoc

@@ -0,0 +1,33 @@
+// ~/document_base_folder/_includes/documents/900_sources/
+// Chapter document: 100_chapter_document.asciidoc
+// -----------------------------------------------------------------------------
+
+=== Chapter 1
+
+.References - Chapter 1
+[cols="3,^.>5a,^1,^1,^1,^1", subs=+macros, options="header", role="rtable mt-3 mb-5"]
+|===============================================================================
+|Author |Title |Year |Level |Cite |Source
+
+|Austin Andrews
+|{url-mdi--home}[Material Design Icons, {browser-window--new}]
+|2021
+|{level--advanced}
+|{icon-checked}
+|{icon-times}
+
+|Fonticons, Inc.
+|{url-fontawesome--home}[FontAwesome Icons V5, {browser-window--new}]
+|2021
+|{level--advanced}
+|{icon-checked}
+|{icon-times}
+
+|Iconify OÜ
+|{url-iconify--home}[Iconify Icons, {browser-window--new}]
+|2021
+|{level--advanced}
+|{icon-checked}
+|{icon-times}
+
+|===============================================================================

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/900_references/200_chapter_document.asciidoc

@@ -0,0 +1,26 @@
+// ~/document_base_folder/_includes/documents/900_sources/
+// Chapter document: 200_chapter_document.asciidoc
+// -----------------------------------------------------------------------------
+
+=== Chapter 2
+
+.References - Chapter 2
+[cols="3,^.>5a,^1,^1,^1,^1", subs=+macros, options="header", role="rtable mt-3 mb-5"]
+|===============================================================================
+|Author |Title |Year |Level |Cite |Source
+
+|Sachin N
+|{url-lightbox-v2--home}[LightGallery, {browser-window--new}]
+|2021
+|{level--advanced}
+|{icon-checked}
+|{icon-times}
+
+|Lokesh Dhakar
+|{url-light-gallery--home}[Lightbox V2, {browser-window--new}]
+|2021
+|{level--advanced}
+|{icon-checked}
+|{icon-times}
+
+|===============================================================================

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/900_references/900_sources.asciidoc

@@ -0,0 +1,81 @@
+// ~/document_base_folder/_includes/documents/900_sources/
+// Chapter document: 900_sources.asciidoc
+// -----------------------------------------------------------------------------
+
+=== Legend
+
+Find with the following the explanation on all symbols used.
+
+==== Levels
+
+Level of experience required to read and understand what is presented.
+
+* {level--beginner} beginner
+* {level--intermediate} intermediate
+* {level--advanced} advanced
+* {level--expert} expert
+
+==== Usage
+
+The following symbols indicate, if sth. was used or *not* used.
+
+* {icon-checked} used
+* {icon-times} unused
+
+=== Sources of Information
+
+Find with this section all references and sources used. Sections <<Articles>>,
+<<HowTos>> or <<Blogs and Platforms>> may give additional information for
+further reading.
+
+
+==== Articles
+
+.Sources - Articles
+[cols="3,^.>5a,^1,^1,^1,^1", options="header", width="100%", role="rtable"]
+|===============================================================================
+|Author |Title |Year |Level |Cite |Source
+
+|Wikipedia
+|{url-wikipedia-en--asciidoc}[Asciidoc, {browser-window--new}]
+|na
+|{level--beginner}
+|{icon-times}
+|{icon-times}
+
+|===============================================================================
+
+
+==== HowTos
+
+.Sources - HowTos
+[cols="3,^.>5a,^1,^1,^1,^1", options="header", width="100%", role="rtable mt-3"]
+|===============================================================================
+|Author |Title |Year |Level |Cite |Source
+
+|asciidoctor.org
+|{url-asciidoctor--asciidoc-writers-guide}[AsciiDoc Writer’s Guide, {browser-window--new}]
+|na
+|{level--intermediate}
+|{icon-times}
+|{icon-times}
+
+
+|===============================================================================
+
+
+==== Blogs and Platforms
+
+.Sources - Blogs and Platforms
+[cols="3,^.>5a,^1,^1,^1,^1", options="header", width="100%", role="rtable mt-3"]
+|===============================================================================
+|Author |Title |Year |Level |Cite |Source
+
+|asciidoctor.org
+|{url-asciidoctor--asciidoc-manual}[AsciiDoc Manual, {browser-window--new}]
+|2021
+|{level--advanced}
+|{icon-checked}
+|{icon-times}
+
+|===============================================================================

data/lib/starter_web/pages/public/asciidoc_skeletons/book/_includes/documents/tables/110_material_design_icons.asciidoc

@@ -0,0 +1,102 @@
+// ~/document_base_folder/_includes/documents/tables
+// Table document: 110_material_design_icons.asciidoc
+// -----------------------------------------------------------------------------
+
+.Material Design Icons
+[cols="2a,3a,4a,^", options="header", width="100%", role="rtable mt-3"]
+|===============================================================================
+|Size |Modifier |Markup |Render
+
+|1x
+|no modifier set
+|All `icon_name` can be found on the Preview page for MDI Icon Previewer +
+[source, adoc, role="noclip"]
+----
+mdi:account[1x]
+----
+|mdi:account[1x]
+
+|3x
+|no modifier set
+|All `icon_name` can be found on the Preview page for MDI Icon Previewer +
+[source, adoc, role="noclip"]
+----
+mdi:account[3x]
+----
+|mdi:account[3x]
+
+|5x
+|no modifier set
+|All `icon_name` can be found on the Preview page for MDI Icon Previewer
+[source, adoc, role="noclip"]
+----
+mdi:account[5x]
+----
+|mdi:account[5x]
+
+|5x
+|`mdi-rotate-45`
+|Rotate 45 degrees
+[source, adoc, role="noclip"]
+----
+mdi:account[5x mdi-rotate-45]
+----
+|mdi:account[5x mdi-rotate-45]
+
+|5x
+|`mdi-rotate-315`
+|Rotate 315 degrees
+[source, adoc, role="noclip"]
+----
+mdi:account[5x mdi-rotate-315]
+----
+|mdi:account[5x mdi-rotate-315]
+
+|5x
+|`mdi-light` +
+`mdi-flip-v`
+|Colour set to MDI Light (Grey) and flipped vertical
+[source, adoc, role="noclip"]
+----
+mdi:alert[5x mdi-light mdi-flip-v]
+----
+|mdi:alert[5x mdi-light mdi-flip-v]
+
+|5x
+|`md-indigo`
+|Colour set to MDI Indigo
+[source, adoc, role="noclip"]
+----
+mdi:alert[5x md-indigo]
+----
+|mdi:account[5x md-indigo]
+
+|5x
+|`md-pink`
+|Colour set to MDI Pink
+[source, adoc, role="noclip"]
+----
+mdi:alert[5x md-pink]
+----
+|mdi:account[5x md-pink]
+
+|5x
+|`mdi-spin`
+|Added animation of type Rotate (Spin)
+[source, adoc, role="noclip"]
+----
+mdi:loading[5x mdi-spin]
+----
+|mdi:loading[5x mdi-spin]
+
+|5x
+|`md-red-900` +
+`mdi-pulsed`
+|Colour  set to MDI Dark Red and added animation of type Pulsed
+[source, adoc, role="noclip"]
+----
+mdi:heart[5x md-red-900 mdi-pulsed]
+----
+|mdi:heart[5x md-red-900 mdi-pulsed]
+
+|===============================================================================

data/lib/starter_web/pages/public/asciidoc_skeletons/book/a2p.bat

@@ -0,0 +1,28 @@
+@ECHO OFF
+REM  ---------------------------------------------------------------------------
+REM  Product/Info:
+REM  http://jekyll-one
+REM
+REM  Copyright (C) 2021 Juergen Adams
+REM  J1 is licensed under the MIT License
+REM  ---------------------------------------------------------------------------
+
+REM ENVIRONMENT
+REM set BASE_PATH=<absolute_path_jekyll_project>
+REM ----------------------------------------------------------------------------
+SET BASE_PATH=D:\j1\github\j1-template\packages\400_template_site
+
+REM VARIABLES
+REM ----------------------------------------------------------------------------
+
+REM SET PDF_STYLES_DIR=%BASE_PATH%\_data\asciidoc2pdf
+REM SET PDF_FONTS_DIR=%BASE_PATH%\_data\asciidoc2pdf\fonts
+
+SET PLUGINS_DIR=%BASE_PATH%\_plugins
+SET PLUGIN_LOREM_INLINE=%PLUGINS_DIR%\lorem_inline.rb
+SET MASTER_DOCUMENT=.\book.a2p
+
+
+REM MAIN
+REM ----------------------------------------------------------------------------
+asciidoctor-pdf -r %PLUGIN_LOREM_INLINE% %MASTER_DOCUMENT%

data/lib/starter_web/pages/public/asciidoc_skeletons/book/a2p.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+#  -----------------------------------------------------------------------------
+# Product/Info:
+# http://jekyll-one
+#
+# Copyright (C) 2021 Juergen Adams
+# J1 is licensed under the MIT License
+#  -----------------------------------------------------------------------------
+
+# ENVIRONMENT
+# set BASE_PATH=_absolute_path_jekyll_project
+# ------------------------------------------------------------------------------
+BASE_PATH=/D/j1/github/j1-template/packages/400_template_site
+
+# VARIABLES
+# ------------------------------------------------------------------------------
+PDF_STYLES_DIR=$BASE_PATH/_data/asciidoc2pdf
+PDF_FONTS_DIR=$BASE_PATH_data/_data/asciidoc2pdf\fonts
+PLUGINS_DIR=$BASE_PATH/_plugins
+PLUGIN_TWITTER_EMOJI=$PLUGINS_DIR/asciidoctor-extensions/twitter-emoji-inline.rb
+PLUGIN_LOREM_INLINE=$PLUGINS_DIR/lorem_inline.rb
+MASTER_DOCUMENT=./book.a2p
+
+# MAIN
+# ------------------------------------------------------------------------------
+asciidoctor-pdf -r $PLUGIN_LOREM_INLINE -r $PLUGIN_TWITTER_EMOJI $MASTER_DOCUMENT

data/lib/starter_web/pages/public/asciidoc_skeletons/book/book.a2p

@@ -0,0 +1,114 @@
+// -----------------------------------------------------------------------------
+// ~/document_base_folder:              book
+// Master Document PDF conversion:      book.a2p
+//
+// Product/Info:
+// https://jekyll.one
+//
+// Copyright (C) 2021 Juergen Adams
+//
+// J1 Template is licensed under the MIT License.
+// For details, see https://jekyll.one
+// -----------------------------------------------------------------------------
+
+// Set global page attributes
+// -----------------------------------------------------------------------------
+:doctype:                               book
+:source-highlighter:                    rouge
+:icons:                                 font
+:toc-enabled:
+//:index-enabled:
+
+// Set global resource folders
+// -----------------------------------------------------------------------------
+:imagesdir:                             ../../../../assets/images/
+:pdf-themesdir:                         ../../../../_data/asciidoc2pdf/themes
+:pdf-fontsdir:                          ../../../../_data/asciidoc2pdf/fonts
+//:pdf-stylesdir:                       ../../../../_data/asciidoc2pdf/styles
+
+// Initialize entry document environmental attributes
+// -----------------------------------------------------------------------------
+:global_includedir:                     ../../../../_includes
+:includedir:                            _includes
+:documentdir:                           {includedir}/documents
+:tabledir:                              {includedir}/tables
+
+// Load tag, url and data attributes
+// -----------------------------------------------------------------------------
+include::{global_includedir}/attributes.asciidoc[tag=tags]
+include::{global_includedir}/attributes.asciidoc[tag=urls]
+include::{global_includedir}/attributes.asciidoc[tag=data]
+
+include::{includedir}/attributes.asciidoc[tag=tags]
+include::{includedir}/attributes.asciidoc[tag=urls]
+include::{includedir}/attributes.asciidoc[tag=data]
+
+// Set local page attributes
+// -----------------------------------------------------------------------------
+:allow-uri-read:
+:pdf-theme:                             j1
+
+// MAIN
+// =============================================================================
+
+// Document Header
+// -----------------------------------------------------------------------------
+= Asciidoc Book Skeleton
+
+ifdef::toc-enabled[]
+:toc:                                   left
+:toclevels:                             4
+endif::[]
+
+
+// Page content
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.Preface
+
+[.lead]
+The *Asciidoc Document Skeleton* a helper for setting up a base file and
+folder structure for *multi-chapter* AsciiDoc projects based on _Jekyll_
+and _J1 Template_. You need *both* to use this skeleton to create AsciiDoc
+documents from it.
+
+NOTE: The Asciidoc Document Skeleton is fully *relocateable* and can be
+placed in any subfolder of your Jekyll site.
+
+The skeleton can be used to create HTML output (backend *html5*) and PDF
+output (backend *pdf*) as well. _J1 Template_ comes with the full support
+of _Asciidoctor PDF_, a Ruby-based implementation for _Asciidoctor_ based on
+the PDF converter _Prawn_.
+
+*Happy Jekylling!*
+
+
+// Include sub-documents
+// -----------------------------------------------------------------------------
+
+// Include Introduction
+// -----------------------------------------------------------------------------
+
+include::{documentdir}/000_intro.asciidoc[]
+
+
+// Include Sublevel Entry Documents
+// -----------------------------------------------------------------------------
+
+include::{documentdir}/100_chapter.asciidoc[]
+
+include::{documentdir}/200_chapter.asciidoc[]
+
+
+// Document References
+// -----------------------------------------------------------------------------
+
+include::{documentdir}/900_references.asciidoc[]
+
+
+// Document Index
+// -----------------------------------------------------------------------------
+ifdef::index-enabled[]
+[index]
+= Index
+endif::[]