asciidoctor-dita-topic 1.4.8 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa920fa9fdc9383aca4b8411314622cb154dd6ada686b0b12f997e6e184b2a65
-  data.tar.gz: 56888969b54b717a5f716684e210688b04bd7a4b31e7023437faf5860992eaa5
+  metadata.gz: b150bed25c8b6413a69a4caa81af642427d3c799fc70ec32ca090b4df36622ab
+  data.tar.gz: b49b48b67ebc6a056121ed223c3af0af321c3284372fb1238c3b19f8752c8e2b
 SHA512:
-  metadata.gz: ac7bb7c93a66b5b0b2ffd1cb202fc09e42c1944f3e98f60a79c6a06c7d8b271b9e549fa1f4362e7d78295d171ed8e54f9668d2daa5f85d23740ebcfb00667b1c
-  data.tar.gz: 0f1722b7ea6b5adb0cdfa8a9816ccb85a98bb9f924b936acc08ad725b1f9b5e9133bd266bfa00321ae576d10f50a23627d3b2d05345ca2a5d6ad7a8943965b7f
+  metadata.gz: 9c30598e80430b66ee90928f3b6222486bc3f187a024b685ee09da7063e4b2d42666c014a70ca5c9892eca85487fa45831e630bc11ba8e22775c372cafaff9fb
+  data.tar.gz: a278c11c09eb8290c2fa1347a81cab381059a0083efc2f53477135e1ca222aa0482fdee5b62a12897cf981914ce52453227162c2f24025e7da0f5af06a0a367f

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"]
 ....
@@ -184,7 +184,7 @@ $ **asciidoctor -r dita-topic -b dita-topic -a dita-topic-callouts=off _your_fil
 ....
 
 [#includes]
-=== Disabling include directives
+=== Disabling all include directives
 
 By default, Asciidoctor resolves all `include` directives before converting the file. To only convert the contents of the selected file, run the `dita-topic` command with the `-I` option:
 
@@ -202,6 +202,32 @@ $ **asciidoctor -r dita-topic -b dita-topic -S secure _your_file_.adoc**
 
 This disables processing of the include directives, but leaves cross references to the included files in the converted output.
 
+[#include_filter]
+=== Disabling inclusion of assemblies and modules
+
+By default, Asciidoctor resolves all `include` directives before converting the file. To only include content from files explicitly marked as attributes or snippets, run the `dita-topic` command with the `-A` option:
+
+[literal,subs="+quotes"]
+....
+$ **dita-topic -A _your_file_.adoc**
+....
+
+To mark a file as an attribute definition file, add the following line at the top of it:
+
+[source,asciidoc]
+----
+:_mod-docs-content-type: ATTRIBUTES
+----
+
+To mark a file as a snippet file, add the following line at the top of it:
+
+[source,asciidoc]
+----
+:_mod-docs-content-type: SNIPPET
+----
+
+Any other files are ignored. This functionality is not available in standard Asciidoctor.
+
 [#abstracts]
 === Adding short descriptions
 
@@ -261,6 +287,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 +381,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

@@ -25,6 +25,7 @@ require 'optparse'
 require 'pathname'
 require 'asciidoctor'
 require_relative 'version'
+require_relative 'filter'
 require_relative '../dita-topic'
 
 module AsciidoctorDitaTopic
@@ -34,6 +35,7 @@ module AsciidoctorDitaTopic
       @opts = {
         :output => false,
         :standalone => true,
+        :modules => true,
         :no_includes => 0
       }
       @prep = []
@@ -71,6 +73,10 @@ module AsciidoctorDitaTopic
           @opts[:no_includes] += 1
         end
 
+        opt.on('-A', '--no-modules', 'disable processing of include directives with assemblies and modules') do
+          @opts[:modules] = false
+        end
+
         opt.separator ''
 
         opt.on('-l', '--author-line', 'enable processing of author lines as metadata') do
@@ -85,6 +91,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
@@ -121,6 +131,11 @@ module AsciidoctorDitaTopic
     end
 
     def convert_topic input, base_dir
+      if not @opts[:modules]
+        Asciidoctor::Extensions.register do
+          include_processor FilterIncludeDirectives
+        end
+      end
       return Asciidoctor.convert input, backend: 'dita-topic', standalone: @opts[:standalone], safe: :unsafe, attributes: @attr, base_dir: base_dir
     end
 

data/lib/dita-topic/filter.rb

@@ -0,0 +1,55 @@
+# Copyright (C) 2026 Jaromir Hradilek
+
+# MIT License
+#
+# Permission  is hereby granted,  free of charge,  to any person  obtaining
+# a copy of  this software  and associated documentation files  (the "Soft-
+# ware"),  to deal in the Software  without restriction,  including without
+# limitation the rights to use,  copy, modify, merge,  publish, distribute,
+# sublicense, and/or sell copies of the Software,  and to permit persons to
+# whom the Software is furnished to do so,  subject to the following condi-
+# tions:
+#
+# The above copyright notice  and this permission notice  shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS
+# OR IMPLIED,  INCLUDING BUT NOT LIMITED TO  THE WARRANTIES OF MERCHANTABI-
+# LITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
+# SHALL THE AUTHORS OR COPYRIGHT HOLDERS  BE LIABLE FOR ANY CLAIM,  DAMAGES
+# OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM,  OUT OF OR IN CONNECTION WITH  THE SOFTWARE  OR  THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+require 'asciidoctor'
+require 'pathname'
+
+class FilterIncludeDirectives < Asciidoctor::Extensions::IncludeProcessor
+  def handles? target
+    target.end_with? '.adoc', '.asciidoc', '.asc', '.ad'
+  end
+
+  def process doc, reader, target, attributes
+    file_path   = Pathname.new(doc.base_dir) + target
+
+    begin
+      logger = Asciidoctor::LoggerManager.logger
+      include_doc = Asciidoctor.load_file file_path, safe: :secure, logger: false
+    ensure
+      Asciidoctor::LoggerManager.logger = logger
+    end
+
+    return reader unless supported_type? include_doc.attributes
+
+    reader.push_include File.read(file_path), target, target, 1, attributes
+    return reader
+  end
+
+  def supported_type? attributes
+    type = attributes['_mod-docs-content-type'] ? attributes['_mod-docs-content-type'].downcase : nil
+    type = attributes['_content-type'] ? attributes['_content-type'].downcase : nil unless type
+    type = attributes['_module-type'] ? attributes['_module-type'].downcase : nil unless type
+
+    ['attributes', 'snippet'].include? type
+  end
+end

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.8'
+  VERSION     = '1.5.0'
 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.8
+  version: 1.5.0
 platform: ruby
 authors:
 - Jaromir Hradilek
@@ -117,6 +117,7 @@ files:
 - bin/dita-topic
 - lib/dita-topic.rb
 - lib/dita-topic/cli.rb
+- lib/dita-topic/filter.rb
 - lib/dita-topic/version.rb
 homepage: https://github.com/jhradilek/asciidoctor-dita-topic
 licenses:
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A custom AsciiDoc converter that generates individual DITA topics
 test_files: []