asciidoctor-dita-topic 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c01d2fe1eed871381b9c7ccac78c70de1b2d3078fee28eab23a4b7ff0a261b
-  data.tar.gz: 39a4e1da5ba838141a929c610060a9a2e8189c292d714028af19dad236cc78bf
+  metadata.gz: 5d8849df85b9b5beff0e0e583464b4e1398ca56fe49b52255dd27a9f072ddf9a
+  data.tar.gz: dff16a2d22920219d867521ed689df99cde217c750394010e5057c10a7b68730
 SHA512:
-  metadata.gz: 87721774c580b3a509ed62189fc31fcca4077bd0007a98234610f497430d3b8c6cf8adc0e71a7d752e672255e043bb2f6f335a28231fe12983772b3c1902dc58
-  data.tar.gz: 7a934f1f00886a4e7e8f512a1cd923b0ade242c8782810e564737075d3d3e5dea80a61c92f215162051c0de2471c9242acf5761555275c6d5f829aca9f5cb28c
+  metadata.gz: 01752f000d44a620eb19726e23a86b2d67eb9fe5559dd1a7949d75af941ce7dfabdb9e7d49aa7342a8c5742984d078149d029062d6778fed9e3b0d21071e926b
+  data.tar.gz: fe84a2ebe09d0376897a9d1858b214c8103519236e4456f66d6496d152cb6d9838f3de14cce5db9576b5aa916a53f1ab956f122ac6e9a591675ebf2acd997302

data/lib/dita-topic.rb

@@ -35,11 +35,17 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Enable floating and block titles by default:
     @titles_allowed = true
+
+    # Enable callouts by default:
+    @callouts_allowed = true
   end
 
   def convert_document node
     # Check if floating and block titles are enabled:
-    @titles_allowed = false if (node.attr 'dita-topic-titles') == 'strict'
+    @titles_allowed = false if (node.attr 'dita-topic-titles') == 'off'
+
+    # Check if callouts are enabled:
+    @callouts_allowed = false if (node.attr 'dita-topic-callouts') == 'off'
 
     # Check if a specific topic type is provided:
     if (value = node.attr 'dita-topic-type') =~ /^(concept|reference|task)$/
@@ -90,12 +96,55 @@ class DitaTopic < Asciidoctor::Converter::Base
     return ''
   end
 
-  # FIXME: Figure out how to handle this along with convert_inline_callout.
-  # A definition list looks like a reasonable option.
   def convert_colist node
-    # Issue a warning if a callout list is present:
-    logger.warn "#{NAME}: Callout list support not implemented"
-    return ''
+    # Issue a warning if callouts are disabled:
+    unless @callouts_allowed
+      logger.warn "#{NAME}: Callouts not supported in DITA"
+      return ''
+    end
+
+    # Reset the counter:
+    number = 0
+
+    # Open the table:
+    result = ['<table>']
+    result << %(<tgroup cols="2">)
+    result << %(<colspec colwidth="#{node.attr 'labelwidth', 15}*" />)
+    result << %(<colspec colwidth="#{node.attr 'itemwidth', 85}*" />)
+    result << %(<tbody>)
+
+    # Process individual list items:
+    node.items.each do |item|
+      # Increment the counter:
+      number += 1
+
+      # Open the table row:
+      result << %(<row>)
+
+      # Compose the callout number:
+      result << %(<entry>#{compose_circled_number number}</entry>)
+
+      # Check if description contains multiple block elements:
+      if item.blocks
+        result << %(<entry>)
+        result << %(<p>#{item.text}</p>)
+        result << item.content
+        result << %(</entry>)
+      else
+        result << %(<entry>#{item.text}</entry>)
+      end
+
+      # Close the row:
+      result << %(</row>)
+    end
+
+    # Close the table:
+    result << %(</tbody>)
+    result << %(</tgroup>)
+    result << %(</table>)
+
+    # Return the XML output:
+    result.join LF
   end
 
   def convert_dlist node
@@ -163,21 +212,25 @@ class DitaTopic < Asciidoctor::Converter::Base
     %(<p outputclass="title sect#{node.level}"><b>#{node.title}</b></p>)
   end
 
-  # FIXME: Add support for additional attributes.
-  def convert_image node
+  def convert_image(node)
+    # Check if additional attributes are specified:
+    width  = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : ''
+    height = (node.attr? 'height') ? %( height="#{node.attr 'height'}") : ''
+    scale  = (node.attr? 'scale') ? %( scale="#{(node.attr 'scale').tr('%', '')}") : ''
+
     # Check if the image has a title specified:
     if node.title?
       <<~EOF.chomp
       <fig>
       <title>#{node.title}</title>
-      <image href="#{node.image_uri(node.attr 'target')}" placement="break">
+      <image href="#{node.image_uri(node.attr 'target')}"#{width}#{height}#{scale} placement="break">
       <alt>#{node.alt}</alt>
       </image>
       </fig>
       EOF
     else
       <<~EOF.chomp
-      <image href="#{node.image_uri(node.attr 'target')}" placement="break">
+      <image href="#{node.image_uri(node.attr 'target')}"#{width}#{height}#{scale} placement="break">
       <alt>#{node.alt}</alt>
       </image>
       EOF
@@ -250,9 +303,14 @@ class DitaTopic < Asciidoctor::Converter::Base
   end
 
   def convert_inline_callout node
-    # Issue a warning if an inline callout is present:
-    logger.warn "#{NAME}: Inline callout support not implemented"
-    return ''
+    # Issue a warning if callouts are disabled:
+    unless @callouts_allowed
+      logger.warn "#{NAME}: Callouts not supported in DITA"
+      return ''
+    end
+
+    # Return the XML entity:
+    compose_circled_number node.text.to_i
   end
 
   # FIXME: Add support for footnoteref equivalent.
@@ -260,9 +318,13 @@ class DitaTopic < Asciidoctor::Converter::Base
     %(<fn>#{node.text}</fn>)
   end
 
-  # FIXME: Add support for additional attributes.
   def convert_inline_image node
-    %(<image href="#{node.image_uri node.target}" placement="inline"><alt>#{node.alt}</alt></image>)
+    # Check if additional attributes are specified:
+    width  = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : ''
+    height = (node.attr? 'height') ? %( height="#{node.attr 'height'}") : ''
+
+    # Return the XML output:
+    %(<image href="#{node.image_uri node.target}"#{width}#{height} placement="inline"><alt>#{node.alt}</alt></image>)
   end
 
   def convert_inline_indexterm node
@@ -504,12 +566,12 @@ class DitaTopic < Asciidoctor::Converter::Base
       # Process each row:
       rows.each do |row|
         # Open the row:
-        result <<%(<row>)
+        result << %(<row>)
 
         # Process each cell:
         row.each do |cell|
           # Check if the cell spans multiple columns:
-          colspan = cell.colspan ? %( namest="col_#{colnum = cell.column.attr 'colnumber'}" nameend="col_#{column + cell.colspan - 1}") : ''
+          colspan = cell.colspan ? %( namest="col_#{colnum = cell.column.attr 'colnumber'}" nameend="col_#{colnum + cell.colspan - 1}") : ''
 
           # Check if the cell spans multiple rows:
           rowspan = cell.rowspan ? %( morerows="#{cell.rowspan - 1}") : ''
@@ -537,7 +599,7 @@ class DitaTopic < Asciidoctor::Converter::Base
         end
 
         # Close the row:
-        result <<%(</row>)
+        result << %(</row>)
       end
 
       # Close the section:
@@ -648,13 +710,9 @@ class DitaTopic < Asciidoctor::Converter::Base
   def compose_horizontal_dlist node
     # Open the table:
     result = ['<table>']
-
-    # Define the table properties and open the tgroup:
     result << %(<tgroup cols="2">)
     result << %(<colspec colwidth="#{node.attr 'labelwidth', 15}*" />)
     result << %(<colspec colwidth="#{node.attr 'itemwidth', 85}*" />)
-
-    # Open the table body:
     result << %(<tbody>)
 
     # Process individual list items:
@@ -700,6 +758,12 @@ class DitaTopic < Asciidoctor::Converter::Base
     add_block_title (result.join LF), node.title, 'horizontal'
   end
 
+  # Method aliases
+
+  alias convert_embedded content_only
+  alias convert_pass content_only
+  alias convert_toc skip
+
   # Helper methods
 
   def add_block_title content, title, context='wrapper'
@@ -746,5 +810,22 @@ class DitaTopic < Asciidoctor::Converter::Base
   def compose_id id
     id ? %( id="#{id}") : ''
   end
+
+  def compose_circled_number number
+    # Verify the number is in a supported range:
+    if number < 1 || number > 50
+      logger.warn "#{NAME}: Callout number not in range between 1 and 50"
+      return number
+    end
+
+    # Compose the XML entity:
+    if number < 21
+      %(&##{9311 + number};)
+    elsif number < 36
+      %(&##{12860 + number};)
+    else
+      %(&##{12941 + number};)
+    end
+  end
 end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Jaromir Hradilek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,6 +30,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.22.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.6
 description: An extension for AsciiDoctor that converts a single AsciiDoc file to
   a DITA topic.
 email: jhradilek@gmail.com
@@ -44,6 +86,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jhradilek/asciidoctor-dita-topic
   bug_tracker_uri: https://github.com/jhradilek/asciidoctor-dita-topic/issues
+  documentation_uri: https://github.com/jhradilek/asciidoctor-dita-topic/blob/main/README.adoc
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -59,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A custom AsciiDoc converter that generates individual DITA topics