RubyGems - asciidoctor-dita-topic - Versions diffs - 1.0.1 → 1.0.3 - Mend

asciidoctor-dita-topic 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a78953056690681fd5bd90e2ddc9bf86fc58a97e13ef88e3493aaccfd841af38
-  data.tar.gz: a6f0615ccc0706a2c70411596d7d6bf535530643548b45ca3647b9763e75c289
+  metadata.gz: 52c01d2fe1eed871381b9c7ccac78c70de1b2d3078fee28eab23a4b7ff0a261b
+  data.tar.gz: 39a4e1da5ba838141a929c610060a9a2e8189c292d714028af19dad236cc78bf
 SHA512:
-  metadata.gz: e4844fa7069d23b72d084a398a1d9895e1ce34c8a2a888508d9b83aefefa36cf4c56d681a6b6ffdd5f5891f7223128f5806e73fdb94624228399726d085a9253
-  data.tar.gz: 47bf20454de4e0b2c4ad8386ac6a4f81d5d792c3ee7ff0b73b2b2fe1cba700a3cd93f65edce4ecf082f3ea2d0954aeada3a685213005de3e49bf95dc9920736c
+  metadata.gz: 87721774c580b3a509ed62189fc31fcca4077bd0007a98234610f497430d3b8c6cf8adc0e71a7d752e672255e043bb2f6f335a28231fe12983772b3c1902dc58
+  data.tar.gz: 7a934f1f00886a4e7e8f512a1cd923b0ade242c8782810e564737075d3d3e5dea80a61c92f215162051c0de2471c9242acf5761555275c6d5f829aca9f5cb28c

data/lib/dita-topic.rb CHANGED Viewed

@@ -25,29 +25,44 @@
 # frozen_string_literal: true
 module Asciidoctor
-class DitaConverter < Asciidoctor::Converter::Base
+class DitaTopic < Asciidoctor::Converter::Base
   NAME = 'dita-topic'
   register_for NAME
   def initialize *args
     super
     outfilesuffix '.dita'
+    # Enable floating and block titles by default:
+    @titles_allowed = true
   end
   def convert_document node
+    # Check if floating and block titles are enabled:
+    @titles_allowed = false if (node.attr 'dita-topic-titles') == 'strict'
+    # Check if a specific topic type is provided:
+    if (value = node.attr 'dita-topic-type') =~ /^(concept|reference|task)$/
+      type = value
+      body = (type == 'task') ? 'taskbody' : %(#{type[0,3]}body)
+    else
+      type = 'topic'
+      body = 'body'
+    end
     # Check if the modular documentation content type is specified:
-    content_type = (node.attr? '_mod-docs-content-type') ? %( outputclass="#{(node.attr '_mod-docs-content-type').downcase}") : ''
+    outputclass = (node.attr? '_mod-docs-content-type') ? %( outputclass="#{(node.attr '_mod-docs-content-type').downcase}") : ''
     # Return the XML output:
     <<~EOF.chomp
     <?xml version='1.0' encoding='utf-8' ?>
-    <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
-    <topic#{compose_id (node.id or node.attributes['docname'])}#{content_type}>
+    <!DOCTYPE #{type} PUBLIC "-//OASIS//DTD DITA #{type.capitalize}//EN" "#{type}.dtd">
+    <#{type}#{compose_id (node.id or node.attributes['docname'])}#{outputclass}>
     <title>#{node.doctitle}</title>
-    <body>
+    <#{body}>
     #{node.content}
-    </body>
-    </topic>
+    </#{body}>
+    </#{type}>
     EOF
   end
@@ -58,7 +73,7 @@ class DitaConverter < Asciidoctor::Converter::Base
     # Issue a warning if the admonition has a title:
     if node.title?
-      logger.warn "#{NAME}: Admonition title not supported in DITA: #{node.title}"
+      logger.warn "#{NAME}: Admonition titles not supported in DITA"
     end
     # Return the XML output:
@@ -83,7 +98,6 @@ class DitaConverter < Asciidoctor::Converter::Base
     return ''
   end
-  # FIXME: Add support for a title.
   def convert_dlist node
     # Check if a different list style is set:
     return compose_horizontal_dlist node if node.style == 'horizontal'
@@ -123,19 +137,30 @@ class DitaConverter < Asciidoctor::Converter::Base
     result << '</dl>'
     # Return the XML output:
-    result.join LF
+    add_block_title (result.join LF), node.title, 'dlist'
   end
   def convert_example node
     <<~EOF.chomp
     <example#{compose_id node.id}>
-    #{compose_title node.title}#{node.content}
+    #{node.title ? %(<title>#{node.title}</title>\n) : ''}#{node.content}
     </example>
     EOF
   end
   def convert_floating_title node
-    compose_floating_title node.title, node.level
+    # NOTE: Unlike AsciiDoc, DITA does not have a dedicated element for
+    # floating titles. As a workaround, I decided to use a paragraph with
+    # the outputclass attribute.
+    # Issue a warning if floating titles are disabled:
+    unless @titles_allowed
+      logger.warn "#{NAME}: Floating titles not supported in DITA"
+      return ''
+    end
+    # Return the XML output:
+    %(<p outputclass="title sect#{node.level}"><b>#{node.title}</b></p>)
   end
   # FIXME: Add support for additional attributes.
@@ -246,8 +271,6 @@ class DitaConverter < Asciidoctor::Converter::Base
     return ''
   end
-  # FIXME: Investigate if there is an equivalent of <span> in DITA that
-  # would group individual <uicontrol> elements together.
   def convert_inline_kbd node
     # Check if there is more than one key:
     if (keys = node.attr 'keys').size == 1
@@ -299,31 +322,37 @@ class DitaConverter < Asciidoctor::Converter::Base
       # Check whether the source language is defined:
       language = (node.attributes.key? 'language') ? %( outputclass="language-#{node.attributes['language']}") : ''
-      # Return the XML output:
-      <<~EOF.chomp
+      # Compose the XML output:
+      result = <<~EOF.chomp
       <codeblock#{language}>
       #{node.content}
       </codeblock>
       EOF
     else
-      # Return the XML output:
-      <<~EOF.chomp
+      # Compose the XML output:
+      result = <<~EOF.chomp
       <screen>
       #{node.content}
       </screen>
       EOF
     end
+    # Return the XML output:
+    add_block_title result, node.title, 'listing'
   end
   def convert_literal node
-    <<~EOF.chomp
+    # Compose the XML output:
+    result = <<~EOF.chomp
     <pre>
     #{node.content}
     </pre>
     EOF
+    # Return the XML output:
+    add_block_title result, node.title, 'literal'
   end
-  # FIXME: Add support for titles.
   def convert_olist node
     # Open the ordered list:
     result = ['<ol>']
@@ -345,7 +374,7 @@ class DitaConverter < Asciidoctor::Converter::Base
     result << '</ol>'
     # Return the XML output:
-    result.join LF
+    add_block_title (result.join LF), node.title, 'olist'
   end
   # FIXME: This is not the top priority.
@@ -364,16 +393,7 @@ class DitaConverter < Asciidoctor::Converter::Base
   end
   def convert_paragraph node
-    # Check if the paragraph has a title assigned:
-    if node.title?
-      <<~EOF.chomp
-      <div outputclass="paragraph">
-      #{compose_floating_title node.title}<p>#{node.content}</p>
-      </div>
-      EOF
-    else
-      %(<p>#{node.content}</p>)
-    end
+    add_block_title %(<p>#{node.content}</p>), node.title, 'paragraph'
   end
   def convert_preamble node
@@ -542,7 +562,6 @@ class DitaConverter < Asciidoctor::Converter::Base
     %(<p outputclass="thematic-break"></p>)
   end
-  # FIXME: Add support for titles.
   def convert_ulist node
     # Open the unordered list:
     result = ['<ul>']
@@ -571,7 +590,7 @@ class DitaConverter < Asciidoctor::Converter::Base
     result << '</ul>'
     # Returned the XML output:
-    result.join LF
+    add_block_title (result.join LF), node.title, 'ulist'
   end
   def convert_verse node
@@ -623,7 +642,7 @@ class DitaConverter < Asciidoctor::Converter::Base
     result << '</ol>'
     # Return the XML output:
-    result.join LF
+    add_block_title (result.join LF), node.title, 'qanda'
   end
   def compose_horizontal_dlist node
@@ -678,27 +697,54 @@ class DitaConverter < Asciidoctor::Converter::Base
     result << %(</table>)
     # Return the XML output:
-    result.join LF
+    add_block_title (result.join LF), node.title, 'horizontal'
+  end
+  # Helper methods
+  def add_block_title content, title, context='wrapper'
+    # NOTE: Unlike AsciiDoc, DITA does not support titles assigned to
+    # certain block elements. As a workaround, I decided to use a paragraph
+    # with the outputclass attribute and wrap the block in a div element.
+    # Check if the title is defined:
+    return content unless title
+    # Issue a warning if block titles are disabled:
+    unless @titles_allowed
+      logger.warn "#{NAME}: Block titles not supported in DITA"
+      return content
+    end
+    # Return the XML output:
+    <<~EOF.chomp
+    <div outputclass="#{context}">
+    <p outputclass="title"><b>#{title}</b></p>
+    #{content}
+    </div>
+    EOF
   end
-  def compose_floating_title title, section_level=false
+  def compose_floating_title title
     # NOTE: Unlike AsciiDoc, DITA does not support floating titles or
     # titles assigned to certain block elements. As a workaround, I decided
     # to use a paragraph with the outputclass attribute.
-    # Check whether the section level is defined:
-    level = section_level ? %( sect#{section_level}) : ''
+    # Check if the title is defined:
+    return '' unless title
+    # Issue a warning if floating titles are disabled:
+    unless @titles_allowed
+      logger.warn "#{NAME}: Floating titles not supported in DITA"
+      return ''
+    end
     # Return the XML output:
-    title ? %(<p outputclass="title#{level}"><b>#{title}</b></p>\n) : ''
+    %(<p outputclass="title"><b>#{title}</b></p>\n)
   end
   def compose_id id
     id ? %( id="#{id}") : ''
   end
-  def compose_title title
-    title ? %(<title>#{title}</title>\n) : ''
-  end
 end
 end

metadata CHANGED Viewed

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