asciidoctor-dita-topic 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51a2caa5d7a9ffe86c7953d7ac7b7be5b75e805e2cc26f1d5b41cfcbc82c876d
-  data.tar.gz: 37951e25ad0227c52b0d1aeb1c37c8195bcc316a7f2073e1fc3c22d7b4bb5592
+  metadata.gz: 9ef188774cec09940a4fa4f67d8f6f91f69d3e422ba7ce79550c3b2866c7793c
+  data.tar.gz: 359c1f98c2991ef613e8d3a96d4c83c3861a901783633ba709ac5b2f7817c2ab
 SHA512:
-  metadata.gz: 23a3d3efe86dc34fcf92014fa9e2f3c08c8a9ac76150f22e0dea7951239170cbbcd18d0477797c0acad7464dc401ae849010c4409271d1df4d4b38deb5a04c63
-  data.tar.gz: 2bf8a48fcd886f3674f21ce2676c1de1e9e7b3564a87803500d6d4994dec573b24608e50e5caadaccc9b98e1d6baefec3c26a0690590fd384b4814faa4513fe8
+  metadata.gz: d7ce10652ecbcb46ba32ccef483cf774bc5f4514bba18fc49de335007bd854fc3d86f865ce52b4475fa9853e6bbfc4efd3389d263f47af57d0d0b754a170cd80
+  data.tar.gz: 2c10449f2d3f5f143215afa730679a17e2bed33096062eafb090af9c928d8fd46c6fe03411b890b9c8801831c0fe2b0c1a67a54f35ef900b05aea89aa4fb2510

data/README.adoc

@@ -35,6 +35,11 @@ Install the `asciidoctor-dita-topic` Ruby gem:
 $ *gem install asciidoctor-dita-topic*
 ....
 
+[IMPORTANT]
+====
+On macOS, `asciidoctor` installed with Homebrew expects Ruby gems in a different directory than where `gem install` places them. To work around this issue, you can either link:https://docs.asciidoctor.org/asciidoctor/latest/install/ruby-packaging/#gem-install[install `asciidoctor` as a Ruby gem], or run `asciidoctor` with the `-r` option followed by the relative path to the `dita-topic.rb` file.
+====
+
 [#use]
 == Usage
 
@@ -115,6 +120,18 @@ To enable processing of author lines as metadata, set the value of the `dita-top
 $ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-authors=on _your_file_.adoc**
 ....
 
+[#callouts]
+=== Enabling callouts
+
+Unlike AsciiDoc, DITA does not support callouts as a method to add annotations to specific lines in verbatim blocks. For this reason, the conversion of callouts is disabled by default.
+
+If callouts are required, the `dita-topic` converter can use XML entities for circled numbers in place of callouts. To enable this behavior, set the value of the `dita-topic-callouts` to `on`:
+
+[literal,subs="+quotes"]
+....
+$ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-callouts=on _your_file_.adoc**
+....
+
 [#titles]
 === Disabling floating titles
 
@@ -132,18 +149,6 @@ To disable this behavior, set the value of the `dita-topic-titles` to `off`:
 $ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-titles=off _your_file_.adoc**
 ....
 
-[#callouts]
-=== Disabling callouts
-
-Unlike AsciiDoc, DITA does not support callouts as a method to add annotations to specific lines in verbatim blocks. To avoid losing content during conversion, as a workaround, the `dita-topic` converter uses XML entities for circled numbers.
-
-To disable this behavior, set the value of the `dita-topic-callouts` to `off`:
-
-[literal,subs="+quotes"]
-....
-$ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-callouts=off _your_file_.adoc**
-....
-
 [#includes]
 === Disabling include directives
 

data/lib/dita-topic.rb

@@ -39,13 +39,16 @@ class DitaTopic < Asciidoctor::Converter::Base
     @authors_allowed = false
 
     # Enable callouts by default:
-    @callouts_allowed = true
+    @callouts_allowed = false
 
     # Enable floating and block titles by default:
     @titles_allowed = true
 
     # Enable sidebars by default:
     @sidebars_allowed = true
+
+    # Disable propagating the content type to sections by default:
+    @type_allowed = false
   end
 
   def convert_document node
@@ -53,7 +56,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     @authors_allowed = true if (node.attr 'dita-topic-authors') == 'on'
 
     # Check if callouts are enabled:
-    @callouts_allowed = false if (node.attr 'dita-topic-callouts') == 'off'
+    @callouts_allowed = true if (node.attr 'dita-topic-callouts') == 'on'
 
     # Check if floating and block titles are enabled:
     @titles_allowed = false if (node.attr 'dita-topic-titles') == 'off'
@@ -61,13 +64,18 @@ class DitaTopic < Asciidoctor::Converter::Base
     # 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:
-    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'
+    # Check if propagating the content type to sections is enabled:
+    @type_allowed = true if (node.attr 'dita-topic-type') == 'on'
+
+    # Check if the file name is available (it is not for standard input):
+    if node.attr? 'docname'
+      file_name   = node.attr 'docname'
+      file_suffix = (node.attr? 'docfilesuffix') ? (node.attr 'docfilesuffix') : ''
+      @file_name  = "#{file_name}#{file_suffix}"
+    end
+
+    # Check if the modular documentation content type is specified:
+    outputclass = compose_type_outputclass node
 
     # Open the document:
     result = ["<?xml version='1.0' encoding='utf-8' ?>"]
@@ -95,7 +103,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if the author line defined while disabled:
     if !@authors_allowed && !node.authors.empty?
       # Issue a warning as inline content is not going to be processed:
-      logger.warn "#{NAME}: Author lines not enabled for topics"
+      logger.warn format_message "Author lines not enabled for topics"
 
       # Process the author line as a plain paragraph:
       result << %(<p>#{node.authors.map {|author| compose_author author, node}.join('; ')}</p>)
@@ -117,7 +125,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Issue a warning if the admonition has a title:
     if node.title?
-      logger.warn "#{NAME}: Admonition titles not supported in DITA"
+      logger.warn format_message "Admonition titles not supported in DITA"
     end
 
     # Return the XML output:
@@ -144,7 +152,7 @@ class DitaTopic < Asciidoctor::Converter::Base
   def convert_colist node
     # Issue a warning if callouts are disabled:
     unless @callouts_allowed
-      logger.warn "#{NAME}: Callouts not supported in DITA"
+      logger.warn format_message "Callouts not supported in DITA"
       return ''
     end
 
@@ -231,7 +239,7 @@ class DitaTopic < Asciidoctor::Converter::Base
   def convert_example node
     # Issue a warning if the example is nested:
     if (parent = node.parent.context) != :document && parent != :preamble
-      logger.warn "#{NAME}: Examples not supported within #{parent} in DITA"
+      logger.warn format_message "Examples not supported within #{parent} in DITA"
     end
 
     # Return the XML output:
@@ -249,7 +257,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Issue a warning if floating titles are disabled:
     unless @titles_allowed
-      logger.warn "#{NAME}: Floating titles not supported in DITA"
+      logger.warn format_message "Floating titles not supported in DITA"
       return ''
     end
 
@@ -303,7 +311,7 @@ class DitaTopic < Asciidoctor::Converter::Base
       # 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? '#'
+        logger.warn format_message "Possible invalid reference: #{node.target}" if node.target.include? '#'
 
         # Compose a cross reference:
         return %(<xref href="#{node.target}">#{node.text || path}</xref>)
@@ -322,7 +330,7 @@ class DitaTopic < Asciidoctor::Converter::Base
       end
 
       # Issue a warning as the cross reference is unlikely to work:
-      logger.warn "#{NAME}: Possible invalid reference: #{node.target}"
+      logger.warn format_message "Possible invalid reference: #{node.target}"
 
       # Compose the cross reference:
       node.text ? %(<xref href="#{node.target}">#{node.text}</xref>) : %(<xref href="#{node.target}" />)
@@ -344,7 +352,7 @@ class DitaTopic < Asciidoctor::Converter::Base
       %(<i id="#{node.id}" />[#{node.reftext || node.id}])
     else
       # Issue a warning if an unknown anchor type is present:
-      logger.warn "#{NAME}: Unknown anchor type: #{node.type}"
+      logger.warn format_message "Unknown anchor type: #{node.type}"
       ''
     end
   end
@@ -353,7 +361,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # NOTE: Unlike AsciiDoc, DITA does not support inline line breaks.
 
     # Issue a warning if an inline line break is present:
-    logger.warn "#{NAME}: Inline breaks not supported in DITA"
+    logger.warn format_message "Inline breaks not supported in DITA"
 
     # Return the XML output:
     %(#{node.text}<!-- break -->)
@@ -366,7 +374,7 @@ class DitaTopic < Asciidoctor::Converter::Base
   def convert_inline_callout node
     # Issue a warning if callouts are disabled:
     unless @callouts_allowed
-      logger.warn "#{NAME}: Callouts not supported in DITA"
+      logger.warn format_message "Callouts not supported in DITA"
       return ''
     end
 
@@ -481,13 +489,13 @@ class DitaTopic < Asciidoctor::Converter::Base
       %(&#8216;#{node.text}&#8217;)
     when :asciimath
       # Issue a warning if a STEM content is present:
-      logger.warn "#{NAME}: STEM support not implemented"
+      logger.warn format_message "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"
+      logger.warn format_message "STEM support not implemented"
 
       # Add comments around the STEM content:
       %(<!-- latexmath start -->#{node.text}<!-- latexmath end -->)
@@ -570,7 +578,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # NOTE: Unlike AsciiDoc, DITA does not support page breaks.
 
     # Issue a warning if a page break is present:
-    logger.warn "#{NAME}: Page breaks not supported in DITA"
+    logger.warn format_message "Page breaks not supported in DITA"
 
     # Return the XML output:
     %(<p outputclass="page-break"></p>)
@@ -623,11 +631,14 @@ class DitaTopic < Asciidoctor::Converter::Base
     # markup.
 
     # Issue a warning if there are nested sections:
-    logger.warn "#{NAME}: Nesting of sections not supported in DITA" if node.level > 1
+    logger.warn format_message "Nesting of sections not supported in DITA" if node.level > 1
+
+    # Check if the modular documentation content type is specified:
+    outputclass = @type_allowed ? compose_type_outputclass(node.document) : ''
 
     # Return the XML output:
     <<~EOF.chomp
-    <section#{compose_id node.id}>
+    <section#{compose_id node.id}#{outputclass}>
     <title>#{node.title}</title>
     #{node.content}
     </section>
@@ -640,7 +651,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Issue a warning if sidebars are disabled:
     unless @sidebars_allowed
-      logger.warn "#{NAME}: Sidebars not supported in DITA"
+      logger.warn format_message "Sidebars not supported in DITA"
       return ''
     end
 
@@ -662,7 +673,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
   def convert_stem node
     # Issue a warning if a STEM content is present:
-    logger.warn "#{NAME}: STEM support not implemented"
+    logger.warn format_message "STEM support not implemented"
     return ''
   end
 
@@ -688,7 +699,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
       # Issue a warning if a table footer is present:
       if type == :foot
-        logger.warn "#{NAME}: Table footers not supported in DITA"
+        logger.warn format_message "Table footers not supported in DITA"
         next
       end
 
@@ -750,7 +761,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # NOTE: Unlike AsciiDoc, DITA does not support thematic breaks.
 
     # Issue a warning if a thematic break is present:
-    logger.warn "#{NAME}: Thematic breaks not supported in DITA"
+    logger.warn format_message "Thematic breaks not supported in DITA"
 
     # Return the XML output:
     %(<p outputclass="thematic-break"></p>)
@@ -944,7 +955,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Issue a warning if block titles are disabled:
     unless @titles_allowed
-      logger.warn "#{NAME}: Block titles not supported in DITA"
+      logger.warn format_message "Block titles not supported in DITA"
       return content
     end
 
@@ -971,7 +982,7 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Issue a warning if floating titles are disabled:
     unless @titles_allowed
-      logger.warn "#{NAME}: Floating titles not supported in DITA"
+      logger.warn format_message "Floating titles not supported in DITA"
       return ''
     end
 
@@ -986,7 +997,7 @@ class DitaTopic < Asciidoctor::Converter::Base
   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"
+      logger.warn format_message "Callout number not in range between 1 and 50"
       return number
     end
 
@@ -999,5 +1010,23 @@ class DitaTopic < Asciidoctor::Converter::Base
       %(&##{12941 + number};)
     end
   end
+
+  def compose_type_outputclass node
+    # NOTE: _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'
+
+    # Return the outputclass attribute:
+    return outputclass
+  end
+
+  def format_message message
+    # Compose the warning or error message:
+    file_name = (defined? @file_name) ? %( #{@file_name}:) : ''
+    %(#{NAME}:#{file_name} #{message})
+  end
 end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Jaromir Hradilek
 bindir: bin
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A custom AsciiDoc converter that generates individual DITA topics
 test_files: []