asciidoctor-dita-topic 1.4.9 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54897b731c29e283e7a3f6813b8399e583435343d5c480cb2f802e392ad07dfc
-  data.tar.gz: bb7ebe60820497be880333fa56b0e56b85c0713073314bef65f1fd33237fb0ad
+  metadata.gz: 9ac51fea23e9f82cc4dddc459c42eb9877f054b22d474d9d020cb0b7876cbfad
+  data.tar.gz: 50287798b45a0571cd0538639a0da114e101bfa2297c4a17e24451ceff634fa2
 SHA512:
-  metadata.gz: 87eb3816ce0a31a524c758abefdc15bec4c364654928d974b79baf8cbb88d9ef4bfe2975fb77fec8e7f9564045269ba8d8482796c7507af2d9958544608e8256
-  data.tar.gz: fbe4b750cba7a0745c45165b337b1ad466874371c3a13d211348e58b12430a035f88f188120c025bf5d4f4f1f10dc06fd037303c6728a44d20b70ef8a0891949
+  metadata.gz: 31c8095b9943ad5dde42deb002fff7d0be3975a5bd40a3657612309d38ae6ec39851c170edffd74e38da01d2eef11c8434637c48193cb96cb71e2a79e991f2bd
+  data.tar.gz: 8ad53b93870a78a6ec2b0896ce5c620b07a696eee55cc9bd366be8d2ce98962285f6d118533b8684c8254299ce9df3a2f3258657c6dabe5b58ab08f42e7d570a

data/README.adoc

@@ -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
 
@@ -286,19 +312,23 @@ DITA provides four metadata attributes that can be used for conditional processi
 | DITA Attribute
 | Description
 
-| `platform:__value__`
+| `platform:__value__` +
+`pl:__value__`
 | `platform="_value_"`
 | Operating system or hardware architecture.
 
-| `product:__value__`
+| `product:__value__` +
+`pr:__value__`
 | `product="_value_"`
 | Product name.
 
-| `audience:__value__`
+| `audience:__value__` +
+`au:__value__`
 | `audience="_value_"`
 | Target audience.
 
-| `otherprops:__value__`
+| `otherprops:__value__` +
+`op:__value__`
 | `otherprops="_value_"`
 | Additional properties.
 |===
@@ -307,7 +337,7 @@ For example, to indicate that a particular paragraph is relevant for Linux and m
 
 [source,asciidoc]
 ----
-[role="platform:linux platform:mac audience:beginner"]
+[role="pl:linux pl:mac au:beginner"]
 For more information, see the *bash*(1) manual page.
 ----
 

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
@@ -125,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

@@ -24,5 +24,5 @@
 # frozen_string_literal: true
 
 module AsciidoctorDitaTopic
-  VERSION     = '1.4.9'
+  VERSION     = '1.5.1'
 end

data/lib/dita-topic.rb

@@ -1050,7 +1050,12 @@ class DitaTopic < Asciidoctor::Converter::Base
     result = {}
 
     # Define supported metadata attributes:
-    valid  = ['platform', 'product', 'audience', 'otherprops']
+    valid  = {
+      'pl' => 'platform',
+      'pr' => 'product',
+      'au' => 'audience',
+      'op' => 'otherprops'
+    }
 
     # Process each role:
     roles.split.each do |role|
@@ -1060,8 +1065,11 @@ class DitaTopic < Asciidoctor::Converter::Base
       # Separate the attribute name from its value:
       attribute, value = role.split ':'
 
+      # Expand the short attribute variant:
+      attribute = valid[attribute] if valid.key? attribute
+
       # Ignore unsupported attribute names:
-      next unless valid.include? attribute
+      next unless valid.value? attribute
 
       # Append the value to the attribute:
       if result.key? attribute

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.4.9
+  version: 1.5.1
 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: []