asciidoctor-dita-topic 1.1.9 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38849b62e13e55fe22459cab2c4a7aab8d47286e94cb5d573eeed98c175381ce
-  data.tar.gz: 440406834354a1a70c87be6026b763f95c920de0d924d5f9a2cdb2aee5842a1f
+  metadata.gz: 648f69ba5e5ada330dd2f74e5b6421d37e74a5a87e74d8fcce2a06361cf4f356
+  data.tar.gz: 3ba982932cab3253139ec969449584214db56e638f0bce7b1893685eeded2aed
 SHA512:
-  metadata.gz: cb1ee4720a5c4580557cf96bba10e93aa70e3ea1d3c976e0a2968f329a4e9eab7c04f3a60b8c791fa524089f0096c07e6624d170ffe8acc987f56add7992cab3
-  data.tar.gz: 26fe19f12366806c508b6c11218c6a78aa3d522032260d135e5b344bad150c91cdbe159d75b81b6ff1adcf0f58a3e52e440bee41c0563f785f4be70e0a92671a
+  metadata.gz: 6aed474f0fdda4e30e85ae64cd8d2c532b6646d93713584bdffef7b00e875c2b9f12c94eae7c5c00ca00a364415fcb7d6a9da581eed88b036072f010a5de6b39
+  data.tar.gz: 214b99142e2ca90f6e0ad5e5baf42de415127977cf585ca04017db57213c47cccbc2261a9a61a66e9f315d922210020d1c3f165233f4c904d6d1542452f270bd

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
 
@@ -222,8 +227,6 @@ This possible warning messages are as follows:
 [horizontal]
 Admonition titles not supported in DITA:: AsciiDoc allows you to add a custom title to any admonition by including `._Admonition title_` on the line above it. Unlike AsciiDoc, DITA does not allow titles for admonitions. `dita-topic` issues this warning whenever an admonition has a title defined in the converted AsciiDoc file.
 
-Audio macro not supported:: AsciiDoc allows you to embed audio content in your documents by using the `audio::__audio_file__[]` macro. `dita-topic` does not implement this feature and issues this warning whenever the `audio` macro is present in the converted AsciiDoc file.
-
 Author lines not enabled for topics:: AsciiDoc interprets the first line that directly follows the document title as an author line. Because topics are not expected to have author lines, `dita-topic` issues this warning when an author line is present in the converted AsciiDoc file.
 
 Block titles not supported in DITA:: AsciiDoc allows you to include `._Block title_` on the line above most of the block elements to assign a custom title to them. Unlike AsciiDoc, DITA only allows titles to be assigned to a limited number of elements. `dita-topic` issues this warning when the `-a dita-topic-titles=off` option is specified and a block title is present in the converted AsciiDoc file.
@@ -250,8 +253,6 @@ Table footers not supported in DITA:: AsciiDoc allows you to set the `footer` op
 
 Thematic breaks not supported in DITA:: Asciidoc allows you to use `'''`, `---`, or `\***` (the last two with possible optional spaces in between the characters) to insert a thematic break in between two blocks, most commonly represented by a horizontal line. Unlike AsciiDoc, DITA does not support thematic breaks. `dita-topic` issues this warning whenever a thematic break is present in the converted AsciiDoc file.
 
-Video macro not supported:: AsciiDoc allows you to embed video content in your documents by using the `video::__video_file__[]` macro. `dita-topic` does not implement this feature and issues this warning whenever the `video` macro is present in the converted AsciiDoc file.
-
 [#copyright]
 == Copyright
 

data/lib/dita-topic.rb

@@ -61,6 +61,13 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if sidebars are enabled:
     @sidebars_allowed = false if (node.attr 'dita-topic-sidebars') == 'off'
 
+    # 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; both
     # _module-type and _content-type are deprecated, but still present in
     # some modules:
@@ -95,7 +102,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 +124,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:
@@ -129,15 +136,22 @@ class DitaTopic < Asciidoctor::Converter::Base
   end
 
   def convert_audio node
-    # Issue a warning if audio content is present:
-    logger.warn "#{NAME}: Audio macro not supported"
-    return ''
+    # Check if the audio macro has a title specified:
+    if node.title?
+      <<~EOF.chomp
+      <object data="#{node.media_uri(node.attr 'target')}">
+        <desc>#{node.title}</desc>
+      </object>
+      EOF
+    else
+      %(<object data="#{node.media_uri(node.attr 'target')}" />)
+    end
   end
 
   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
 
@@ -224,7 +238,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:
@@ -242,7 +256,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
 
@@ -296,7 +310,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>)
@@ -315,7 +329,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}" />)
@@ -337,7 +351,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
@@ -346,7 +360,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 -->)
@@ -359,7 +373,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
 
@@ -474,13 +488,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 -->)
@@ -563,7 +577,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>)
@@ -616,7 +630,7 @@ 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
 
     # Return the XML output:
     <<~EOF.chomp
@@ -633,7 +647,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
 
@@ -655,7 +669,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
 
@@ -681,7 +695,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
 
@@ -743,7 +757,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>)
@@ -795,9 +809,41 @@ class DitaTopic < Asciidoctor::Converter::Base
   end
 
   def convert_video node
-    # Issue a warning if video content is present:
-    logger.warn "#{NAME}: Video macro not supported"
-    return ''
+    # Check if additional attributes are specified:
+    width  = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : ''
+    height = (node.attr? 'height') ? %( height="#{node.attr 'height'}") : ''
+
+    # Check if the video is a Vimeo or YouTube video:
+    if (provider = (node.attr 'poster')) == 'youtube'
+      # Separate a playlist from the target:
+      target, list = (node.attr 'target').split '/', 2
+
+      # Check if the playlist is provided as an attribute:
+      if node.attr 'list' and not list
+        list = node.attr 'list'
+      end
+
+      # Compose the playlist URL fragment:
+      list = list ? %(?list=#{list}) : ''
+
+      # Compose the target URL:
+      target_url = %(https://www.youtube.com/embed/#{target}#{list})
+    elsif provider == 'vimeo'
+      target_url = %(https://player.vimeo.com/video/#{node.attr 'target'})
+    else
+      target_url = node.media_uri(node.attr 'target')
+    end
+
+    # Check if the audio macro has a title specified:
+    if node.title?
+      <<~EOF.chomp
+      <object data="#{target_url}"#{width}#{height}>
+        <desc>#{node.title}</desc>
+      </object>
+      EOF
+    else
+      %(<object data="#{target_url}"#{width}#{height} />)
+    end
   end
 
   def compose_qanda_dlist node
@@ -905,7 +951,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
 
@@ -932,7 +978,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
 
@@ -947,7 +993,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
 
@@ -960,5 +1006,11 @@ class DitaTopic < Asciidoctor::Converter::Base
       %(&##{12941 + number};)
     end
   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.1.9
+  version: 1.2.1
 platform: ruby
 authors:
 - Jaromir Hradilek
 bindir: bin
 cert_chain: []
-date: 2025-06-07 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.7
 specification_version: 4
 summary: A custom AsciiDoc converter that generates individual DITA topics
 test_files: []