j1-template 2022.5.1 → 2022.5.3

data/lib/j1/commands/patch.rb

@@ -8,7 +8,7 @@ module J1
 
         def init_with_program(prog)
           prog.command(:patch) do |c|
-            c.description 'Install patches available for J1 projects'
+            c.description 'Install patches available for a J1 Project'
             c.syntax 'patch'
             c.option 'force', '--force',                'Force to install patches even already exists'
             c.option 'system', '--system',              'Install patches on the Ruby SYSTEM gem folder'

data/lib/j1/commands/rebuild.rb

@@ -8,7 +8,7 @@ module J1
 
         def init_with_program(prog)
           prog.command(:rebuild) do |c|
-            c.description 'Rebuild the J1 projects website'
+            c.description 'Rebuild a J1 Project'
             c.syntax 'rebuild'
             c.action do |args, options|
               J1::Commands::Rebuild.process(args, options)

data/lib/j1/commands/reset.rb

@@ -8,7 +8,7 @@ module J1
 
         def init_with_program(prog)
           prog.command(:reset) do |c|
-            c.description 'Reset a J1 project to factory state'
+            c.description 'Reset a J1 Project to factory state'
             c.syntax 'reset'
             c.action do |args, options|
               J1::Commands::Reset.process(args, options)

data/lib/j1/commands/setup.rb

@@ -9,7 +9,7 @@ module J1
 
         def init_with_program(prog)
           prog.command(:setup) do |c|
-            c.description 'Initialize a J1 project for first use'
+            c.description 'Initialize a J1 Project for first use'
             c.syntax 'setup'
             c.option 'force', '--force',                ' Force to install patches even already exists'
             c.option 'system', '--system',              ' Install patches on the Ruby SYSTEM gem folder'

data/lib/j1/commands/site.rb

@@ -8,7 +8,7 @@ module J1
 
         def init_with_program(prog)
           prog.command(:site) do |c|
-            c.description 'Run the website of a J1 project'
+            c.description 'Run the site of a J1 Project'
             c.syntax 'site'
             c.action do |args, options|
               J1::Commands::Site.process(args, options)

data/lib/j1/version.rb

@@ -1,3 +1,3 @@
 module J1
-  VERSION = '2022.5.1'
+  VERSION = '2022.5.3'
 end

data/lib/j1_app.rb

@@ -31,7 +31,7 @@ require 'log4r'
 # require 'log4r/yamlconfigurator'
 require_relative 'j1_app/log4r/yamlconfigurator'
 require 'log4r/outputter/datefileoutputter'
-require 'log4r/outputter/emailoutputter'
+# require 'log4r/outputter/emailoutputter'
 include Log4r
 
 # Require local Rubies

data/lib/starter_web/Gemfile

@@ -70,7 +70,7 @@ end
 # ------------------------------------------------------------------------------
 # Specify the THEME GEM used for the project
 #
-gem 'j1-template', '~> 2022.5.1'
+gem 'j1-template', '~> 2022.5.0'
 
 # ------------------------------------------------------------------------------
 # PRODUCTION: Gem needed for the Jekyll and J1 prod environment
@@ -131,22 +131,23 @@ end
 group :jekyll_plugins do
   # Base Jekyll Plugins (required)
   #
-  gem 'asciidoctor', '~> 2.0'
-  gem 'jekyll-asciidoc', '>= 3.0.0'
-  gem 'j1-paginator', '>= 2021.1.1'
+  gem 'asciidoctor',      '~> 2.0'
+  gem 'jekyll-asciidoc',  '>= 3.0.0'
+  gem 'j1-paginator',     '>= 2021.1.1'
   #
   # Additional Supporting GEMs (optional)
   #
-  # gem 'algolia', '~> 2.0', '>= 2.0.4'                                         # Required for Algolia support only
-  # gem 'asciidoctor-pdf', '>= 1.5.4'                                           # Required for Asciidoctor PDF creation only
-  # gem 'jekyll-sass-converter', '>= 2.1.0'                                     # Required for Jekyll|SASS (file) conversion support
+  # gem 'algolia',                '~> 2.0', '>= 2.0.4'                          # Required for Algolia support only
+  # gem 'asciidoctor-pdf',        '>= 1.5.4'                                    # Required for Asciidoctor PDF creation only
+  # gem 'jekyll-sass-converter',  '>= 2.1.0'                                    # Required for Jekyll|SASS (file) conversion support
   #
-  # Additional Jekyll Plugins  (optional)
+  # Additional Jekyll Plugins (optional)
   #
-  gem 'jekyll-sitemap', '>= 1.2.0'                                              # Create XML sitemap (recommended)
-  # gem 'jekyll-feed', ">= 0.15.1"
-  # gem 'jekyll-gist', '>= 1.5.0'
-  # gem 'jekyll-redirect-from', '>= 0.16.0'
+  # gem 'jekyll-gist', '>= 1.5.0'                                               # Enables the Liquid tag '{% gist %}' to display GitHub Gists in posts and pages
+  # gem 'jekyll-redirect-from', '>= 0.16.0'                                     # Specify multiple URLs for a post or page, such that the alternative URLs redirect to different site URL
+  gem 'jekyll-feed',    '>= 0.16.0'                                             # Generate a Atom (RSS-like) feed XML file for all posts
+  gem 'jekyll-seo-tag', '>= 2.1'                                                # Add (Open Graph) metadata tags for search engines and social networks like focebook or twitter
+  gem 'jekyll-sitemap', '>= 1.2.0'                                              # Create a XML sitemap file (recommended)
 end
 
 # ------------------------------------------------------------------------------

data/lib/starter_web/README.md

@@ -380,7 +380,7 @@ This command creates a **initial** project in folder **my-starter**.
   2022-07-30 18:12:12 - GENERATE: Resolving dependencies...
   2022-07-30 18:12:12 - GENERATE: Using bundler 2.3.7
   ...
-  2022-07-30 18:12:12 - GENERATE: Using j1-template 2022.5.1.rc2
+  2022-07-30 18:12:12 - GENERATE: Using j1-template 2022.5.3.rc2
   2022-07-30 18:12:12 - GENERATE: Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
   2022-07-30 18:12:12 - GENERATE: Bundled gems are installed into `../../.gem`
   2022-07-30 18:12:12 - GENERATE:  C:/Users/xxx/.gem/ruby/3.1.0;C:/DevTools/Ruby31-x64/lib/ruby/gems/3.1.0;
@@ -416,7 +416,7 @@ commands are available as well.
   2022-07-30 18:17:48 - SETUP: Initialize the project ...
   2022-07-30 18:17:48 - SETUP: Be patient, this will take a while ...
   2022-07-30 18:17:49 - SETUP:
-  2022-07-30 18:17:49 - SETUP: > j1@2022.5.1 setup C:\Users\xxx\j1-projects\my-starter
+  2022-07-30 18:17:49 - SETUP: > j1@2022.5.3 setup C:\Users\xxx\j1-projects\my-starter
   2022-07-30 18:17:49 - SETUP: > npm --silent run setup-start && npm --silent run setup-base && run-s -s setup:*
   2022-07-30 18:17:49 - SETUP:
   2022-07-30 18:17:50 - SETUP: Setup project for first use ..
@@ -461,7 +461,7 @@ browser. Let's start the journey ...
   Check setup state of the J1 project ...
   2022-07-30 18:26:18 - SITE: Starting up your site ...
   2022-07-30 18:26:18 - SITE:
-  2022-07-30 18:26:18 - SITE: > j1@2022.5.1 j1-site C:\Users\jadams\j1-projects\my-starter
+  2022-07-30 18:26:18 - SITE: > j1@2022.5.3 j1-site C:\Users\jadams\j1-projects\my-starter
   2022-07-30 18:26:18 - SITE: > run-p -s j1-site:*
   2022-07-30 18:26:18 - SITE:
   2022-07-30 18:26:20 - SITE: Startup UTILSRV ..
@@ -500,7 +500,7 @@ Check setup state of the J1 project ...
 REBUILD: Rebuild the projects website ...
 REBUILD: Be patient, this will take a while ...
 2022-07-30 18:45:09 - REBUILD:
-2022-07-30 18:45:09 - REBUILD: > j1@2022.5.1 rebuild C:\Users\xxx\j1-projects\my-starter
+2022-07-30 18:45:09 - REBUILD: > j1@2022.5.3 rebuild C:\Users\xxx\j1-projects\my-starter
 2022-07-30 18:45:09 - REBUILD: > run-s -s rebuild:* && run-s -s post-rebuild:*
 2022-07-30 18:45:09 - REBUILD:
 2022-07-30 18:45:10 - REBUILD: Rebuild site incremental ..
@@ -548,7 +548,7 @@ using Lerna for all packages:
   2022-07-30 18:29:07 - RESET: Reset the project to factory state ...
   2022-07-30 18:29:07 - RESET: Be patient, this will take a while ...
   2022-07-30 18:29:08 - RESET:
-  2022-07-30 18:29:08 - RESET: > j1@2022.5.1 reset C:\Users\xxx\j1-projects\my-starter
+  2022-07-30 18:29:08 - RESET: > j1@2022.5.3 reset C:\Users\xxx\j1-projects\my-starter
   2022-07-30 18:29:08 - RESET: > run-s -s reset:*
   2022-07-30 18:29:08 - RESET:
   2022-07-30 18:29:08 - RESET: Reset project to factory state ..

data/lib/starter_web/_config.yml

@@ -10,8 +10,6 @@
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
 # ------------------------------------------------------------------------------
-# WARNING: This configuration can only be used for Ruby V3
-# ------------------------------------------------------------------------------
 
 # ==============================================================================
 # 1. BUILD configuration
@@ -55,7 +53,7 @@ environment:                            development
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2022.5.1
+version:                                2022.5.3
 
 # version
 # ------------------------------------------------------------------------------
@@ -162,86 +160,55 @@ doctype:                                html
 
 # ------------------------------------------------------------------------------
 # META data
-# Mainly to set the meta tags for the document <head> section.
-
-# title
+# Mainly to set (global)) meta tags for the document <head> section.
 # ------------------------------------------------------------------------------
-#   Sets the ...
 #
-#   values:                             string
-#   default:                            no default
-#
-# slogan
+# title
 # ------------------------------------------------------------------------------
-#   Sets the <title> tag within the <head> section.
+# Sets the <title> tag within the <head> section for SEO Tag optimization
 #
 #   values:                             string
 #   default:                            no default
 #
-# description
+# slogan
 # ------------------------------------------------------------------------------
-#   Sets the meta tag for "description"
+# Sets slogan data used for SEO Tag optimization
 #
 #   values:                             string
 #   default:                            no default
 #
-# keywords
-# ------------------------------------------------------------------------------
-#   Sets the meta tag for "keywords"
-#
-#   values:                             string (comma separated)
-#   default:                            no default
-#
 # author.name
 # ------------------------------------------------------------------------------
-#   Sets the meta tag for "author"
+# Sets the meta tag for "author"
 #
 #   values:                             string (comma separated)
 #   default:                            no default
 #
 # robots.index
 # ------------------------------------------------------------------------------
-#   Controls spider|robots of search engines. Sets the meta
-#   tag for "robots". If set to "false", the meta tag robots
-#   is set to "noindex", if set to "true" the tag is set to
-#   "index"
+# Controls spider|robots of search engines. Sets the meta
+# tag for "robots". If set to "false", the meta tag robots
+# is set to "noindex", if set to "true" the tag is set to
+# "index"
 #
 #   values:                             boolean (true|false)
 #   default:                            false
 #
 # robots.follow
 # ------------------------------------------------------------------------------
-#   Controls spider|robots of search engines. Sets the meta
-#   tag for "robots". If set to "false", the meta tag robots
-#   is set to "nofollow", if set to "true" the tag is set to
-#   "follow".
+# Controls spider|robots of search engines. Sets the meta
+# tag for "robots". If set to "false", the meta tag robots
+# is set to "nofollow", if set to "true" the tag is set to
+# "follow".
 #
 #   values:                             boolean (true|false)
 #   default:                            false
+# ------------------------------------------------------------------------------
 #
-title:                                  Jekyll One
-slogan:                                 j1 template starter web
-description: >
-                                        Made for Jekyll · Made for Your Web
-keywords: >
-                                        opensource, free, load, download, start, starter, example,
-                                        high, easy, use, secure, encrypt, standard, popular,
-                                        generate, create, learn, distribute, publish, deploy,
-                                        beginner, advanced, expert, student, learner, writer, reader, visitor
-                                        framework, toolkit, integration, extension, module, api,
-                                        dynamic, static, generator, client, server, internet, local, localhost
-                                        page, web, website, webdesign, material, design, responsive,
-                                        javascript, nodejs, ruby, windows, linux, osx, mac, os,
-                                        http, https, html, html5, css, scss, style,
-                                        browser, firefox, chrome, edge, opera, safari,
-                                        configuration, generator, navigation, menu, dropdown, fab, action, button
-                                        application, interface, provider, api, repository,
-                                        cookie, language, translation, gdpr, dsgvo, privacy,
-                                        asciidoc, aciidoctor, bootstrap, jekyll, liquid,
-                                        hyvor, disqus, git, github, netlify, heroku, apple, microsoft,
-                                        provider, service, internet, support,
-                                        google, analytics, advertising, search, console, silverlight, score,
-                                        j1, template, jekyllone, comment
+title:                                  Jekyll One Template
+slogan:                                 Made for Jekyl - Made for Your Web
+
+preview-image:                          home-screenshot.jpg
 
 author:
   name:                                 Juergen Adams
@@ -329,7 +296,7 @@ permalink:                              pretty
 # if you are running jekyll serve in a development environment,
 # site.url will be set to the value of host, port.
 #
-url:                                  "http://localhost:20000"
+url:                                    "http://localhost:20000"
 
 # The subpath of your site, e.g. /blog/. Used in conjunction with
 # site.url (see above) when you want a link to something with the
@@ -454,25 +421,31 @@ liquid:
   error_mode:                           warn
 
 # ------------------------------------------------------------------------------
-# PLUGIN configuration
+# JEKYLL PLUGIN configuration
 #
 plugins:
 # - algolia
   - asciidoctor
 # - asciidoctor-pdf
   - jekyll-asciidoc
-# - jekyll-feed
+  - jekyll-feed
 # - jekyll-gist
+  - j1-paginator
 # - jekyll-redirect-from
 # - jekyll-sass-converter
+  - jekyll-seo-tag
   - jekyll-sitemap
-  - j1-paginator
 
 # ------------------------------------------------------------------------------
 # JEKYLL FEED
 #
-# feed:
-#   path:                                 /assets/data/atom.xml
+feed:
+  path:                                 /assets/data/atom.xml
+  excerpt_only:                         true
+# posts_limit:                          20
+# categories:
+#   - news
+#   - updates
 
 # ------------------------------------------------------------------------------
 # MARKDOWN

data/lib/starter_web/_data/asciidoc2pdf/images/cover/readme

@@ -0,0 +1,39 @@
+== Covers
+
+You can specify an image or a PDF page to use as either cover of the
+document directly in your theme.
+
+=== Front and back covers
+
+The front cover image is assigned using the front-image key, and the
+back cover image using the back-image key. Specifying the path as the
+target of an inline image macro allows you to specify parameters for
+that image, as shown here:
+
+.Example
+----
+cover:
+  front:
+    image: image:cover.pdf[page=2]
+  back:
+    image: image:splash.png[fit=fill]
+----
+
+A cover image is handled like a background image, so the fit, width, and
+position attributes can be specified.
+
+=== Fit, width, and position
+
+By default, background images are automatically scaled to fit the bounds of
+the page (i.e., fit=contain) and centered (i.e., position=center). Wrapping
+the value in the image macro allows you to customize an image’s size and
+position. The size of the image assigned with an image macro can be
+controlled using the sizing attributes, fit, pdfwidth, scaledwidth, or
+width, when fit=none. The position of the image can be controlled using
+the position attribute.
+
+.Example
+----
+page:
+  background-image: image:page-bg.png[fit=none,position=top center]
+----

data/lib/starter_web/_data/asciidoc2pdf/themes/base-theme.yml

@@ -11,120 +11,116 @@
 # See: https://github.com/asciidoctor/asciidoctor-pdf/blob/master/LICENSE
 # ------------------------------------------------------------------------------
 # NOTE file is read "as is"; variables are not parsed; key layout must be flat
-page_background_color: 'FFFFFF'
-page_layout: portrait
-page_initial_zoom: FitH
-# 36 is equivalent to 0.5in
-page_margin: 36
-page_margin_inner: 48
-page_margin_outer: 24
-page_size: A4
-base_align: left
-#base_font_color: '333333'
-base_font_color: '000000'
-#base_font_family: Times-Roman
-base_font_family: Helvetica
-base_font_size: 12
-# QUESTION should we rename to min_font_size?
-base_font_size_min: 6
-base_font_style: normal
-base_line_height: 1.15
-base_border_color: 'EEEEEE'
-base_border_width: 0.5
-role_line-through_text_decoration: line-through
-role_underline_text_decoration: underline
-role_big_font_size: 14
-role_small_font_size: 10
-role_subtitle_font_size: 0.8em
-button_content: '[%s]'
-button_font_family: Courier
-button_font_style: bold
-key_font_family: Courier
-key_font_style: italic
-mark_background_color: 'FFFF00'
-mark_border_offset: 1
-link_font_color: '0000EE'
-literal_font_family: Courier
-heading_font_style: bold
-heading_h1_font_size: 24
-heading_h2_font_size: 18
-heading_h3_font_size: 16
-heading_h4_font_size: 14
-heading_h5_font_size: 12
-heading_h6_font_size: 10
-heading_line_height: 1.15
-heading_margin_top: 4
-heading_margin_bottom: 12
-heading_min_height_after: 20
-title_page_align: center
-title_page_line_height: 1.15
-title_page_logo_top: 10%
-title_page_title_top: 40%
-title_page_title_font_size: 18
-title_page_subtitle_font_size: 14
-title_page_authors_margin_top: 12
-outline_list_indent: 30
-outline_list_item_spacing: 6
-description_list_description_indent: 30
-description_list_term_font_style: bold
-description_list_term_spacing: 4
-block_margin_bottom: 12
-caption_align: left
-caption_font_style: italic
-caption_margin_inside: 4
-caption_margin_outside: 0
-abstract_font_size: 13.5
-abstract_line_height: 1.4
-abstract_padding: 0
-abstract_title_align: center
-abstract_title_font_style: bold
-admonition_column_rule_color: 'EEEEEE'
-admonition_column_rule_width: 0.5
-admonition_padding: [0, 12, 0, 12]
-admonition_label_font_style: bold
-admonition_label_text_transform: uppercase
-blockquote_border_color: 'EEEEEE'
-blockquote_border_left_width: 4
-blockquote_padding: [6, 12, -6, 14]
-verse_border_color: 'EEEEEE'
-verse_border_left_width: 4
-verse_padding: [6, 12, -6, 14]
-code_font_family: Courier
-code_font_size: 10.8
-code_line_height: 1.2
-code_padding: 9
-code_border_color: 'EEEEEE'
-code_border_width: 0.5
-conum_line_height: 1.15
-conum_glyphs: circled
-example_background_color: 'FFFFFF'
-example_border_color: 'EEEEEE'
-example_border_width: 0.5
-# FIXME reenable margin bottom once margin collapsing is implemented
-example_padding: [12, 12, 0, 12]
-image_align: left
-lead_font_size: 13.5
-lead_line_height: 1.4
-prose_margin_bottom: 12
-sidebar_background_color: 'EEEEEE'
-# FIXME reenable margin bottom once margin collapsing is implemented
-sidebar_padding: [12, 12, 0, 12]
-sidebar_title_align: center
-sidebar_title_font_style: bold
-table_border_color: '000000'
-table_border_style: solid
-table_border_width: 0.5
-table_cell_padding: 2
-table_head_font_style: bold
-table_head_border_bottom_width: 1.25
-table_body_stripe_background_color: 'EEEEEE'
-thematic_break_border_color: 'EEEEEE'
-thematic_break_border_style: solid
-thematic_break_border_width: 0.5
-thematic_break_margin_bottom: 12
-toc_indent: 15
-toc_line_height: 1.4
-footnotes_font_size: 9
-footnotes_item_spacing: 3
-footer_recto_right_content: '{page-number}'
-footer_verso_left_content: '{page-number}'
+# ------------------------------------------------------------------------------
+
+page_background_color:                  'FFFFFF'
+page_layout:                            portrait
+page_initial_zoom:                      FitH
+page_margin:                            36                                      # 36 is equivalent to 0.5in
+page_margin_inner:                      48
+page_margin_outer:                      24
+page_size:                              A4
+base_align:                             left
+base_font_color:                        '000000'                                # '333333'
+base_font_family:                       Helvetica                               # Times-Roman
+base_font_size:                         12
+base_font_size_min:                     6
+base_font_style:                        normal
+base_line_height:                       1.15
+base_border_color:                      EEEEEE
+base_border_width:                      0.5
+role_line-through_text_decoration:      line-through
+role_underline_text_decoration:         underline
+role_big_font_size:                     14
+role_small_font_size:                   10
+role_subtitle_font_size:                0.8em
+button_content:                         '[%s]'
+button_font_family:                     Courier
+button_font_style:                      bold
+key_font_family:                        Courier
+key_font_style:                         italic
+mark_background_color:                  FFFF00
+mark_border_offset:                     1
+link_font_color:                        0000EE
+literal_font_family:                    Courier
+heading_font_style:                     bold
+heading_h1_font_size:                   24
+heading_h2_font_size:                   18
+heading_h3_font_size:                   16
+heading_h4_font_size:                   14
+heading_h5_font_size:                   12
+heading_h6_font_size:                   10
+heading_line_height:                    1.15
+heading_margin_top:                     4
+heading_margin_bottom:                  12
+heading_min_height_after:               20
+title_page_align:                       center
+title_page_line_height:                 1.15
+title_page_logo_top:                    10%
+title_page_title_top:                   40%
+title_page_title_font_size:             18
+title_page_subtitle_font_size:          14
+title_page_authors_margin_top:          12
+outline_list_indent:                    30
+outline_list_item_spacing:              6
+description_list_description_indent:    30
+description_list_term_font_style:       bold
+description_list_term_spacing:          4
+block_margin_bottom:                    12
+caption_align:                          left
+caption_font_style:                     italic
+caption_margin_inside:                  4
+caption_margin_outside:                 0
+abstract_font_size:                     13.5
+abstract_line_height:                   1.4
+abstract_padding:                       0
+abstract_title_align:                   center
+abstract_title_font_style:              bold
+admonition_column_rule_color:           EEEEEE
+admonition_column_rule_width:           0.5
+admonition_padding:                     [0, 12, 0, 12]
+admonition_label_font_style:            bold
+admonition_label_text_transform:        uppercase
+blockquote_border_color:                EEEEEE
+blockquote_border_left_width:           4
+blockquote_padding:                     [6, 12, -6, 14]
+verse_border_color:                     EEEEEE
+verse_border_left_width:                4
+verse_padding:                          [6, 12, -6, 14]
+code_font_family:                       Courier
+code_font_size:                         10.8
+code_line_height:                       1.2
+code_padding:                           9
+code_border_color:                      EEEEEE
+code_border_width:                      0.5
+conum_line_height:                      1.15
+conum_glyphs:                           circled
+example_background_color:               FFFFFF
+example_border_color:                   EEEEEE
+example_border_width:                   0.5
+example_padding:                        [12, 12, 0, 12]
+image_align:                            left
+lead_font_size:                         13.5
+lead_line_height:                       1.4
+prose_margin_bottom:                    12
+sidebar_background_color:               EEEEEE
+sidebar_padding:                        [12, 12, 0, 12]
+sidebar_title_align:                    center
+sidebar_title_font_style:               bold
+table_border_color:                     000000
+table_border_style:                     solid
+table_border_width:                     0.5
+table_cell_padding:                     2
+table_head_font_style:                  bold
+table_head_border_bottom_width:         1.25
+table_body_stripe_background_color:     EEEEEE
+thematic_break_border_color:            EEEEEE
+thematic_break_border_style:            solid
+thematic_break_border_width:            0.5
+thematic_break_margin_bottom:           12
+toc_indent:                             15
+toc_line_height:                        1.4
+footnotes_font_size:                    9
+footnotes_item_spacing:                 3
+footer_recto_right_content:             '{page-number}'
+footer_verso_left_content:              '{page-number}'