asciidoctor-dita-topic 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b3a4a2065dec2230fd5c554325dc804cc37b69a95caa246ff3dbf43c5ecd9d
-  data.tar.gz: 57a4b6a9275e71b8388d4cadb10e99a25d566ba106871fc02f2c965f4fd042b7
+  metadata.gz: 4800181685253324c6e93aa8be4011212e700a94ef82e6489b2980f3b6361cf2
+  data.tar.gz: e3f39557c7dc47af05889e99546369448c3ef4b4af53a233c0beb3d8b5d48705
 SHA512:
-  metadata.gz: 5ed40b0ee61e31a1d03880b3bcbd20c831dff0e9204acd7b7e334ea3d22dde069fd8e7e2fae737e06e59a86d948e905ec698b381d5709a500284d6bdf31ab903
-  data.tar.gz: 7387aa7846f42eb746e0f37b2484052f259f2e64aa4578fee5fb9bacb3563b49020279ff0c8cafb1f6dbad8831b66ff1aba0b388b1d4f889f2ba8522e206a6aa
+  metadata.gz: 691af18c68f264cc32b5a1a01ad3f220a0bbda0258333be153d36f2de15559da8b1bb7184a9046ef1b53c37a366f3e25fa5aecbfcba4882445c9b4238be0238b
+  data.tar.gz: f366e45753bba7d68146839ba1e55b6d480588aab356fff072cba5093b52554b4f56667e347f3497fa12683927c4c2ea6995f94695f30b9ccf46d73a5a4567ed

data/README.adoc

@@ -1,6 +1,29 @@
 = 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#installation[dita-convert Python package].
+`dita-topic` is a custom converter for Asciidoctor that converts a single AsciiDoc file to a corresponding DITA 1.3 topic.
+
+In combination with link:https://github.com/jhradilek/asciidoctor-dita-vale[asciidoctor-dita-vale] and link:https://github.com/jhradilek/dita-custom-xslt#installation[dita-convert], this project can be used to rapidly convert AsciiDoc content to DITA:
+
+. Identify incompatible markup in the AsciiDoc source file:
++
+[literal,subs="+quotes"]
+....
+$ *vale source_file.adoc*
+....
+
+. Convert the AsciiDoc file to a generic DITA topic:
++
+[literal,subs="+quotes"]
+....
+$ *asciidoctor -r dita-topic -b dita-topic source_file.adoc*
+....
+
+. Convert the generic DITA topic to a specialized DITA concept, reference, or task:
++
+[literal,subs="+quotes"]
+....
+$ *dita-convert -gt task source_file.dita*
+....
 
 [#install]
 == Installation
@@ -178,6 +201,8 @@ Page breaks not supported in DITA:: AsciiDoc allows you to use `<<<` on a separa
 
 Possible invalid reference: _reference_:: AsciiDoc allows you to cross reference by using an ID no matter if this ID is defined within or outside of the converted document. Unlike AsciiDoc, DITA requires both the target ID and the ID of the target topic to be included in the cross reference if the reference leads outside of the current file. As `dita-topic` is meant to be run on individual AsciiDoc files, it does not have access to information from referenced files during conversion. `dita-topic` issues this warning whenever the cross reference target is not present in the converted AsciiDoc file.
 
+Sidebars not supported in DITA:: AsciiDoc allows you to assign any block the `[sidebar]` block style or enclose it between a pair of `\****` to create a delimited sidebar block. Unlike AsciiDoc, DITA does not support sidebar blocks. `dita-topic` issues this warning when the `-a dita-topic-sidebars=off` option is specified and a sidebar block is present in the converted AsciiDoc file.
+
 STEM support not implemented:: AsciiDoc provides multiple ways to insert Science, Technology, Engineering and Math (STEM) expressions in the document, including the `\stem:[_formula_]` inline macro and the `[stem]` delimited block. `dita-topic` does not implement this feature and issues this warning whenever such an expression is present in the converted AsciiDoc file.
 
 Table footers not supported in DITA:: AsciiDoc allows you to set the `footer` option to mark the last table row as a table footer. Unlike AsciiDoc, DITA does not support table footers. `dita-topic` issues this warning whenever a table footer is present in the converted AsciiDoc file.

data/lib/dita-topic.rb

@@ -46,6 +46,9 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Enable floating and block titles by default:
     @titles_allowed = true
+
+    # Enable sidebars by default:
+    @sidebars_allowed = true
   end
 
   def convert_document node
@@ -61,6 +64,9 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if floating and block titles are enabled:
     @titles_allowed = false if (node.attr 'dita-topic-titles') == 'off'
 
+    # Check if sidebars are enabled:
+    @sidebars_allowed = false if (node.attr 'dita-topic-sidebars') == 'off'
+
     # Check if the modular documentation content type is specified; both
     # _module-type and _content-type are deprecated, but still present in
     # some modules:
@@ -447,6 +453,18 @@ class DitaTopic < Asciidoctor::Converter::Base
       %(&#8220;#{node.text}&#8221;)
     when :single
       %(&#8216;#{node.text}&#8217;)
+    when :asciimath
+      # Issue a warning if a STEM content is present:
+      logger.warn "#{NAME}: STEM support not implemented"
+
+      # Add comments around the STEM content:
+      %(<!-- asciimath start -->#{node.text}<!-- asciimath end -->)
+    when :latexmath
+      # Issue a warning if a STEM content is present:
+      logger.warn "#{NAME}: STEM support not implemented"
+
+      # Add comments around the STEM content:
+      %(<!-- latexmath start -->#{node.text}<!-- latexmath end -->)
     else
       node.text
     end
@@ -594,6 +612,12 @@ class DitaTopic < Asciidoctor::Converter::Base
     # NOTE: Unlike AsciiDoc, DITA does not provide markup for a sidebar. As
     # a workaround, I decided to use a div with the outputclass attribute.
 
+    # Issue a warning if sidebars are disabled:
+    unless @sidebars_allowed
+      logger.warn "#{NAME}: Sidebars not supported in DITA"
+      return ''
+    end
+
     # Check if the content contains multiple block elements:
     if node.content_model == :compound
       <<~EOF.chomp

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Jaromir Hradilek
 bindir: bin
 cert_chain: []
-date: 2025-04-19 00:00:00.000000000 Z
+date: 2025-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor