j1-template 2022.5.1 → 2022.5.3

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/200_themes.adoc

@@ -3,7 +3,18 @@ title:                                  Asciidoctor PDF Themes
 tagline:                                Theming Guide for the Asciidoctor PDF Converter
 date:                                   2022-01-01 00:00:00
 description: >
-                                        Asciidoctor PDF Theming Guide
+                                        Asciidoctor PDF is a native PDF converter for AsciiDoc that plugs
+                                        into the pdf backend. It bypasses the requirement to generate an
+                                        intermediary format such as DocBook, Apache FO, or LaTeX. Instead,
+                                        you can use Asciidoctor PDF to convert your documents directly
+                                        from AsciiDoc to PDF. The aim of this library is to take the pain
+                                        out of creating PDF documents from AsciiDoc.
+                                        Top features: javascript, css, scss, html, jamstack, provider, service,
+                                        internet, support, google, analytics, advertising, search, console,
+                                        silverlight, score, netlify, 1-Click, deployment, responsive, design,
+                                        themes, desktop, mobile, web, site, blog, post, navigation, royalty,
+                                        free, images, carousel, slider, gallery, video, player, clipboard,
+                                        cookie, consent, full-text, search, engine, infinite scroll.
 
 categories:                             [ Knowledge ]
 tags:                                   [ Asciidoctor, PDF, Converter ]
@@ -13,8 +24,11 @@ regenerate:                             false
 
 resources:                              [ animate, clipboard, lightbox, rouge ]
 resource_options:
+
   - attic:
+
       slides:
+
         - url:                          /assets/images/modules/attics/sigmund-1920x1280.jpg
           alt:                          Photo by Sigmund on Unsplash
           alignY:                       0.3

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/attributes.asciidoc

@@ -67,13 +67,14 @@ end::footnotes[]
 // Tags - Asciidoc attributes used internally
 // -----------------------------------------------------------------------------
 tag::tags[]
-:images-dir:                                      pages/manuals/asciidoctor_pdf
+// :images-dir:                                      pages/manuals/asciidoctor_pdf
 end::tags[]
 
 
 // Data - Data elements for Asciidoctor extensions
 // -----------------------------------------------------------------------------
 tag::data[]
+:data-images-example--pdf-screenshot:             "assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png, PDF document rendered in a PDF viewer"
 end::data[]
 
 

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/{100_converter/000_basic_example.asciidoc → 000_examples/basic_example.asciidoc}

@@ -1,4 +1,5 @@
 = Document Title
+
 Doc Writer <doc@example.com>
 :doctype: book
 :reproducible:

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/100_converter/111_about_the_converter.asciidoc

@@ -1,10 +1,15 @@
-== About the PDF-Generator Prawn
-
-{uri-asciidoctor-pdf}[Asciidoctor PDF, {browser-window--new}] is made possible by an amazing
-Ruby gem named _Prawn_. And what a gem it is! {uri-prawn-home}[Prawn, {browser-window--new}] is a
-nimble PDF writer for _Ruby_. More important, it's a hackable platform that offers
-both high level APIs for the most common needs and low level APIs for bending
-the document model to accommodate special circumstances.
+Asciidoctor PDF is a native PDF converter for AsciiDoc that plugs into
+the PDF backend. It bypasses the requirement to generate an intermediary
+format such as DocBook, Apache FO, or LaTeX. Instead, you can use Asciidoctor
+PDF to convert your documents directly from AsciiDoc to PDF. The aim of
+this library is to take the pain out of creating PDF documents from AsciiDoc.
+
+{uri-asciidoctor-pdf}[Asciidoctor PDF, {browser-window--new}] is made possible
+by an amazing Ruby gem named _Prawn_. And what a gem it is!
+{uri-prawn-home}[Prawn, {browser-window--new}] is a nimble PDF writer for
+_Ruby_. More important, it's a hackable platform that offers both high level
+APIs for the most common needs and low level APIs for bending the document
+model to accommodate special circumstances.
 
 [caption=Status]
 CAUTION: _Asciidoctor PDF_ is currently _alpha_ software. While the converter
@@ -21,7 +26,7 @@ Here's an example that demonstrates how to use _Prawn_ to create a basic PDF
 document.
 
 .Create a basic PDF document using _Prawn_
-[source,ruby]
+[source, ruby]
 ----
 require 'prawn'
 
@@ -38,7 +43,7 @@ critical gap in _Asciidoctor_. It absolutely takes the pain out of creating
 printable documents. Picking up from there, _Asciidoctor PDF_ takes the pain out
  of creating PDF documents _from AsciiDoc_.
 
-=== Highlights
+== Highlights
 
 * Direct AsciiDoc to PDF conversion
 * SVG support
@@ -57,7 +62,7 @@ printable documents. Picking up from there, _Asciidoctor PDF_ takes the pain out
 * Custom (TTF) fonts
 * Double-sided printing mode (margins alternate on recto and verso pages)
 
-=== Prerequisites
+== Prerequisites
 
 All that's needed is _Ruby_ (1.9.3 or above; 2.3.x recommended) and a few _Ruby_
 gems, which we explain how to install in the next section.
@@ -65,7 +70,10 @@ gems, which we explain how to install in the next section.
 To check if you have _Ruby_ available, use the `ruby` command to query the
 version installed:
 
- $ ruby --version
+[source, sh]
+----
+ruby --version
+----
 
 [WARNING]
 ====
@@ -77,10 +85,13 @@ Starting with _Prawn_ 2.0.0, _Prawn_ requires Ruby >= 2.0.0 during installation.
 Therefore, to use _Asciidoctor PDF_ with Ruby 1.9.3, you must first explicitly
 install the following dependencies to lock the versions:
 
- $ gem install prawn --version 1.3.0
-   gem install addressable --version 2.4.0
-   gem install prawn-svg --version 0.21.0
-   gem install prawn-templates --version 0.0.3
+[source, sh]
+----
+gem install prawn --version 1.3.0
+gem install addressable --version 2.4.0
+gem install prawn-svg --version 0.21.0
+gem install prawn-templates --version 0.0.3
+----
 
 You can then proceed with installation of _Asciidoctor PDF_ on Ruby 1.9.3.
 
@@ -88,15 +99,18 @@ Starting with _Prawn_ 2.2.0, _Prawn_ requires Ruby >= 2.1.0 during installation.
 Therefore, to use _Asciidoctor PDF_ with Ruby 2.0.0, you must first explicitly
 install the following dependencies to lock the versions:
 
- $ gem install prawn --version 2.1.0
-   gem install prawn-svg --version 0.26.0
-   gem install prawn-templates --version 0.0.4
+[source, sh]
+----
+gem install prawn --version 2.1.0
+gem install prawn-svg --version 0.26.0
+gem install prawn-templates --version 0.0.4
+----
 
-For all other versions of _Ruby_, you can simply install the _Asciidoctor PDF_ gem.
-It will transitively install the required dependencies.
+For all other versions of _Ruby_, you can simply install the _Asciidoctor PDF_
+gem. It will transitively install the required dependencies.
 ====
 
-==== System Encoding
+=== System Encoding
 
 _Asciidoctor_ assumes you're using UTF-8 encoding. To minimize encoding problems,
 make sure the default encoding of your system is set to UTF-8.

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/100_converter/112_getting_started.asciidoc

@@ -1,32 +1,44 @@
 == Getting Started
 
-You can get _Asciidoctor PDF_ by installing the published gem or running th
- code from source.
+You can get _Asciidoctor PDF_ by installing the published gem or running the
+code from source.
 
 === Install the Published Gem
 
-_Asciidoctor PDF_ is published as a pre-release on RubyGems.org.
-First, make sure you have satisfied the prerequisites.
-Then, you can install the published gem using the following command:
+_Asciidoctor PDF_ is published as a pre-release on RubyGems.org. First, make
+sure you have satisfied the prerequisites. Then, you can install the published
+gem using the following command:
 
- $ gem install asciidoctor-pdf --pre
+[source, sh]
+----
+gem install asciidoctor-pdf --pre
+----
 
 If you want to syntax highlight source listings, you'll also want to install
 Rouge, Pygments, or CodeRay. Choose one (or more) of the following:
 
 .Rouge (preferred)
- $ gem install rouge
+[source, sh]
+----
+gem install rouge
+----
 
 .Pygments
- $ gem install pygments.rb
+[source, sh]
+----
+gem install pygments.rb
+----
 
 .CodeRay
- $ gem install coderay
+[source, sh]
+----
+gem install coderay
+----
 
 You then activate syntax highlighting for a given document by adding the
 `source-highlighter` attribute to the document header (Rouge shown):
 
-[source,asciidoc]
+[source, asciidoc]
 ----
 :source-highlighter: rouge
 ----
@@ -34,7 +46,10 @@ You then activate syntax highlighting for a given document by adding the
 Assuming all the required gems install properly, verify you can run the
 `asciidoctor-pdf` script:
 
- $ asciidoctor-pdf -v
+[source, sh]
+----
+asciidoctor-pdf -v
+----
 
 If you see the version of _Asciidoctor PDF_ printed, you're ready to use
 _Asciidoctor PDF_.
@@ -42,19 +57,51 @@ _Asciidoctor PDF_.
 Let's grab an AsciiDoc document to distill and start putting _Asciidoctor PDF_
 to use!
 
-=== An Example AsciiDoc Document
+=== An example AsciiDoc document
 
 If you don't already have an AsciiDoc document, you can use the
 *basic_example.adoc* file found in the examples directory of this
 project.
 
+/////
 ifeval::[{safe-mode-level} < 20]
 .000_basic_example.adoc
-[source,asciidoc]
-....
-include::000_basic_example.asciidoc[]
-....
+[source, asciidoc]
+----
+= Document Title
+
+Doc Writer <doc@example.com>
+:doctype: book
+:reproducible:
+//:source-highlighter: coderay
+:source-highlighter: rouge
+:listing-caption: Listing
+// Uncomment next line to set page size (default is A4)
+//:pdf-page-size: Letter
+
+A simple http://asciidoc.org[AsciiDoc] document.
+
+== Introduction
+
+A paragraph followed by a simple list with square bullets.
+
+[square]
+* item 1
+* item 2
+
+Here's how you say "`Hello, World!`" in Prawn:
+
+.Create a basic PDF document using Prawn
+[source,ruby]
+----
+require 'prawn'
+
+Prawn::Document.generate 'example.pdf' do
+  text 'Hello, World!'
+end
+----
 endif::[]
+/////
 
 It's time to convert the AsciiDoc document directly to PDF.
 
@@ -66,11 +113,17 @@ it uses the `source-highlighter` attribute with the value of `rouge`.
 Converting to PDF is a simple as running the `asciidoctor-pdf` script using
 _Ruby_ and passing our AsciiDoc document as the first argument.
 
- $ asciidoctor-pdf 000_basic_example.adoc
+[source, sh]
+----
+asciidoctor-pdf 000_basic_example.adoc
+----
 
-This command is just a shorthand way of running:
+This command is just a *shorthand* way of running:
 
- $ asciidoctor -r asciidoctor-pdf -b pdf 000_basic_example.adoc
+[source, sh]
+----
+asciidoctor -r asciidoctor-pdf -b pdf 000_basic_example.adoc
+----
 
 The `asciidoctor-pdf` command just saves you from having to remember all those
 flags. That's why we created it.
@@ -81,15 +134,14 @@ viewer to see the result.
 
 ifdef::backend-html5[]
 .Example PDF document rendered in a PDF viewer
-image::/assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png[Screenshot of PDF document,width=800,scaledwidth=100%]
+lightbox::images-example--pdf-screenshot[ 1024, {data-images-example--pdf-screenshot}, role="mb-4" ]
 endif::[]
 
 ifdef::backend-pdf[]
 .Example PDF document rendered in a PDF viewer
-image::/assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png[Screenshot of PDF document,width=800,scaledwidth=100%]
+image::/assets/images/pages/asciidoc_skeletons/example-pdf-screenshot.png[PDF document rendered in a PDF viewer, width=800, scaledwidth=100%]
 endif::[]
 
 You're also encouraged to try converting the documents in the examples
-directory to see more of what _Asciidoctor PDF_ can do.
-
-The pain of the DocBook toolchain should be melting away about now.
+directory to see more of what _Asciidoctor PDF_ can do. The pain of the
+DocBook toolchain should be melting away from now.

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/200_themes/211_language_overview.asciidoc

@@ -33,29 +33,29 @@ The theme file must be named _<name>-theme.yml_, where `<name>` is the name
 of the theme. Here's an example of a basic theme file:
 
 .basic-theme.yml
-[source,yaml]
+[source, yaml]
 ----
 page:
-  layout: portrait
-  margin: [0.75in, 1in, 0.75in, 1in]
-  size: Letter
+  layout:             portrait
+  margin:             [0.75in, 1in, 0.75in, 1in]
+  size:               Letter
 base:
-  font_color: #333333
-  font_family: Times-Roman
-  font_size: 12
+  font_color:         '#333333'
+  font_family:        Times-Roman
+  font_size:          12
   line_height_length: 17
-  line_height: $base_line_height_length / $base_font_size
-vertical_spacing: $base_line_height_length
+  line_height:        $base_line_height_length / $base_font_size
+vertical_spacing:     $base_line_height_length
 heading:
-  font_color: #262626
-  font_size: 17
-  font_style: bold
-  line_height: 1.2
-  margin_bottom: $vertical_spacing
+  font_color:         '#262626'
+  font_size:          17
+  font_style:         bold
+  line_height:        1.2
+  margin_bottom:      $vertical_spacing
 link:
-  font_color: #002FA7
+  font_color:         '#002FA7'
 outline_list:
-  indent: $base_font_size * 1.5
+  indent:             $base_font_size * 1.5
 ----
 
 When creating a new theme, you only have to define the keys you want to
@@ -73,8 +73,12 @@ start hacking on it.
 Alternatively, you can snag the file from your local installation using the
 following command:
 
- $ ASCIIDOCTOR_PDF_DIR=`gem contents asciidoctor-pdf --show-install-dir`;\
+[source, sh]
+----
+ASCIIDOCTOR_PDF_DIR=`gem contents asciidoctor-pdf --show-install-dir`; \
    cp "$ASCIIDOCTOR_PDF_DIR/data/themes/default-theme.yml" custom-theme.yml
+----
+
 ====
 
 Keys may be nested to an arbitrary depth to eliminate redundant prefixes (an
@@ -89,33 +93,33 @@ name (e.g., `font_color`) into a single, qualified key (e.g., `link_font_color`)
 For example, let's assume we want to set the base (i.e., global) font size
 and color. These keys may be written longhand:
 
-[source,yaml]
+[source, yaml]
 ----
-base_font_color: #333333
-base_font_family: Times-Roman
-base_font_size: 12
+base_font_color:      '#333333'
+base_font_family:     Times-Roman
+base_font_size:       12
 ----
 
 Or, to avoid having to type the prefix `base_` multiple times, the keys may
 be written hierarchically:
 
-[source,yaml]
+[source, yaml]
 ----
 base:
-  font_color: #333333
-  font_family: Times-Roman
-  font_size: 12
+  font_color:         '#333333'
+  font_family:        Times-Roman
+  font_size:          12
 ----
 
 Or even:
 
-[source,yaml]
+[source, yaml]
 ----
 base:
   font:
-    color: #333333
-    family: Times-Roman
-    size: 12
+    color:            '#333333'
+    family:           Times-Roman
+    size:             12
 ----
 
 Each level of nesting must be indented by two more spaces of indentation than