asciidoctor-dita-topic 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 134df897545adafba05f060ea22079c3fa927204b47fff2eec8ffbc8ae5ef84a
-  data.tar.gz: 354b8abadd320b9a4c63b3c170a85974a2231836da07851e1cde58da06aafff3
+  metadata.gz: 172e330842b5b5f390c287fd0adfe4e51a055c669145c09a0a4b07d7a85057ba
+  data.tar.gz: 3e76bd3a36ed2954827156500d393ac982506862395fbceb30b84c075db95e72
 SHA512:
-  metadata.gz: 4b7e9fcd688f450a2e05effca4c30d5969db15d7056cd23b6c1829d6f65de79cc95e0208f5dc543b5bd2f87117aa972f49dcff76963ef8b67879f5a40a97af6f
-  data.tar.gz: 05122aac651d614082cc4cb350197bdbb897d2b7436189eb225a230ffc3f8ad2f3ee5d66f1b882f78bab39d4fd38d18caaeba0d1b5dd965c98ccd7f52a530f97
+  metadata.gz: 4f5cc15df1b03d9198a87d9996859b067a957928375a6469c8901c3850d76dc0f06f5f3e9e3ff9eb86a8f369c55bf9d7c9a9074e2937ff5798b7b9157bb4a428
+  data.tar.gz: 2986bb1e278b253df0d1d0768d695e8799191253f3527c58f8ef027159ce237e7a09e517dfa78d6cc1043d0c437ff09866848c6ddbe8db7cbb7781806c342252

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'
 
@@ -278,20 +287,26 @@ class DitaTopic < Asciidoctor::Converter::Base
       # I do not want to process them from this script, I choose to issue a
       # warning so that the user can resolve the problem.
 
-      # Determine whether the cross reference links to a file path or an ID:
+      # Determine whether the cross reference links to a file path:
       if (path = node.attributes['path'])
         # Issue a warning if the cross reference includes an ID:
         logger.warn "#{NAME}: Possible invalid reference: #{node.target}" if node.target.include? '#'
 
         # Compose a cross reference:
-        %(<xref href="#{node.target}">#{node.text || path}</xref>)
-      else
-        # Issue a warning as the cross reference is unlikely to work:
-        logger.warn "#{NAME}: Possible invalid reference: #{node.target}"
+        return %(<xref href="#{node.target}">#{node.text || path}</xref>)
+      end
 
+      # Determine whether the ID reference target is in this document:
+      if node.document.catalog[:refs].key? (target = node.target.delete_prefix '#')
         # Compose the cross reference:
-        node.text ? %(<xref href="#{node.target}">#{node.text}</xref>) : %(<xref href="#{node.target}" />)
+        return node.text ? %(<xref href="#./#{target}">#{node.text}</xref>) : %(<xref href="#./#{target}" />)
       end
+
+      # Issue a warning as the cross reference is unlikely to work:
+      logger.warn "#{NAME}: Possible invalid reference: #{node.target}"
+
+      # Compose the cross reference:
+      node.text ? %(<xref href="#{node.target}">#{node.text}</xref>) : %(<xref href="#{node.target}" />)
     when :ref
       # NOTE: DITA does not have a dedicated element for inline anchors or
       # a direct equivalent of the <span> element from HTML. The solution
@@ -454,8 +469,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
@@ -501,7 +515,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
@@ -685,8 +703,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.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Jaromir Hradilek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor