asciidoctor-autoterm 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcc5c6113c38d85b30990827bb540723c544fca19945081ed308c27ba1a2e7ef
-  data.tar.gz: cf29b08297c9ddcfbd6c3bd28513dd9264c6d35671ca032ff9cf9a675a0250a9
+  metadata.gz: ff2906959fee00ea8375d7f8ba6b777a5f524466753beab968387fae811f2673
+  data.tar.gz: d85a73b2d50ce110117e4b10872cceb89db5eb08b5113526ff84a71114fa363a
 SHA512:
-  metadata.gz: 8808d90bc9f42c396a2d61fb5d0f5c92d48d378f00b304366a20045865f3fd375beb9c43111ed8816bdf670f8ee3a9d74184373284ae22f4d345545b9e341a15
-  data.tar.gz: 1f13bed6c62613fc01bc66b9c65f67deea1e72721415eefdee58fa054eec8278f8c1a1afb9f6f121b7397ebebc5dd9fa4ccf5e226f2656a64d29b391b4c49078
+  metadata.gz: 83a18e1ea2cf1256fbdd41e79229ada3b3cc7bd5e51e08a5872f9542a25872a059d24b5e10f545eea3fbaddbdf2982ea41b517a2ea733e3e9dae6ea6266ac0ef
+  data.tar.gz: 282d1fd97e08e9dfcaba3b9f0b061fdedeac8e5eebdf0c3780330a129440c367b9c90941f664a40418f6535c0b78dca1b9e1a8f90c334ced7795c35c058e256e

data/CHANGELOG.adoc

@@ -0,0 +1,23 @@
+// REMINDER: After changing this file, copy it to doc/modules/ROOT/pages/changelog.adoc so the published documentation stays in sync. Antora cannot include files that live outside the doc/ component.
+= Changelog
+
+All notable changes to `asciidoctor-autoterm` are documented here.
+
+== 1.0.3 (2026-07-15)
+
+* Ship LICENSE, README.adoc, and CHANGELOG.adoc in the gem; earlier gems contained only the `lib/` sources despite the gemspec declaring the MIT license
+* No code changes
+
+== 1.0.2 (2026-06-08)
+
+* Repair index paren truncation: AsciiDoc stores `((Full Term (Abbr)))` as "Full Term (Abbr" because the parser matches the first `))`. `repair_index_term_parens` now restores the missing `)` in the regular Index section by appending it to any term name that ends with an unclosed `(`
+* Remove phantom Terminology and Index entries produced by documentation examples: backtick spans do not prevent indexterm processing in asciidoctor-pdf, so live `((indexterm))` examples in index.adoc were indexed; examples now use `+...+` inline passthrough
+* Fix a duplicate CSS entry caused by "Cascading Style Sheets" (plural) diverging from the singular form used in the terminology table
+
+== 1.0.1 (2026-06-08)
+
+* Fix `collect_terms` dropping every term with an abbreviation: the `((Full Term (Abbr)))` syntax matches the first `))`, storing the term without a closing `)`, but the previous regex required one; the trailing `)` is now optional
+
+== 1.0.0 (2026-06-07)
+
+* Initial gem release: gemspec and `lib/` layout (`table_roles`, `converter`, `antora_processor`), with rewritten installation documentation and an inline index term demonstration

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 白一百 baiyibai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.adoc

@@ -0,0 +1,91 @@
+= Antora Asciidoctor Automatic Terminology Generator Extension
+
+This extension automatically generates a _Terminology_ section for Asciidoctor-PDF documents using Asciidoctor's built-in https://docs.asciidoctor.org/asciidoc/latest/sections/user-index/[Index] feature.
+
+https://baiyibai-antora.gitlab.io
+
+This extension achieves three main goals:
+
+. To ensure abbreviations are used consistently throughout documentation using the indexterm markup. +
+This encourages authors to fully spell out a term on the first instance, and then use an abbreviated term in subsequent instances.
+. Eliminate manual work.
+. [Optional] Provide additional externally-curated, and centrally-maintained, definitions via a table with the `.terminology` role in the document AST.
+
+[#section-asciidoctor-pdf-standalone-usage-instructions]
+== Asciidoctor-PDF Standalone Usage Instructions
+
+Complete these steps to use this extension:
+
+. Clone this repository, or acquire the `autogen-terminology.rb` and `add-table-roles.rb` files along with the `pdf-themes/table-roles-theme.yml` file.
+. Create an Asciidoctor document using the index terms.
+. Include a table with the `.terminology` role containing definitions. +
+See xref:terminology-definitions.adoc[] for an example of the markup. +
+The table should be included in your document using the `include` directive with tags:
++
+[source,asciidoc]
+----
+include::terminology-definitions.adoc[tags=terminology]
+----
++
+To control whether custom definitions are used, set the document attribute:
++
+[source,asciidoc]
+----
+:terminology-use-definitions: true
+----
++
+[NOTE]
+====
+- When custom terminology definitions are disabled (`:terminology-use-definitions: false` or not set), only index terms with abbreviations in parentheses (e.g., `((Application Programming Interface (API)))`) are included in the terminology section.
+- When enabled (`:terminology-use-definitions: true`), the table with `.terminology` role will be parsed from the AST and hidden from the rendered output using the table role extension and theme.
+- The `:terminology-use-definitions:` attribute defaults to `false` if not specified.
+====
++
+. [[add-two-sections, Add Two Sections]][Asciidoctor-PDF Users] Create two sections at the end of the document, assigning one the `[type=terminology]` block attribute:
++
+[source]
+----
+include::antora-asciidoctor-autoterm.adoc[tag=auto-terminology-markup]
+----
++
+[NOTE]
+The title of the sections is not fixed.
++
+. Copy the `pdf-themes/table-roles-theme.yml` file or create a theme that hides tables with the `.terminology` role.
+. Render the document with this command:
++
+[source,bash]
+----
+asciidoctor-pdf -r ./add-table-roles.rb -r ./autogen-terminology.rb \
+  -a pdf-theme=table-roles -a pdf-themesdir=pdf-themes \
+  antora-asciidoctor-autoterm.adoc
+----
+
+== Antora Assembler w/Asciidoctor-PDF Usage Instructions
+
+Antora Assembler users require an additional extension to add the Terminology and the Index, complete these steps:
+
+. Complete the steps in <<section-asciidoctor-pdf-standalone-usage-instructions>> until  <<add-two-sections>>. +
+Skip that step and instead add the file xref:antora-assembler-add-terminology-and-index.rb[] to execution directory.
+.. To remove section numbering, uncomment out the specified lines.
+. Add `-r add-table-roles.rb`, `-r antora-assembler-add-terminology-and-index.rb`, and `-r autogen-terminology.rb` to the `antora-assembler.yml`'s `build/command` section, or use `require_relative` for each file.
+. Add the PDF theme attributes: `-a pdf-theme=table-roles -a pdf-themesdir=pdf-themes` (adjust paths as needed)
+. Add two document attributes to either the `antora.yml` or `antora-assembler.yml` file:
++
+** `include-terminology: true`
+** `include-index: true` 
++
+[NOTE]
+====
+Enable/disable those attributes as desired.
+====
++
+. Render the Antora project. 
+
+=== Antora Assembler Background
+
+More information on using the Index with Antora Assembler is available at these links:
+
+* https://antora.zulipchat.com/#narrow/channel/282400-users/topic/Possible.20to.20have.20a.20site-wide.20catchword.20index/near/446306647[^] 
+* https://gitlab.com/antora/antora-assembler/-/issues/51[^]
+

data/lib/asciidoctor/autoterm/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Autoterm
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-autoterm
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - baiyibai
@@ -45,6 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
 - lib/asciidoctor-autoterm.rb
 - lib/asciidoctor/autoterm/antora_processor.rb
 - lib/asciidoctor/autoterm/converter.rb