asciidoctor-dita-topic 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b150bed25c8b6413a69a4caa81af642427d3c799fc70ec32ca090b4df36622ab
-  data.tar.gz: b49b48b67ebc6a056121ed223c3af0af321c3284372fb1238c3b19f8752c8e2b
+  metadata.gz: b79eb2b45f900b9cbee57c173d9aa79db84d7f04a53bbe7deb6ecc43f9c8bf18
+  data.tar.gz: 54894c1f9bd28473f96dc1e2918753851243c4b27f56e333c8fb7d1e2c48e7c3
 SHA512:
-  metadata.gz: 9c30598e80430b66ee90928f3b6222486bc3f187a024b685ee09da7063e4b2d42666c014a70ca5c9892eca85487fa45831e630bc11ba8e22775c372cafaff9fb
-  data.tar.gz: a278c11c09eb8290c2fa1347a81cab381059a0083efc2f53477135e1ca222aa0482fdee5b62a12897cf981914ce52453227162c2f24025e7da0f5af06a0a367f
+  metadata.gz: 2e800a3d97ddff033a24fa183a76ba10418053477417486156cf41887d958de4f315e1e67caaaec4315d507377e14d62cb6eca5fdc2c1bc44585ef142c26d2ef
+  data.tar.gz: 7f989fe3f2704b87240446362e9bba85fe3eb6f03d25cc478e4bd17494101dc2314d6c9e6a96f2a6305d7792e44bca4960e078123cc54e5b99413229233d42ae

data/README.adoc

@@ -312,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.
 |===
@@ -333,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

@@ -103,6 +103,10 @@ module AsciidoctorDitaTopic
           @attr.append 'dita-topic-titles=off'
         end
 
+        opt.on('-B', '--no-spaces', 'disable non-breaking spaces in titles') do
+          @attr.append 'dita-topic-spaces=off'
+        end
+
         opt.separator ''
 
         opt.on('-h', '--help', 'display this help and exit') do

data/lib/dita-topic/version.rb

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

data/lib/dita-topic.rb

@@ -52,6 +52,9 @@ class DitaTopic < Asciidoctor::Converter::Base
 
     # Disable propagating the content type to sections by default:
     @type_allowed = false
+
+    # Enable non-breaking spaces in titles by default:
+    @spaces_allowed = true
   end
 
   def convert_document node
@@ -73,6 +76,9 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Check if propagating the content type to sections is enabled:
     @type_allowed = true if (node.attr 'dita-topic-type') == 'on'
 
+    # Check if non-breaking spaces in titles are enabled:
+    @spaces_allowed = false if (node.attr 'dita-topic-spaces') == 'off'
+
     # Check if the file name is available (it is not for standard input):
     if node.attr? 'docname'
       file_name   = node.attr 'docname'
@@ -87,7 +93,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     result = ["<?xml version='1.0' encoding='utf-8' ?>"]
     result << %(<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">)
     result << %(<topic#{compose_id (node.id or node.attributes['docname'] or 'topic-'+SecureRandom.uuid)}#{outputclass}>)
-    result << %(<title>#{node.doctitle}</title>)
+    result << %(<title>#{replace_spaces node.doctitle}</title>)
 
     # Check if the author line is enabled and defined:
     if @authors_allowed && !node.authors.empty?
@@ -252,7 +258,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Return the XML output:
     <<~EOF.chomp
     <example#{compose_id node.id}#{compose_metadata node.role}>
-    #{node.title ? %(<title>#{node.title}</title>\n) : ''}#{node.content}
+    #{node.title ? %(<title>#{replace_spaces node.title}</title>\n) : ''}#{node.content}
     </example>
     EOF
   end
@@ -286,7 +292,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     if node.title?
       <<~EOF.chomp
       <fig#{compose_id node.id}#{compose_metadata node.role}>
-      <title>#{node.title}</title>
+      <title>#{replace_spaces node.title}</title>
       <image href="#{node.image_uri(node.attr 'target')}"#{width}#{height}#{scale} placement="break">
       <alt>#{node.alt}</alt>
       </image>
@@ -645,7 +651,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Return the XML output:
     <<~EOF.chomp
     <section#{compose_id node.id}#{outputclass}#{compose_metadata node.role}>
-    <title>#{node.title}</title>
+    <title>#{replace_spaces node.title}</title>
     #{node.content}
     </section>
     EOF
@@ -688,7 +694,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     result = [%(<table#{compose_id node.id}#{compose_metadata node.role}>)]
 
     # Check if the title is specified:
-    result << %(<title>#{node.title}</title>) if node.title?
+    result << %(<title>#{replace_spaces node.title}</title>) if node.title?
 
     # Define the table properties and open the tgroup:
     result << %(<tgroup cols="#{node.attr 'colcount'}">)
@@ -902,7 +908,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     result = [%(<table outputclass="horizontal-dlist"#{compose_id node.id}#{compose_metadata node.role}>)]
 
     # Check if the title is specified:
-    result << %(<title>#{node.title}</title>) if node.title?
+    result << %(<title>#{replace_spaces node.title}</title>) if node.title?
 
     # Define the table properties and open the tgroup:
     result << %(<tgroup cols="2">)
@@ -1050,7 +1056,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 +1071,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
@@ -1079,6 +1093,23 @@ class DitaTopic < Asciidoctor::Converter::Base
     end
   end
 
+  def replace_spaces text
+    # Return the original value if no text is supplied
+    return text unless text
+
+    # Check if non-breaking spaces are allowd:
+    if @spaces_allowed
+      return text
+    end
+
+    # Replace unsupported non-breaking spaces:
+    return text.
+      gsub(/&(?:nbsp|#160);/, ' ').              # Non-breaking space
+      gsub(/&(?:thinsp|ThinSpace|#8201);/, ' '). # Thin space
+      gsub(/&(?:ZeroWidthSpace|#8203);/, '').    # Zero-width space
+      gsub(/&(?:NoBreak|#8288);/, '')            # Word joiner
+  end
+
   def extract_attributes text
     # Extract metadata attributes from an empty ph element:
     if /^\s*<ph(?<attributes> [^>]+)><\/ph>\s*/ =~ text

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Jaromir Hradilek
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
 summary: A custom AsciiDoc converter that generates individual DITA topics
 test_files: []