asciidoctor-dita-topic 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 687ae8806b7e15e26af816a9c422c4eb9f6d641952d3322ecec1a548e3818b27
-  data.tar.gz: 1831689de933e1fb931b156f4a9d7333e4200597ac352caf8a83345b819b120e
+  metadata.gz: 26ce0f384369b685c43454ec161ac81cdd99c630c85bef52d16e0cff55423166
+  data.tar.gz: ba0257aa9f21b1f958e07103ecc9c7bd5476bf02038c0110feeb8c8c0fc36731
 SHA512:
-  metadata.gz: c41f5028246471fd6f82eced7c21d15bcef16dadf480a29dc51a5089b60d0c1b8987198ae5d7bf615f377e230b736563f576fad179897bc7e0e3b95324880a1d
-  data.tar.gz: 4ab12c7fbeeb054aa08200b9c1a16163459d9a0c9bd3852a7fc348ae8943e73a4872ff1e26a634b171aaa46e2cb916d11d9b65f9c53f5f4df2b5e4a781345198
+  metadata.gz: bf9814f61b806557250d29b32cf5ae640cf4345a9e5657a856ce4173de9cbdbc1a2a89a4295a528a82d073f4ccae11a3b321e00902531ed9c18256f8dd6472f9
+  data.tar.gz: c0693f56fccd42fdc39813a676ca5475670bd7aa5e4a3a5ecb71d45e140d2bfb8861bc093fa6334af3bb4c1f20fafc143237f03557fda52f816a9b055b0b4459

data/README.adoc

@@ -1,6 +1,6 @@
 = dita-topic
 
-`dita-topic` is a custom converter for Asciidoctor that converts a single AsciiDoc file to a corresponding DITA topic. To convert the produced DITA topic to a specialized DITA concept, reference, or task, use the link:https://github.com/jhradilek/dita-custom-xslt[dita_convert Python package].
+`dita-topic` is a custom converter for Asciidoctor that converts a single AsciiDoc file to a corresponding DITA topic. To convert the produced DITA topic to a specialized DITA concept, reference, or task, use the link:https://github.com/jhradilek/dita-custom-xslt#installation[dita-convert Python package].
 
 [#install]
 == Installation
@@ -121,6 +121,18 @@ To disable this behavior, set the value of the `dita-topic-callouts` to `off`:
 $ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-callouts=off _your_file_.adoc**
 ....
 
+[#abstracts]
+=== Disable abstracts
+
+By default, the `dita-topic` converter recognizes a paragraph preceded by the `[role="_abstract"]` attribute list and preserves this information by adding the `outputclass="abstract"` attribute to it in DITA. The link:https://github.com/jhradilek/dita-custom-xslt#installation[dita-convert Python package] uses this attribute to populate the `<shortdesc>` element during conversion to a specialized DITA concept, reference, or task.
+
+To disable this behavior, set the value of the `dita-topic-abstracts` to `off`:
+
+[literal,subs="+quotes"]
+....
+$ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-abstracts=off _your_file_.adoc**
+....
+
 [#includes]
 === Disabling include directives
 

data/lib/dita-topic.rb

@@ -36,6 +36,9 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Disable the author line by default:
     @authors_allowed = false
 
+    # Enable abstract paragraphs by default:
+    @abstracts_allowed = true
+
     # Enable callouts by default:
     @callouts_allowed = true
 
@@ -47,14 +50,20 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if the author line is enabled:
     @authors_allowed = true if (node.attr 'dita-topic-authors') == 'on'
 
+    # Check if abstract paragraphs are enabled:
+    @abstracts_allowed = false if (node.attr 'dita-topic-abstracts') == 'off'
+
     # Check if callouts are enabled:
     @callouts_allowed = false if (node.attr 'dita-topic-callouts') == 'off'
 
     # Check if floating and block titles are enabled:
     @titles_allowed = false if (node.attr 'dita-topic-titles') == 'off'
 
-    # Check if the modular documentation content type is specified:
+    # Check if the modular documentation content type is specified; both
+    # _module-type and _content-type are deprecated, but still present in
+    # some modules:
     outputclass = ''
+    outputclass = %( outputclass="#{(node.attr '_module-type').downcase}") if node.attr? '_module-type'
     outputclass = %( outputclass="#{(node.attr '_content-type').downcase}") if node.attr? '_content-type'
     outputclass = %( outputclass="#{(node.attr '_mod-docs-content-type').downcase}") if node.attr? '_mod-docs-content-type'
 
@@ -133,42 +142,36 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Reset the counter:
     number = 0
 
-    # Open the table:
-    result = ['<table outputclass="callout-list">']
-    result << %(<tgroup cols="2">)
-    result << %(<colspec colwidth="15*" />)
-    result << %(<colspec colwidth="85*" />)
-    result << %(<tbody>)
+    # Open the definition list:
+    result = ['<dl outputclass="callout-list">']
 
     # Process individual list items:
     node.items.each do |item|
       # Increment the counter:
       number += 1
 
-      # Open the table row:
-      result << %(<row>)
+      # Open the definition entry:
+      result << %(<dlentry>)
 
       # Compose the callout number:
-      result << %(<entry>#{compose_circled_number number}</entry>)
+      result << %(<dt>#{compose_circled_number number}</dt>)
 
       # Check if description contains multiple block elements:
       if item.blocks
-        result << %(<entry>)
-        result << %(<p>#{item.text}</p>)
+        result << %(<dd>)
+        result << item.text
         result << item.content
-        result << %(</entry>)
+        result << %(</dd>)
       else
         result << %(<entry>#{item.text}</entry>)
       end
 
-      # Close the row:
-      result << %(</row>)
+      # Close the definition entry:
+      result << %(</dlentry>)
     end
 
-    # Close the table:
-    result << %(</tbody>)
-    result << %(</tgroup>)
-    result << %(</table>)
+    # Close the definition list:
+    result << %(</dl>)
 
     # Return the XML output:
     result.join LF
@@ -239,12 +242,16 @@ class DitaTopic < Asciidoctor::Converter::Base
     %(<p outputclass="title sect#{node.level}"><b>#{node.title}</b></p>)
   end
 
-  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('%', '')}") : ''
 
+    # Exclude width and height attributes with percentage values:
+    width   = '' if width.include? '%'
+    height  = '' if height.include? '%'
+
     # Check if the image has a title specified:
     if node.title?
       <<~EOF.chomp
@@ -356,6 +363,10 @@ class DitaTopic < Asciidoctor::Converter::Base
     width  = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : ''
     height = (node.attr? 'height') ? %( height="#{node.attr 'height'}") : ''
 
+    # Exclude width and height attributes with percentage values:
+    width   = '' if width.include? '%'
+    height  = '' if height.include? '%'
+
     # Return the XML output:
     %(<image href="#{node.image_uri node.target}"#{width}#{height} placement="inline"><alt>#{node.alt}</alt></image>)
   end
@@ -460,8 +471,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     node.items.each do |item|
       # Check if the list item contains multiple block elements:
       if item.blocks?
-        result << %(<li>)
-        result << %(<p>#{item.text}</p>)
+        result << %(<li>#{item.text})
         result << item.content
         result << %(</li>)
       else
@@ -507,7 +517,11 @@ class DitaTopic < Asciidoctor::Converter::Base
   end
 
   def convert_paragraph node
-    add_block_title %(<p>#{node.content}</p>), node.title
+    if @abstracts_allowed and (node.attr 'role') == '_abstract'
+      add_block_title %(<p outputclass="abstract">#{node.content}</p>), node.title
+    else
+      add_block_title %(<p>#{node.content}</p>), node.title
+    end
   end
 
   def convert_preamble node
@@ -691,8 +705,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
       # Check if the list item contains multiple block elements:
       if item.blocks?
-        result << %(<li>)
-        result << %(<p>#{check_box}#{item.text}</p>)
+        result << %(<li>#{check_box}#{item.text})
         result << item.content
         result << %(</li>)
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Jaromir Hradilek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-17 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor