asciidoctor-dita-topic 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 648f69ba5e5ada330dd2f74e5b6421d37e74a5a87e74d8fcce2a06361cf4f356
-  data.tar.gz: 3ba982932cab3253139ec969449584214db56e638f0bce7b1893685eeded2aed
+  metadata.gz: 9ef188774cec09940a4fa4f67d8f6f91f69d3e422ba7ce79550c3b2866c7793c
+  data.tar.gz: 359c1f98c2991ef613e8d3a96d4c83c3861a901783633ba709ac5b2f7817c2ab
 SHA512:
-  metadata.gz: 6aed474f0fdda4e30e85ae64cd8d2c532b6646d93713584bdffef7b00e875c2b9f12c94eae7c5c00ca00a364415fcb7d6a9da581eed88b036072f010a5de6b39
-  data.tar.gz: 214b99142e2ca90f6e0ad5e5baf42de415127977cf585ca04017db57213c47cccbc2261a9a61a66e9f315d922210020d1c3f165233f4c904d6d1542452f270bd
+  metadata.gz: d7ce10652ecbcb46ba32ccef483cf774bc5f4514bba18fc49de335007bd854fc3d86f865ce52b4475fa9853e6bbfc4efd3389d263f47af57d0d0b754a170cd80
+  data.tar.gz: 2c10449f2d3f5f143215afa730679a17e2bed33096062eafb090af9c928d8fd46c6fe03411b890b9c8801831c0fe2b0c1a67a54f35ef900b05aea89aa4fb2510

data/README.adoc

@@ -120,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
 
@@ -137,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,6 +64,9 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if sidebars are enabled:
     @sidebars_allowed = false if (node.attr 'dita-topic-sidebars') == 'off'
 
+    # 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'
@@ -68,13 +74,8 @@ class DitaTopic < Asciidoctor::Converter::Base
       @file_name  = "#{file_name}#{file_suffix}"
     end
 
-    # 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 the modular documentation content type is specified:
+    outputclass = compose_type_outputclass node
 
     # Open the document:
     result = ["<?xml version='1.0' encoding='utf-8' ?>"]
@@ -632,9 +633,12 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Issue a warning if there are nested sections:
     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>
@@ -1007,6 +1011,18 @@ class DitaTopic < Asciidoctor::Converter::Base
     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}:) : ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Jaromir Hradilek
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A custom AsciiDoc converter that generates individual DITA topics
 test_files: []