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

asciidoctor-dita-topic 1.0.1 → 1.0.2

Files changed (3) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a78953056690681fd5bd90e2ddc9bf86fc58a97e13ef88e3493aaccfd841af38
-  data.tar.gz: a6f0615ccc0706a2c70411596d7d6bf535530643548b45ca3647b9763e75c289
+  metadata.gz: c6f5805b63c0d48906d76f8f7e1b2bd5c639db80d455435040f8a2bad2f9e9d4
+  data.tar.gz: 1f09b2c11281e306607e0a128579373cd5cf9ef996b2cf2da67ec89804674e0e
 SHA512:
-  metadata.gz: e4844fa7069d23b72d084a398a1d9895e1ce34c8a2a888508d9b83aefefa36cf4c56d681a6b6ffdd5f5891f7223128f5806e73fdb94624228399726d085a9253
-  data.tar.gz: 47bf20454de4e0b2c4ad8386ac6a4f81d5d792c3ee7ff0b73b2b2fe1cba700a3cd93f65edce4ecf082f3ea2d0954aeada3a685213005de3e49bf95dc9920736c
+  metadata.gz: 98822e7e8089ece8e20ee5b31404474ca32c181b2451142e03f62aaf0ef3d7d99201557996a5a5d5a69d9c9fb90fae14858354807932be0e8bc8de28b58d306b
+  data.tar.gz: d9147d53564a175c223aac1886cc6272fcfbe82e6bb61cb15f835412a662170aae28ec9cfe63b3bccdaa0910fafbc57341d82824a0cf9f378f425030c0b07a79

data/lib/dita-topic.rb CHANGED Viewed

@@ -25,28 +25,43 @@
 # 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 (type = node.attr 'dita-topic-type') =~ /^(concept|reference|task)$/
+      element = type
+      body = (type == 'task') ? 'taskbody' : %(#{type[0,3]}body)
+    else
+      element = '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}>
+    <#{element}#{compose_id (node.id or node.attributes['docname'])}#{outputclass}>
     <title>#{node.doctitle}</title>
-    <body>
+    <#{body}>
     #{node.content}
-    </body>
+    </#{body}>
     </topic>
     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.2
 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
@@ -30,6 +30,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.22.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.6
 description: An extension for AsciiDoctor that converts a single AsciiDoc file to
   a DITA topic.
 email: jhradilek@gmail.com