j1-template 2021.1.29 → 2021.2.0

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/200_chapter.asciidoc

@@ -1,53 +1,164 @@
-// ~/document_base_folder/_includes/documents
-// Sublevel Entry Document: 200_chapter.asciidoc
-// -----------------------------------------------------------------------------
+== Jekyll Variables
 
-== Chapter 2
+Jekyll traverses your site looking for files to process. Any files with `YAML
+front matter` are subject to processing. For each of these files, Jekyll makes
+a variety of data available via the `Liquid templating system`.
 
-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.
+The following is a reference of the available data.
 
-For J1 Template, two different lightboxes can be used:
 
-* Lightbox V2 (lightbox)
-* LightGallery
+=== Global Variables
 
-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.
+[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
+|=======================================================================
+|Variable |Description
+|`site` |Sitewide information + configuration settings from
+`_config.yml`. See below for details.
 
-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.
+|`page` |Page specific information + the YAML front
+matter. Custom variables set via the YAML Front Matter will be
+available here. See below for details.
 
-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.
+|`layout`
+|Layout specific information + the YAML
+front matter. Custom variables set via the YAML Front Matter in layouts
+will be available here.
 
-=== Section
+|`content` |In layout files, the rendered content of the Post or Page
+being wrapped. Not defined in Post or Page files.
 
-Find below an example of using the lightbox Lightbox standalone. See how
-single (individual) images are linked for the use with Lightbox.
+|`paginator` |When the `paginate` configuration option is set, this
+variable becomes available for use. See Pagination
+for details.
+|=======================================================================
 
-.Lightbox block for standalone images
-lightbox::example-standalone[ 400, {data-images-standalone} ]
+=== Site Variables
 
-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 ]
+[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
+|=======================================================================
+|Variable |Description
+|`site.time` |The current time (when you run the `jekyll` command).
 
-==== Subsection
+|`site.pages` |A list of all Pages.
 
-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.
+|`site.posts` |A reverse chronological list of all Posts.
 
-gallery::jg_example[]
+|`site.related_posts` |If the page being processed is a Post, this
+contains a list of up to ten related Posts. By default, these are the
+ten most recent posts. For high quality but slow to compute results, run
+the `jekyll` command with the `--lsi`
+(https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing[latent
+semantic indexing]) option. Also note GitHub Pages does not support the
+`lsi` option when generating sites.
+
+|`site.static_files` |A list of all (i.e. files not processed by
+Jekyll's converters or the Liquid renderer). Each file has three
+properties: `path`, `modified_time` and `extname`.
+
+|`site.html_pages` |A subset of `site.pages` listing those which end in
+`.html`.
+
+|`site.html_files` |A subset of `site.static_files` listing those which
+end in `.html`.
+
+|`site.collections` |A list of all the collections.
+
+|`site.data` |A list containing the data loaded from the YAML files
+located in the `_data` directory.
+
+|`site.documents` |A list of all the documents in every collection.
+
+|`site.categories.CATEGORY` |The list of all Posts in category `CATEGORY`.
+
+|`site.tags.TAG` |The list of all Posts with tag `TAG`.
+
+|`site.[CONFIGURATION_DATA]` |All the variables set via the command line
+and your `_config.yml` are available through the `site` variable. For
+example, if you have `url: http://mysite.com` in your configuration
+file, then in your Posts and Pages it will be stored in `site.url`.
+Jekyll does not parse changes to `_config.yml` in `watch` mode, you must
+restart Jekyll to see changes to variables.
+|=======================================================================
+
+
+=== Page Variables
+
+[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
+|=======================================================================
+|Variable |Description
+|`page.content` |The content of the Page, rendered or un-rendered
+depending upon what Liquid is being processed and what `page` is.
+
+|`page.title` |The title of the Page.
+
+|`page.excerpt` |The un-rendered excerpt of the Page.
+
+|`page.url` |The URL of the Post without the domain, but with a leading
+slash, e.g. `/2008/12/14/my-post.html`
+
+|`page.date` |The Date assigned to the Post. This can be overridden in a
+Post's front matter by specifying a new date/time in the format
+`YYYY-MM-DD HH:MM:SS` (assuming UTC), or `YYYY-MM-DD HH:MM:SS +/-TTTT`
+(to specify a time zone using an offset from UTC. e.g.
+`2008-12-14 10:30:00 +0900`).
+
+|`page.id` |An identifier unique to the Post (useful in RSS feeds). e.g.
+`/2008/12/14/my-post`
+
+|`page.categories` |The list of categories to which this post belongs.
+Categories are derived from the directory structure above the `_posts`
+directory. For example, a post at
+`/work/code/_posts/2008-12-24-closures.md` would have this field set to
+`['work', 'code']`. These can also be specified in the
+YAML Front Matter.
+
+|`page.tags` |The list of tags to which this post belongs. These can be
+specified in the YAML Front Matter.
+
+|`page.path` |The path to the raw post or page. Example usage: Linking
+back to the page or post's source on GitHub. This can be overridden in
+the YAML Front Matter.
+
+|`page.next` |The next post relative to the position of the current post
+in `site.posts`. Returns `nil` for the last entry.
+
+|`page.previous` |The previous post relative to the position of the
+current post in `site.posts`. Returns `nil` for the first entry.
+|=======================================================================
+
+[TIP]
+====
+Use Custom Front Matter
+
+Any custom front matter that you specify will be available under `page`.
+For example, if you specify `custom_css: true` in a pages front matter,
+that value will be available as `page.custom_css`.
+
+If you specify front matter in a layout, access that via `layout`. For
+example, if you specify `class: full_page` in a pages front matter,
+that value will be available as `layout.class` in the layout and its
+parents.
+====
+
+=== Paginator
+
+[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
+|==============================================================
+|Variable |Description
+|`paginator.per_page` |Number of Posts per page.
+|`paginator.posts` |Posts available for that page.
+|`paginator.total_posts` |Total number of Posts.
+|`paginator.total_pages` |Total number of pages.
+|`paginator.page` |The number of the current page.
+|`paginator.previous_page` |The number of the previous page.
+|`paginator.previous_page_path` |The path to the previous page.
+|`paginator.next_page` |The number of the next page.
+|`paginator.next_page_path` |The path to the next page.
+|==============================================================
+
+NOTE: These are only available in index files, however they can be located
+in a subdirectory, such as `<code>/blog/index.html</code>`.
+
+NOTE: J1 is using Paginator V2 for pagination. See details with
+{plugins_paginator_v2_user_guide}[Paginator V2 User Guide].

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/multi.adoc

@@ -23,7 +23,7 @@ robots:
 permalink:                              /pages/public/skeleton/multi/
 regenerate:                             false
 
-resources:                              [ lightbox, lightGallery, justifiedGallery ]
+resources:                              [ lightbox, clipboard, rouge ]
 resource_options:
   - toccer:
       collapseDepth:                    4
@@ -58,11 +58,9 @@ resource_options:
 // -----------------------------------------------------------------------------
 {% include {{load_attributes}} scope="all" %}
 
-
 // Page content
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The Asciidoc *skeleton multi-document* a helper for setting up a base file and
+The Asciidoc skeleton *multi-document* 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 creating AsciiDoc
 documents from it.
@@ -81,9 +79,6 @@ All Asciidoc Document Skeletons are fully *relocateable* and can be placed in
 any subfolder of your Jekyll site.
 ====
 
-[role="mb-5"]
-*Happy Jekylling!*
-
 
 // Include Sublevel Documents
 // -----------------------------------------------------------------------------