j1-template 2022.6.1 → 2022.6.3

data/lib/starter_web/_data/templates/seo-tags.html

@@ -1,3 +1,21 @@
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/_data/templates/seo-tags.html
+ # Liquid template to create the HTML portion for the seo-tags plugin
+ #
+ # Product/Info:
+ # https://jekyll.one
+ #
+ # Copyright (C) 2022 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #   liquid_var: {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
 <!-- Begin J1 SEO tags -->
 
 {% if seo_tag.title? %}

data/lib/starter_web/_data/templates/sitemap.xml

@@ -1,3 +1,25 @@
+{% capture cache %}
+
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/_data/templates/sitemap.xml
+ # Liquid template to generate the sitemap XML entries
+ #
+ # Product/Info:
+ # https://jekyll.one
+ #
+ # Copyright (C) 2022 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #   liquid_var: {{ liquid_var | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} main
+-------------------------------------------------------------------------------- {% endcomment %}
 <?xml version="1.0" encoding="UTF-8"?>
 {% if page.xsl %}
   <?xml-stylesheet type="text/xsl" href="{{ "/sitemap.xsl" | absolute_url }}"?>
@@ -34,3 +56,10 @@
     </url>
   {% endfor %}
 </urlset>
+
+{% endcapture %}
+
+
+{% comment %} POST processing of the generated feed XML file|s
+-------------------------------------------------------------------------------- {% endcomment %}
+{{ cache }}

data/lib/starter_web/_plugins/index/lunr.rb

@@ -109,6 +109,14 @@ module Jekyll
         rebuild = @module_config['rebuild']
         index_file = index_dest + @module_config['index_file']
 
+        if plugin_disabled?
+          Jekyll.logger.info 'J1 Lunr:', 'disabled'
+          return
+        else
+          Jekyll.logger.info 'J1 Lunr:', 'enabled'
+          Jekyll.logger.info 'J1 Lunr:', 'generate search index'
+        end
+
         if @module_config['rebuild'] == false
           if File.exist?(index_file)
             Jekyll.logger.info 'J1 Lunr:', 'rebuild index disabled'
@@ -119,8 +127,6 @@ module Jekyll
           end
         end
 
-        Jekyll.logger.info 'J1 Lunr:', 'generate search index'
-
         # gather posts and pages
         #
         items = pages_to_index(site)
@@ -197,6 +203,22 @@ module Jekyll
 
       private
 
+      # Returns the plugin's config or an empty hash if not set
+      #
+      def config
+        @config ||= @module_config  || {}
+      end
+
+      # Check if plugin is enabled|disabled
+      #
+      def plugin_disabled?
+        if config['enabled']
+          false
+        else
+          true
+        end
+      end
+
       # load the stopwords (file)
       #
       def stopwords
@@ -372,6 +394,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2022.6.1'
+    VERSION = '2022.6.3'
   end
 end

data/lib/starter_web/_plugins/seo/j1-feed.rb

@@ -45,29 +45,31 @@ module J1Feed
       @feed_output                      = @module_config['feed_output']
 
       if disabled_in_development?
-        Jekyll.logger.info "J1 Feed:", "generate feed skipped in mode development"
+        Jekyll.logger.info "J1 Feeds:", "skipped in mode development"
         return
       end
 
       if plugin_disabled?
-        Jekyll.logger.info "J1 Feed:", "generate feed: disabled"
+        Jekyll.logger.info "J1 Feeds:", "disabled"
         return
+      else
+        Jekyll.logger.info "J1 Feeds:", "enabled"
       end
 
       if @module_config['excerpt_only']
-        Jekyll.logger.info "J1 Feed:", "generate feed for: excerpts only"
+        Jekyll.logger.info "J1 Feeds:", "generate rss feeds for: excerpts only"
       end
 
       if @module_config['posts_limit'] < 100
-        Jekyll.logger.info "J1 Feed:", "generate feed for: #posts of #{@module_config['posts_limit']}"
+        Jekyll.logger.info "J1 Feeds:", "generate rss feeds for: #posts of #{@module_config['posts_limit']}"
       else
-        Jekyll.logger.info "J1 Feed:", "generate feed for: #posts of unlimited"
+        Jekyll.logger.info "J1 Feeds:", "generate rss feeds for: #posts of unlimited"
       end
 
       collections.each do |name, meta|
-        Jekyll.logger.info "J1 Feed:", "generate feed for: all #{name}"
+        Jekyll.logger.info "J1 Feeds:", "generate rss feeds for: all #{name}"
         (meta["categories"] + [nil]).each do |category|
-          Jekyll.logger.info "J1 Feed:", "generate feed for posts by category: #{category}" if category
+          Jekyll.logger.info "J1 Feeds:", "generate rss feeds for posts by category: #{category}" if category
           path = feed_path(:collection => name, :category => category)
 
           # rebuild the feed xml file?
@@ -75,7 +77,7 @@ module J1Feed
           unless @module_config['rebuild_feeds']
             path = feed_path(:collection => name, :category => category)
             if file_exists?(path)
-              Jekyll.logger.info "J1 Feed:", "feed already exist, skip rebuild"
+              Jekyll.logger.info "J1 Feeds:", "feed already exist, skip rebuild"
               next
             end
           end
@@ -164,7 +166,7 @@ module J1Feed
         # next if %r![^a-zA-Z0-9_]!.match?(tag)
         next if %r!\W!.match?(tag)
 
-        Jekyll.logger.info "J1 Feed:", "generate feed for posts by tag: #{tag}" if tag
+        Jekyll.logger.info "J1 Feeds:", "generate rss feeds for posts by tag: #{tag}" if tag
         path = "#{tags_path}#{tag.downcase}.xml"
         next if file_exists?(path)
 

data/lib/starter_web/_plugins/seo/j1-seo-tags.rb

@@ -16,6 +16,59 @@
 require "jekyll"
 
 module Jekyll
+
+  class J1SeoTag < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      @site = site
+
+      @mode                             = site.config['environment']
+      @template                         = site.config['theme']
+
+      @project_path                     = File.join(File.dirname(__FILE__)).sub('_plugins/seo', '')
+      @module_data_path                 = File.join(File.join(@project_path, '_data'))
+      @module_config_path               = File.join(File.join(@module_data_path, 'plugins'))
+      @module_template_path             = File.join(File.join(@module_data_path, 'templates'))
+      @module_config_default            = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'seo-tags.yml')))
+      @module_config_user               = YAML::load(File.open(File.join(@module_config_path, 'seo-tags.yml')))
+
+      @module_config_default_settings   = @module_config_default['defaults']
+      @module_config_user_settings      = @module_config_user['settings']
+      @module_config                    = @module_config_default_settings.merge!(@module_config_user_settings)
+
+      if plugin_disabled?
+        Jekyll.logger.info "J1 Seo:", "disabled"
+        return
+      else
+        Jekyll.logger.info "J1 Seo:", "enabled"
+        Jekyll.logger.info "J1 Seo:", "generate seo tags"
+      end
+
+    end
+
+    private
+
+    # Returns the plugin's config or an empty hash if not set
+    #
+    def config
+      @config ||= @module_config  || {}
+    end
+
+    # Check if plugin is enabled|disabled
+    #
+    def plugin_disabled?
+      if config['enabled']
+        false
+      else
+        true
+      end
+    end
+
+  end
+
   class SeoTag < Liquid::Tag
     attr_accessor :context
 
@@ -102,6 +155,7 @@ module Jekyll
     end
 
   end
+
 end
 
 Liquid::Template.register_tag("seo", Jekyll::SeoTag)
@@ -198,7 +252,6 @@ module Jekyll
   end
 end
 
-
 module Jekyll
   class SeoTag
 
@@ -463,7 +516,6 @@ module Jekyll
   end
 end
 
-
 module Jekyll
   class SeoTag
     class Filters
@@ -477,7 +529,6 @@ module Jekyll
   end
 end
 
-
 module Jekyll
   class SeoTag
     # A drop representing the page image
@@ -559,7 +610,6 @@ module Jekyll
   end
 end
 
-
 module Jekyll
   class SeoTag
     class JSONLDDrop < Jekyll::Drops::Drop
@@ -662,56 +712,3 @@ module Jekyll
     end
   end
 end
-
-# module Jekyll
-#   class SeoTag
-#     # This module is deprecated, but is included in the Gem to avoid a breaking
-#     # change and should be removed at the next major version bump
-#     module JSONLD
-#       METHODS_KEYS = {
-#         :json_context   => "@context",
-#         :type           => "@type",
-#         :name           => "name",
-#         :page_title     => "headline",
-#         :json_author    => "author",
-#         :json_image     => "image",
-#         :date_published => "datePublished",
-#         :date_modified  => "dateModified",
-#         :description    => "description",
-#         :publisher      => "publisher",
-#         :main_entity    => "mainEntityOfPage",
-#         :links          => "sameAs",
-#         :canonical_url  => "url",
-#       }.freeze
-#
-#       # Self should be a Jekyll::SeoTag::Drop instance (when extending the module)
-#       def json_ld
-#         Jekyll.logger.warn "Jekyll::SeoTag::JSONLD is deprecated"
-#         @json_ld ||= JSONLDDrop.new(self)
-#       end
-#     end
-#   end
-# end
-
-
-# module Jekyll
-#   class SeoTag
-#     # Mixin to share common URL-related methods between class
-#     module UrlHelper
-#       private
-#
-#       # Determines if the given string is an absolute URL
-#       #
-#       # Returns true if an absolute URL
-#       # Returns false if it's a relative URL
-#       # Returns nil if it is not a string or can't be parsed as a URL
-#       def absolute_url?(string)
-#         return unless string
-#
-#         Addressable::URI.parse(string).absolute?
-#       rescue Addressable::URI::InvalidURIError
-#         nil
-#       end
-#     end
-#   end
-# end

data/lib/starter_web/_plugins/seo/j1-sitemap.rb

@@ -45,12 +45,13 @@ module Jekyll
       @sitemap_source_path ||= File.expand_path @sitemap_template_name, @template_source_folder
 
       if plugin_disabled?
-        Jekyll.logger.info "J1 Sitemap:", "generate sitemap files: disabled"
+        Jekyll.logger.info "J1 Sitemap:", "disabled"
         return
+      else
+        Jekyll.logger.info "J1 Sitemap:", "enabled"
+        Jekyll.logger.info "J1 Sitemap:", "generate sitemap files"
       end
-
-      Jekyll.logger.info "J1 Sitemap:", "generate map files"
-
+    
       @site.pages << sitemap unless file_exists?("sitemap.xml")
       @site.pages << robots unless file_exists?("robots.txt")
     end

data/lib/starter_web/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "j1",
-  "version": "2022.6.1",
+  "version": "2022.6.3",
   "description": "J1 Template Starter Web",
   "homepage": "https://your.site",
   "author": {

data/lib/starter_web/pages/public/learn/roundtrip/_includes/documents/themes_bootstrap.asciidoc

@@ -1,51 +1,51 @@
-== The Themes Menu
-
-Themes adjust the website's appearance based on the core CSS rules and
-definitions of Bootstrap. Themes do not change the framework's functionality
-but modify rule-based, e.g., the color scheme, fonts, sizes, or the
-appearance of more complex elements like forms or tables. Additionally, a
-theme may add additional components to extend the Bootstrap's framework.
-
-Modifying the CSS styles of link:{url-bs--home}[Bootstrap, {browser-window--new}]
-is not rocket science. But, to be honest, some knowledge is needed for
-link:{url-w3org--css-spec}[the CSS technology, {browser-window--new}] to do so.
-We encourage you to spend some time first on learning CSS. To learn what is the
-link:{url-w3schools--css-tutorial}[design base, {browser-window--new}] of each
-and every website.
-
-.Themes menu
-lightbox::images--themes-menu[ 1280, {data-images--themes-menu} ]
-
-Thanks to the people at link:{url-bootswatch--home}[Bootswatch, {browser-window--new}],
-a great set of already prepared Bootstrap stylesheets in various designs are
-available on their website. There is no need to start from scratch. It is not
-needed to re-define all the Bootstrap variables, and rebuild the framework
-files to create a new theme. Many different styles are available. What is
-already available at Bootswatch is at least a good base for your modifications;
-your unique design.
-
-Besides the bunch of different stylesheets at Bootswatch, an
-link:{url-bootswatch--api}[Integration API, {browser-window--new}] is provided
-that helps a lot to integrate available designs into an existing site. This API
-is the base to integrate selectable Bootswatch stylesheets into the J1 Template
-navigation system for easy use.
-
-=== Apply a theme
-
-The base for designing pages using the J1 Template is the theme Uno, a modern
-light theme used for many types of websites. And what we mentioned
-already, web design is not: one size fits all. The theme Uno can be seen as
-a good base, a starting point. Combining Uno and a different theme may be a fast
-solution for your site!?
-
-You can find all available themes and stylesheets on your pages
-from the menu Themes. You're invited to check how a page is changing for
-its design if other stylesheets, other ideas of web design are used.
-
-TIP: Changing BS-based styles is one thing. Changing from one theme to the
-next at runtime is a bit more challenging. For the first version of the J1
-Template, many styles are automatically changed for J1 specific components,
-but not all of them for now.
-
-Select a theme from this menu, and a new BS-based stylesheet is automatically
-applied to your pages.
+== The Themes Menu
+
+Themes adjust the website's appearance based on the core CSS rules and
+definitions of Bootstrap. Themes do not change the framework's functionality
+but modify rule-based, e.g., the color scheme, fonts, sizes, or the
+appearance of more complex elements like forms or tables. Additionally, a
+theme may add additional components to extend the Bootstrap's framework.
+
+Modifying the CSS styles of link:{url-bs--home}[Bootstrap, {browser-window--new}]
+is not rocket science. But, to be honest, some knowledge is needed for
+link:{url-w3org--css-spec}[the CSS technology, {browser-window--new}] to do so.
+We encourage you to spend some time first on learning CSS. To learn what is the
+link:{url-w3schools--css-tutorial}[design base, {browser-window--new}] of each
+and every website.
+
+.Themes menu
+lightbox::images--themes-menu[ 1280, {data-images--themes-menu} ]
+
+Thanks to the people at link:{url-bootswatch--home}[Bootswatch, {browser-window--new}],
+a great set of already prepared Bootstrap stylesheets in various designs are
+available on their website. There is no need to start from scratch. It is not
+needed to re-define all the Bootstrap variables, and rebuild the framework
+files to create a new theme. Many different styles are available. What is
+already available at Bootswatch is at least a good base for your modifications;
+your unique design.
+
+Besides the bunch of different stylesheets at Bootswatch, an
+link:{url-bootswatch--api}[Integration API, {browser-window--new}] is provided
+that helps a lot to integrate available designs into an existing site. This API
+is the base to integrate selectable Bootswatch stylesheets into the J1 Template
+navigation system for easy use.
+
+=== Apply a theme
+
+The base for designing pages using the J1 Template is the theme Uno, a modern
+light theme used for many types of websites. And what we mentioned
+already, web design is not: one size fits all. The theme Uno can be seen as
+a good base, a starting point. Combining Uno and a different theme may be a fast
+solution for your site!?
+
+You can find all available themes and stylesheets on your pages
+from the menu Themes. You're invited to check how a page is changing for
+its design if other stylesheets, other ideas of web design are used.
+
+TIP: Changing BS-based styles is one thing. Changing from one theme to the
+next at runtime is a bit more challenging. For the first version of the J1
+Template, many styles are automatically changed for J1 specific components,
+but not all of them for now.
+
+Select a theme from this menu, and a new BS-based stylesheet is automatically
+applied to your pages.