asciidoctor-autoterm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9aa205a2201907e6e79efdf5e15b67116c0fe00c074927580f305487a930e817
+  data.tar.gz: 73962f910b8e86becb9233012a7507d914e50508413567edd3896f59d1c95028
+SHA512:
+  metadata.gz: 1c708dde292c21e8149e81029ac501ebb53ea9da26c0aa159de5c4271360b01fefa00a1ca307b0588bd64c702e84135bd3e002ee7b3a6666bd79c2e24f22c000
+  data.tar.gz: 8453acb552ee6b80382c0f95b48645eb1347b45203612efd766b60fcf138588ab32dca730b7d831a5832b0ff662ea147bde3e9e5d8b8473453baa04c0d7e5b29

data/lib/asciidoctor/autoterm/antora_processor.rb

@@ -0,0 +1,19 @@
+Asciidoctor::Extensions.register do
+  tree_processor do
+    process do |doc|
+      if doc.attributes['include-terminology'] == 'true'
+        if (last_section = doc.sections.last)
+          terminology_section = create_section last_section.parent, 'Terminology', { 'style' => 'index', 'type' => 'terminology' }
+          terminology_section.parent << terminology_section
+        end
+      end
+      if doc.attributes['include-index'] == 'true'
+        if (last_section = doc.sections.last)
+          index_section = create_section last_section.parent, 'Index', { 'style' => 'index' }
+          index_section.parent << index_section
+        end
+      end
+      doc
+    end
+  end
+end

data/lib/asciidoctor/autoterm/converter.rb

@@ -0,0 +1,141 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+class TermIndex < Asciidoctor::Converter.for('pdf')
+  register_for 'pdf'
+
+  def convert_index_section(node)
+    if node.attributes['type'] == 'terminology'
+      use_custom_definitions = node.document.attr('terminology-use-definitions', 'false').to_s.downcase != 'false'
+      terminology = use_custom_definitions ? parse_terminology_from_ast(node.document) : {}
+      terms_by_full_name_with_abbr_and_definition = collect_terms(terminology)
+
+      convert_terminology_entries(terms_by_full_name_with_abbr_and_definition) unless terms_by_full_name_with_abbr_and_definition.empty?
+      nil
+    else
+      super
+    end
+  end
+
+  def convert_terminology_entries(terms_by_full_name_with_abbr_and_definition)
+    sorted_terms = terms_by_full_name_with_abbr_and_definition.sort_by do |full_term, details|
+      abbr = details[:abbr]
+      (abbr.nil_or_empty? ? full_term : abbr).downcase
+    end
+
+    grouped_terms = sorted_terms.group_by { |full_term, _details| full_term[0].upcase }
+    sorted_letters = grouped_terms.keys.sort
+
+    line_metrics = calc_line_metrics @base_line_height
+    space_needed_for_letter = @theme.description_list_term_spacing + (2 * (height_of_typeset_text 'A'))
+
+    sorted_letters.each do |letter|
+      bounds.move_past_bottom if space_needed_for_letter > cursor
+
+      ink_prose letter,
+        align: :left,
+        inline_format: false,
+        margin_bottom: @theme.description_list_term_spacing,
+        style: :bold
+
+      grouped_terms[letter].each do |full_term, details|
+        abbreviation = details[:abbr]
+        definition = details[:definition]
+
+        if abbreviation
+          term_text = abbreviation
+          desc_text = full_term
+          desc_text += " – #{definition}" unless definition.nil_or_empty?
+        else
+          term_text = full_term
+          desc_text = definition || ''
+        end
+
+        entry_height = height_of_typeset_text term_text
+        bounds.move_past_bottom if entry_height > cursor
+
+        term_width = bounds.width * 0.15
+        start_cursor = cursor
+
+        float do
+          indent 0 do
+            typeset_formatted_text [{ text: term_text, color: @font_color }], line_metrics, align: :left
+          end
+        end
+
+        indent term_width do
+          typeset_formatted_text [{ text: desc_text, color: @font_color }], line_metrics, align: :left
+        end
+
+        move_down 4.24
+      end
+
+      @theme.prose_margin_bottom > cursor ? bounds.move_past_bottom : (move_down @theme.prose_margin_bottom)
+    end
+
+    start_new_page unless at_page_top?
+  end
+
+  def parse_terminology_from_ast(document)
+    terminology = {}
+
+    terminology_tables = document.find_by do |block|
+      block.context == :table && block.has_role?('terminology')
+    end
+
+    if terminology_tables.any?
+      first_table = terminology_tables.first
+      if first_table.rows && first_table.rows.body
+        first_table.rows.body.each do |row|
+          full_term = row[0].text.strip
+          definition = row[2].text.strip
+
+          if full_term && definition
+            terminology[full_term] = { definition: definition }
+          else
+            log :warn, %(Skipping invalid row with missing data: #{row.inspect})
+          end
+        end
+      else
+        log :warn, %(No rows found in the table with .terminology role.)
+      end
+    else
+      log :info, %(No tables with .terminology role found in the document.)
+    end
+
+    terminology
+  end
+
+  def collect_terms(terminology)
+    terms_by_full_name_with_abbr_and_definition = {}
+    terminology_present = !terminology.empty?
+
+    @index.categories.each do |category|
+      category.terms.each do |term_obj|
+        term_name = term_obj.name
+
+        if term_name =~ /(.*?)\s+\((.*?)\)/
+          full_name = $1.strip
+          abbr = $2.strip
+        else
+          full_name = term_name
+          abbr = nil
+        end
+
+        definition_entry = terminology[full_name]
+        definition = definition_entry ? definition_entry[:definition] : nil
+
+        if abbr.nil? && (!terminology_present || definition.nil_or_empty?)
+          next
+        end
+
+        terms_by_full_name_with_abbr_and_definition[full_name] = {
+          abbr: abbr,
+          definition: definition
+        }
+      end
+    end
+
+    terms_by_full_name_with_abbr_and_definition
+  end
+end

data/lib/asciidoctor/autoterm/table_roles.rb

@@ -0,0 +1,21 @@
+# https://docs.asciidoctor.org/pdf-converter/latest/extend/use-cases/#theme-table-using-roles
+
+class PDFConverterTableRole < (Asciidoctor::Converter.for 'pdf')
+  register_for 'pdf'
+
+  def convert_table node
+    if node.role?
+      key_prefix = %(role_<table>_#{node.roles[0]}_)
+      unless (role_entries = theme.each_pair.select {|name, val| name.to_s.start_with? key_prefix }).empty?
+        save_theme do
+          role_entries.each do |name, val|
+            theme[%(table_#{name.to_s.delete_prefix key_prefix})] = val
+          end
+          super
+        end
+        return
+      end
+    end
+    super
+  end
+end

data/lib/asciidoctor/autoterm/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module Autoterm
+    VERSION = '1.0.0'
+  end
+end

data/lib/asciidoctor-autoterm.rb

@@ -0,0 +1,4 @@
+require_relative 'asciidoctor/autoterm/version'
+require_relative 'asciidoctor/autoterm/table_roles'
+require_relative 'asciidoctor/autoterm/converter'
+require_relative 'asciidoctor/autoterm/antora_processor'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-autoterm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- baiyibai
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Generates a Terminology section from AsciiDoc index term markup for Asciidoctor
+  PDF documents, with support for abbreviations and optional external definitions.
+email:
+- claude@baiyibai.cyou
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/asciidoctor-autoterm.rb
+- lib/asciidoctor/autoterm/antora_processor.rb
+- lib/asciidoctor/autoterm/converter.rb
+- lib/asciidoctor/autoterm/table_roles.rb
+- lib/asciidoctor/autoterm/version.rb
+homepage: https://gitlab.com/baiyibai-asciidoc/antora-asciidoc-autoterm
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Automatic terminology generator for Asciidoctor PDF
+test_files: []