asciidoctor-dita-topic 1.4.7 → 1.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa49c2e77c20ed32770fa37f0a286ca5a5aa808c5fef1e11c70bce3ac5fc3f74
-  data.tar.gz: 698164a21ee241367c0ebc3d029759e546618514ac91d93e7076abe0eea58ca7
+  metadata.gz: 54897b731c29e283e7a3f6813b8399e583435343d5c480cb2f802e392ad07dfc
+  data.tar.gz: bb7ebe60820497be880333fa56b0e56b85c0713073314bef65f1fd33237fb0ad
 SHA512:
-  metadata.gz: 6ddefc4aec275a5ce85990ca28bdcffe0d2a8033834112c5eea7c225f0420af2de96f952661799a17b3c2134739001ccf7f6323b7f8953a191f4dc9dcfb18ada
-  data.tar.gz: 1088e887c924235e473b9f23aa04e4e3a41e3f8f307857342f7f852b2de5791e2917d7b69c74ff8f487e1c82098d62cbe993f1b8fd9c9f72f127e7284dd14fe1
+  metadata.gz: 87eb3816ce0a31a524c758abefdc15bec4c364654928d974b79baf8cbb88d9ef4bfe2975fb77fec8e7f9564045269ba8d8482796c7507af2d9958544608e8256
+  data.tar.gz: fbe4b750cba7a0745c45165b337b1ad466874371c3a13d211348e58b12430a035f88f188120c025bf5d4f4f1f10dc06fd037303c6728a44d20b70ef8a0891949

data/README.adoc

@@ -133,7 +133,7 @@ To enable processing of author lines as metadata, run the `dita-topic` command w
 $ **dita-topic -l _your_file_.adoc**
 ....
 
-If you prefer to use Asciidoctor directly, set the value of the `dita-topic-authors` to `on`:
+If you prefer to use Asciidoctor directly, set the value of the `dita-topic-authors` attribute to `on`:
 
 [literal,subs="+quotes"]
 ....
@@ -157,7 +157,7 @@ To disable this behavior, run the `dita-topic` command with the `-T` option:
 $ **dita-topic -T _your_file_.adoc**
 ....
 
-If you prefer to use Asciidoctor directly, set the value of the `dita-topic-titles` to `off`:
+If you prefer to use Asciidoctor directly, set the value of the `dita-topic-titles` attribute to `off`:
 
 [literal,subs="+quotes"]
 ....
@@ -176,7 +176,7 @@ To disable this behavior, run the `dita-topic` command with the `-C` option:
 $ **dita-topic -C _your_file_.adoc**
 ....
 
-If you prefer to use Asciidoctor directly, set the value of the `dita-topic-callouts` to `off`:
+If you prefer to use Asciidoctor directly, set the value of the `dita-topic-callouts` attribute to `off`:
 
 [literal,subs="+quotes"]
 ....
@@ -261,6 +261,20 @@ Read the [filename]`/etc/passwd` file to see the complete list of
 available user accounts.
 ----
 
+To disable this behavior, for example when the source files do not annotate semantic markup consistently, run the `dita-topic` command with the `-M` option:
+
+[literal,subs="+quotes"]
+....
+$ **dita-topic -M _your_file_.adoc**
+....
+
+If you prefer to use Asciidoctor directly, set the value of the `dita-topic-semantic` attribute to `off`:
+
+[literal,subs="+quotes"]
+....
+$ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-semantic=off _your_file_.adoc**
+....
+
 [#metadata]
 === Adding metadata
 
@@ -341,6 +355,6 @@ Thematic breaks not supported in DITA:: Asciidoc allows you to use `'''`, `---`,
 [#copyright]
 == Copyright
 
-Copyright (C) 2024, 2025 Jaromir Hradilek
+Copyright (C) 2024–2026 Jaromir Hradilek
 
 This program is free software, released under the terms of the link:LICENSE[MIT license]. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

data/lib/dita-topic/cli.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2025 Jaromir Hradilek
+# Copyright (C) 2025, 2026 Jaromir Hradilek
 
 # MIT License
 #
@@ -34,7 +34,6 @@ module AsciidoctorDitaTopic
       @opts = {
         :output => false,
         :standalone => true,
-        :map => false,
         :no_includes => 0
       }
       @prep = []
@@ -61,10 +60,6 @@ module AsciidoctorDitaTopic
 
         opt.separator ''
 
-        opt.on('-m', '--dita-map', 'generate a DITA map instead of a topic; this functionality is experimental and not yet fully tested') do
-          @opts[:map] = true
-        end
-
         opt.on('-p', '--prepend-file FILE', 'prepend a file to all input files; can be supplied multiple times') do |file|
           raise OptionParser::InvalidArgument, "not a file: #{file}" unless File.exist? file and File.file? file
           raise OptionParser::InvalidArgument, "file not readable: #{file}" unless File.readable? file
@@ -90,6 +85,10 @@ module AsciidoctorDitaTopic
           @attr.append 'dita-topic-callouts=off'
         end
 
+        opt.on('-M', '--no-semantic-markup', 'disable processing of semantic markup') do
+          @attr.append 'dita-topic-semantic=off'
+        end
+
         opt.on('-S', '--no-sidebars', 'disable processing of sidebars') do
           @attr.append 'dita-topic-sidebars=off'
         end
@@ -125,73 +124,6 @@ module AsciidoctorDitaTopic
       return args
     end
 
-    def convert_map file, input, base_dir
-      if file == $stdin
-        offset   = 0
-      else
-        file     = Pathname.new(file).sub_ext('.dita').basename
-        offset   = 1
-      end
-
-      doc        = Asciidoctor.load input, backend: 'dita-topic', safe: :unsafe, attributes: @attr, base_dir: base_dir, sourcemap: true
-      sections   = doc.find_by context: :section
-
-      return unless sections
-
-      title      = (sections.first.level == 0 and sections.first.title) ? sections.first.title : false
-
-      if @opts[:standalone]
-        result   = ["<?xml version='1.0' encoding='utf-8' ?>"]
-        result  << %(<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">)
-        result  << %(<map>)
-        result  << %(  <title>#{title}</title>) if title
-      else
-        result   = []
-      end
-
-      last_level = 0
-      last_file  = ''
-
-      sections.each_index do |i|
-        section  = sections[i]
-        level    = section.level
-        title    = section.title.gsub(/"|<[^>]*>|[<>]/, '')
-        filename = section.file ? Pathname.new(section.file).sub_ext('.dita').relative_path_from(base_dir) : Pathname.new(file)
-        current  = last_level
-
-        next if filename == last_file
-
-        while current > level
-          current -= 1
-          result << '  ' * (current + offset) + %(</topicref>)
-        end
-
-        if level - last_level > 1
-          warn "WARNING: #{filename.basename}: line #{section.lineno}: section title out of sequence: expected level #{last_level + 1}, got level #{level}"
-          level = last_level + 1
-        end
-
-        indent  = '  ' * (level + offset)
-        parent  = (sections[i + 1] and sections[i + 1].level > level) ? true : false
-        result << indent + %(<topicref href="#{filename}" navtitle="#{title}"#{parent ? '>' : ' />'}) unless filename == $stdin
-
-        last_level = level
-        last_file  = filename
-      end
-
-      while last_level > 0
-        last_level -= 1
-        break if last_level == 0 and file == $stdin
-        result << '  ' * (last_level + offset) + %(</topicref>)
-      end
-
-      if @opts[:standalone]
-        result << %(</map>)
-      end
-
-      return result.join("\n")
-    end
-
     def convert_topic input, base_dir
       return Asciidoctor.convert input, backend: 'dita-topic', standalone: @opts[:standalone], safe: :unsafe, attributes: @attr, base_dir: base_dir
     end
@@ -210,21 +142,18 @@ module AsciidoctorDitaTopic
           input    = $stdin.read
           output   = @opts[:output] ? @opts[:output] : $stdout
         else
-          suffix   = @opts[:map] ? '.ditamap' : '.dita'
           base_dir = Pathname.new(file).dirname.expand_path
           input    = File.read(file)
-          output   = @opts[:output] ? @opts[:output] : Pathname.new(file).sub_ext(suffix).to_s
+          output   = @opts[:output] ? @opts[:output] : Pathname.new(file).sub_ext('.dita').to_s
         end
 
         prepended.gsub!(/^:_(?:mod-docs-content|content|module)-type:[ \t]+\S/, '//\&')
         prepended.gsub!(Asciidoctor::IncludeDirectiveRx, '//\&') if @opts[:no_includes] > 1
         input.gsub!(Asciidoctor::IncludeDirectiveRx, '//\&') if @opts[:no_includes] > 0
 
-        if @opts[:map]
-          result = convert_map file, prepended + input, base_dir
-        else
-          result = convert_topic prepended + input, base_dir
-        end
+        result = convert_topic prepended + input, base_dir
+
+        result.gsub!(/<ph (?:(?:platform|product|audience|otherprops)="[^"]+" ?)+><\/ph> */, '')
 
         if output == $stdout
           $stdout.write result

data/lib/dita-topic/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2025 Jaromir Hradilek
+# Copyright (C) 2025, 2026 Jaromir Hradilek
 
 # MIT License
 #
@@ -24,5 +24,5 @@
 # frozen_string_literal: true
 
 module AsciidoctorDitaTopic
-  VERSION     = '1.4.7'
+  VERSION     = '1.4.9'
 end

data/lib/dita-topic.rb

@@ -1,5 +1,5 @@
 # A custom AsciiDoc converter that generates individual DITA topics
-# Copyright (C) 2024, 2025 Jaromir Hradilek
+# Copyright (C) 2024-2026 Jaromir Hradilek
 
 # MIT License
 #
@@ -38,6 +38,9 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Disable the author line by default:
     @authors_allowed = false
 
+    # Enable processing of semantic markup by default:
+    @semantic_allowed = true
+
     # Enable callouts by default:
     @callouts_allowed = true
 
@@ -55,6 +58,9 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if the author line is enabled:
     @authors_allowed = true if (node.attr 'dita-topic-authors') == 'on'
 
+    # Check if semantic markup is enabled:
+    @semantic_allowed = false if (node.attr 'dita-topic-semantic') == 'off'
+
     # Check if callouts are enabled:
     @callouts_allowed = false if (node.attr 'dita-topic-callouts') == 'off'
 
@@ -463,8 +469,8 @@ class DitaTopic < Asciidoctor::Converter::Base
       # Set the default element value:
       element = 'codeph'
 
-      # Check if the role is provided:
-      if node.role
+      # Check if semantic markup is enabled and the role is provided:
+      if @semantic_allowed and node.role
         # Define supported roles:
         semantic_markup = {
           'command'   => 'cmdname',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.4.9
 platform: ruby
 authors:
 - Jaromir Hradilek
@@ -18,7 +18,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.26
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,49 +28,81 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.26
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: '13.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: '13.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.3.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.22.0
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.22.0
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.27'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.4
 description: An extension for AsciiDoctor that converts a single AsciiDoc file to
   a DITA topic.
 email: jhradilek@gmail.com