asciidoctor-iso 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c29ba0cfa2863387a26f72eabdb729c5506f631e
-  data.tar.gz: 4511b3434cb36ff15c5380002f7320c492a2e625
+  metadata.gz: 81628e6445230282af27ae6ee08a5b1662850618
+  data.tar.gz: 5ec3c5c6573556c7cf6cfb5ebcaa827d728db794
 SHA512:
-  metadata.gz: 0aaee89e4089325c64d8dbe8c07e6a2d1ac387c9c67e85533fa2a117bf53cb1ca3362a2a2dac444854e8dd4d5ce22e0523f6b1109934a1aacfb7183fa2b593eb
-  data.tar.gz: 19b11aab34452b3b66ef3f2963e234778dd8096bcf4c4636514dadd5d9059da68859fa860f20f097dcade70f339bf2815e10a6284577eae468aae2d860d3d479
+  metadata.gz: e79a67ec52c08f26beeda9eca31e38556832ed8eaaa000b42e05fbafc24a59cc96166b81d32b43264432a11e1087862a14fe30dc3ae241a60012bb9ad6f9137e
+  data.tar.gz: 7ee22285f177d6c466cbf7870a4f9e001eda32485a517625afb3df7c37d5f83e51cef712b77569f1bca21323e60a8017a7c02101c68080368956af4f2f7c644f

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/riboseinc/html2doc.git
-  revision: 1b65fde5d80501506554276174cda5d438f122f5
+  revision: 8a131b82eeecd0c27e4bde873f2ba16d425754d6
   specs:
-    html2doc (0.0.1)
+    html2doc (0.6.0)
       asciimath
       htmlentities (~> 4.3.4)
       image_size
@@ -14,9 +14,9 @@ GIT
 
 GIT
   remote: https://github.com/riboseinc/isodoc.git
-  revision: 45ea6e5fd3e3f1416c294a2e460f69fee268e0d2
+  revision: 0818963410de3aeb880f263678c47dcadcfe9b50
   specs:
-    isodoc (0.0.1)
+    isodoc (0.4.0)
       asciimath
       html2doc
       htmlentities (~> 4.3.4)
@@ -30,16 +30,13 @@ GIT
 PATH
   remote: .
   specs:
-    asciidoctor-iso (0.0.1)
+    asciidoctor-iso (0.6.1)
       asciidoctor (~> 1.5.6)
-      asciimath
       html2doc
       htmlentities (~> 4.3.4)
-      image_size
-      mime-types
+      isodoc
       nokogiri (= 1.8.1)
       ruby-jing
-      ruby-xslt
       thread_safe
       uuidtools
 
@@ -55,7 +52,7 @@ GEM
     docile (1.1.5)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    ffi (1.9.18)
+    ffi (1.9.21)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)

data/README.adoc

@@ -30,6 +30,10 @@ https://www.iso.org/iso-templates.html[ISO Standard Microsoft Word template].
 
 This AsciiDoc syntax for writing ISO standards is hereby named "AsciiISO".
 
+This README provides an overview of the functionality of the gem; see also
+https://github.com/riboseinc/asciidoctor-iso/wiki/Guidance-for-authoring[Guidance for authoring]
+ISO standards using the gem.
+
 == Usage
 
 [source,console]
@@ -56,6 +60,7 @@ https://github.com/riboseinc/isodoc[IsoDoc] gem generates temporary files:
 and the `{filename}_files` folder contains any images and headers for the Word
 document.
 
+
 === Content Warnings
 
 The gem also realises several format
@@ -150,6 +155,27 @@ XML to break up paragraphs within a footnote.)
 [[model_additions]]
 === Asciidoctor model additions
 
+=== Term markup
+
+To ensure the structure of Terms and Definitions is captured accurately, the following
+macros are defined, and must be used to mark up their respective content:
+
+`alt:[TERM]`:: for alternative terms
+`deprecated:[TERM]`:: for deprecated terms
+`domain:[TERM]`:: for term domains
+
+The macro contents can contain their own markup.
+
+[source,asciidoctor]
+--
+=== paddy 
+alt:[_paddy_ rice]
+deprecated:[#[smallcap]#cargo# rice]
+domain:[rice]
+
+_paddy_ (<<paddy>>) from which the husk only has been removed
+--
+
 ==== Paragraph alignment
 
 Alignment is defined as an attribute for paragraphs:
@@ -169,19 +195,45 @@ This paragraph is aligned center
 This paragraph is justified, which is the default
 --
 
-==== Dates on reviewer notes
+==== Reviewer notes
 
-Reviewer notes are encoded as sidebars. A date attribute (in ISO 8601 format)
-and a reviewer attribute (naming the reviewer) 
-are mandatory for reviewer notes; supplying the time as well as the date
-is optional.
+Reviewer notes are encoded as sidebars, and can be separated at a distance from the
+text they are annotating; the text they are annotating is indicated through anchors. 
+Reviewer notes are only rendered if the document has a `:draft:` attribute.
+
+The following attributes on reviewer notes are mandatory:
+
+* `reviewer` attribute (naming the reviewer) 
+* the starting target anchor of the note (`from` attribute)
+
+The following attributes are optional:
+
+* `date` attribute, optionally including the time (as xs:date or xs:datetime)
+* the ending target anchor of the note (`to` attribute)
+
+The span of text covered by the reviewer note is from the start of the
+text encompassed by the `from` element, to the end of the text encompassed
+by the `to` element. If only the `from` element supplied, the reviewer note
+covers the `from` element. The `from` and `to` elements can be bookmarks,
+which cover no space.
 
 [source,asciidoctor]
 --
-[reviewer="Nick Nicholas",date=20180125T0121]
+[[clause_address_profile_definition]]
+=== Address Profile Definition (AddressProfileDescription)
+
+[[para1]]
+This is a clause address [[A]]profile[[B]] definition
+
+[reviewer="Nick Nicholas",date=20180125T0121,from=clause_address_profile_definition,to=para1]
 ****
 I do not agree with this statement.
 ****
+
+[reviewer="Nick Nicholas",date=20180125T0121,from=A,to=B]
+****
+Profile?!
+****
 --
 
 ==== Strikethrough and Small Caps
@@ -228,6 +280,41 @@ attribute `inline-header`:
 consisting of a conical sample divider
 --
 
+==== Bibliographic details
+
+Citations can include details of where in the document the citation is located; these
+are entered by suffixing the type of locality, followed by the reference. Multiple
+instances of locality and reference can be provided, delimited by comma or colon. For
+example:
+
+[source,asciidoctor]
+--
+<<ISO712,section 5, page 8-10>>         # renders as: ISO 712, Section 5, Page 8-10
+<<ISO712,section 5, page 8-10: 5:8-10>> # renders as ISO 712, 5:8-10
+<<ISO712,whole>>                        # renders as: ISO 712, Whole of text
+--
+
+The references cannot contain spaces. Any text following the sequence of localities
+will be displayed instead of the localities.
+
+==== Block Quotes
+
+As in normal Asciidoctor, block quotes are preceded with an author and a citation;
+but the citation is expected to be in the same format as all other citations, 
+a cross-reference optionally followed by text, which may include the bibliographic
+sections referenced:
+
+[source,asciidoctor]
+--
+[quote, ISO, "ISO7301,section 1"]
+_____
+This International Standard gives the minimum specifications for rice (_Oryza sativa_ L.) 
+which is subject to international trade. It is applicable to the following types: husked rice 
+and milled rice, parboiled or not, intended for direct human consumption. It is neither 
+applicable to other products derived from rice, nor to waxy rice (glutinous rice).
+_____
+--
+
 === Features not visible in HTML preview
 
 The gem uses built-in Asciidoc formatting as much as possible, so that users
@@ -382,23 +469,48 @@ in the deafting stage
 `:technical-committee-number:`:: The number of the relevant ISO technical
 committee
 
+`:technical-committee-type:``:: The type of the relevant technical committee. Defaults
+to `TC` if not supplied. Values: `TC1, `PC`, `JTC`, `JPC`.
+
 `:technical-committee:`:: The name of the relevant ISO technical committee
 (mandatory)
 
 `:subcommittee-number:`:: The number of the relevant ISO subcommittee
 
+`:subcommittee-type:`:: The type of the relevant ISO subcommittee. Defaults to
+`SC` if not supplied. Values: `SC`, `JSC`.
+
 `:subcommittee:`:: The name of the relevant ISO subcommittee
 
 `:workgroup-number:`:: The number of the relevant ISO workgroup
 
+`:workgroup-type:`:: The type of the relevant ISO workgroup. Defaults to `WG` if
+not supplied. Example values: `JWG`, `JAG`, `AG` (advisory group), `AHG`, `SWG`, 
+`SG`, `MA` (maintenance agency), `CORG`, `JCG`, `CAG`
+
 `:workgroup:`:: The name of the relevant ISO workgroup
 
 `:language:` :: The language of the document (`en` or `fr`)  (mandatory)
 
+`:publisher:`:: The standards agency publishing the standard; can be multiple
+(comma-delimited). Defaults to `ISO`.
 
 The attribute `:draft:`, if present, includes review notes in the XML output;
 these are otherwise suppressed.
 
+The document proper can reference the values of document attributes, which is convenient
+for reusability. For example,
+the Rice Model document references the editorial groups that have contributed to the 
+document as
+
+[source,asciidoc]
+--
+This document was prepared by Technical Committee ISO/TC {technical-committee-number}, _{technical-committee}_, Subcommittee SC {subcommittee-number}, _{subcommittee}_.
+--
+
+If the corresponding document attributes are not populated in the header, then the references
+themselves will not be populated.
+
 
 == Data Models
 

data/asciidoctor-iso.gemspec

@@ -28,16 +28,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.add_dependency "asciidoctor", "~> 1.5.6"
-  spec.add_dependency "asciimath"
   spec.add_dependency "htmlentities", "~> 4.3.4"
-  spec.add_dependency "image_size"
-  spec.add_dependency "mime-types"
   spec.add_dependency "nokogiri", "= 1.8.1"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "ruby-xslt"
   spec.add_dependency "thread_safe"
   spec.add_dependency "uuidtools"
   spec.add_dependency "html2doc"
+  spec.add_dependency "isodoc"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "byebug", "~> 9.1"

data/lib/asciidoctor-iso.rb

@@ -1,3 +1,5 @@
 require "asciidoctor" unless defined? Asciidoctor::Converter
 require_relative "asciidoctor/iso/converter"
 require_relative "asciidoctor/iso/version"
+require "asciidoctor/extensions"
+

data/lib/asciidoctor/iso/base.rb

@@ -10,6 +10,11 @@ require "isodoc"
 module Asciidoctor
   module ISO
     module Base
+      Asciidoctor::Extensions.register do
+        inline_macro Asciidoctor::ISO::AltTermInlineMacro
+        inline_macro Asciidoctor::ISO::DeprecatedTermInlineMacro
+        inline_macro Asciidoctor::ISO::DomainTermInlineMacro
+      end
 
       def content(node)
         node.content
@@ -29,7 +34,7 @@ module Asciidoctor
       def doc_converter
         IsoDoc::Convert.new(
           htmlstylesheet: html_doc_path("htmlstyle.css"),
-          wordstylesheet: nil,
+          wordstylesheet:  html_doc_path("wordstyle.css"),
           standardstylesheet: html_doc_path("isodoc.css"),
           header: html_doc_path("header.html"),
           htmlcoverpage: html_doc_path("html_iso_titlepage.html"),
@@ -49,7 +54,6 @@ module Asciidoctor
       def document(node)
         init
         ret1 = makexml(node)
-        validate(ret1)
         ret = ret1.to_xml(indent: 2)
         filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
           gsub(%r{^.*/}, '')
@@ -67,6 +71,7 @@ module Asciidoctor
         result = textcleanup(result.flatten * "\n")
         ret1 = cleanup(Nokogiri::XML(result))
         ret1.root.add_namespace(nil, "http://riboseinc.com/isoxml")
+        validate(ret1)
         ret1
       end
 
@@ -75,8 +80,10 @@ module Asciidoctor
       end
 
       def front(node, xml)
-        title node, xml
-        metadata node, xml
+        xml.bibdata **attr_code(type: node.attr("doctype")) do |b|
+          metadata node, b
+        end
+        metadata_version(node, xml)
       end
 
       def middle(node, xml)
@@ -87,17 +94,18 @@ module Asciidoctor
 
       def add_term_source(xml_t, seen_xref, m)
         attr = { bibitemid: seen_xref.children[0]["target"],
-                 format: seen_xref.children[0]["format"] }
+                 format: seen_xref.children[0]["format"],
+                 type: "inline" }
         xml_t.origin seen_xref.children[0].content, **attr_code(attr)
-        xml_t.isosection m[:section].gsub(/ /, "")  if m[:section]
-        if m[:text]
-          xml_t.modification do |mod| 
-            mod.p { |p| p << m[:text]  }
-          end
+        m[:section] && xml_t.isosection do |s|
+          s.reference m[:section].gsub(/ /, "")
+        end
+        m[:text] && xml_t.modification do |mod| 
+          mod.p { |p| p << m[:text].sub(/^\s+/, "")  }
         end
       end
 
-      TERM_REFERENCE_RE_STR = <<~REGEXP
+      TERM_REFERENCE_RE_STR = <<~REGEXP.freeze
              ^(?<xref><xref[^>]+>)
                (,\s(?<section>[^, ]+))?
                (,\s(?<text>.*))?
@@ -105,7 +113,7 @@ module Asciidoctor
       REGEXP
       TERM_REFERENCE_RE =
         Regexp.new(TERM_REFERENCE_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
-                   Regexp::IGNORECASE)
+                   Regexp::IGNORECASE | Regexp::MULTILINE)
 
 
       def extract_termsource_refs(text)
@@ -128,89 +136,6 @@ module Asciidoctor
         end.join("\n")
       end
 
-      def paragraph(node)
-        return termsource(node) if node.role == "source"
-        attrs = { align: node.attr("align"), 
-                  id: Utils::anchor_or_uuid(node) }
-        noko do |xml|
-          xml.p **attr_code(attrs) do |xml_t|
-            xml_t << node.content
-            style(node, Utils::flatten_rawtext(node).join(" "))
-          end
-        end.join("\n")
-      end
-
-      def inline_footnote(node)
-        noko do |xml|
-          @fn_number += 1
-          xml.fn **{reference: @fn_number} do |fn|
-            # TODO multi-paragraph footnotes
-            fn.p { |p| p << node.text }
-            footnote_style(node, node.text)
-          end
-        end.join("\n")
-      end
-
-      def open(node)
-        # open block is a container of multiple blocks,
-        # treated as a single block.
-        # We append each contained block to its parent
-        result = []
-        if node.blocks?
-          node.blocks.each do |b|
-            result << send(b.context, b)
-          end
-        else
-          result = paragraph(node)
-        end
-        result
-      end
-
-      def inline_break(node)
-        noko do |xml|
-          xml << node.text
-          xml.br
-        end.join("\n")
-      end
-
-      def page_break(node)
-        noko do |xml|
-          xml << node.text
-          xml.pagebreak
-        end.join("\n")
-      end
-
-      def thematic_break(node)
-        noko do |xml|
-          xml << node.text
-          xml.hr
-        end.join("\n")
-      end
-
-      def inline_quoted(node)
-        noko do |xml|
-          case node.type
-          when :emphasis then xml.em node.text
-          when :strong then xml.strong node.text
-          when :monospaced then xml.tt node.text
-          when :double then xml << "\"#{node.text}\""
-          when :single then xml << "'#{node.text}'"
-          when :superscript then xml.sup node.text
-          when :subscript then xml.sub node.text
-          when :asciimath then xml.stem node.text, **{ type: "AsciiMath" }
-          else
-            case node.role
-            when "alt" then xml.admitted { |a| a << node.text }
-            when "deprecated" then xml.deprecates { |a| a << node.text }
-            when "domain" then xml.domain { |a| a << node.text }
-            when "strike" then xml.strike node.text
-            when "smallcap" then xml.smallcap node.text
-            else
-              xml << node.text
-            end
-          end
-        end.join
-      end
     end
   end
 end

data/lib/asciidoctor/iso/blocks.rb

@@ -4,14 +4,29 @@ require "uri"
 module Asciidoctor
   module ISO
     module Blocks
+
       def id_attr(node = nil)
         { id: Utils::anchor_or_uuid(node) }
       end
 
+      def open(node)
+        # open block is a container of multiple blocks,
+        # treated as a single block.
+        # We append each contained block to its parent
+        result = []
+        if node.blocks?
+          node.blocks.each do |b|
+            result << send(b.context, b)
+          end
+        else
+          result = paragraph(node)
+        end
+        result
+      end
+
       def stem(node)
         # NOTE: html escaping is performed by Nokogiri
         stem_content = node.lines.join("\n")
-
         noko do |xml|
           xml.formula **id_attr(node) do |s|
             s.stem stem_content, **{ type: "AsciiMath" }
@@ -27,6 +42,8 @@ module Asciidoctor
           reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
           id: Utils::anchor_or_uuid(node),
           date: date.gsub(/[:-]/, ""),
+          from: node.attr("from"),
+          to: node.attr("to") || node.attr("from"),
         }
       end
 
@@ -35,7 +52,7 @@ module Asciidoctor
         content = Utils::flatten_rawtext(node.content).join("\n")
         noko do |xml| 
           xml.review **attr_code(sidebar_attrs(node)) do |r|
-            r << content
+            wrap_in_para(node, r)
           end
         end
       end
@@ -43,10 +60,7 @@ module Asciidoctor
       def termnote(n)
         noko do |xml|
           xml.termnote **id_attr(n) do |ex|
-            if n.blocks? then ex << n.content
-            else 
-              ex.p {|p| p << n.content }
-            end
+            wrap_in_para(n, ex)
             style(n, Utils::flatten_rawtext(n.content).join("\n"))
           end
         end.join("\n")
@@ -55,10 +69,7 @@ module Asciidoctor
       def note(n)
         noko do |xml|
           xml.note **id_attr(n) do |c|
-            if n.blocks? then c << n.content
-            else
-              c.p { |p| p << n.content }
-            end
+            wrap_in_para(n, c)
             text = Utils::flatten_rawtext(n.content).join("\n")
             note_style(n, text)
           end
@@ -79,10 +90,7 @@ module Asciidoctor
         return note(node) if node.attr("name") == "note"
         noko do |xml|
           xml.admonition **admonition_attrs(node) do |a|
-            if node.blocks? then a << node.content
-            else
-              a.p { |p| p << node.content }
-            end
+            wrap_in_para(node, a)
           end
         end.join("\n")
       end
@@ -91,10 +99,7 @@ module Asciidoctor
         noko do |xml|
           xml.termexample **id_attr(node) do |ex|
             c = node.content
-            if node.blocks? then ex << c 
-            else 
-              ex.p {|p| p << c }
-            end
+            wrap_in_para(node, ex)
             text = Utils::flatten_rawtext(c).join("\n")
             termexample_style(node, text)
           end
@@ -107,15 +112,13 @@ module Asciidoctor
           xml.example **id_attr(node) do |ex|
             content = node.content
             ex << content
-            text = Utils::flatten_rawtext(content).join("\n")
-            termexample_style(node, text)
           end
         end.join("\n")
       end
 
       def preamble(node)
         noko do |xml|
-          xml.content do |xml_abstract|
+          xml.foreword do |xml_abstract|
             xml_abstract.title { |t| t << "Foreword" }
             content = node.content
             xml_abstract << content
@@ -144,33 +147,38 @@ module Asciidoctor
         end
       end
 
+      def paragraph(node)
+        return termsource(node) if node.role == "source"
+        attrs = { align: node.attr("align"),
+                  id: Utils::anchor_or_uuid(node) }
+        noko do |xml|
+          xml.p **attr_code(attrs) do |xml_t|
+            xml_t << node.content
+            style(node, Utils::flatten_rawtext(node).join(" "))
+          end
+        end.join("\n")
+      end
+
       def quote_attrs(node)
-        { 
-          id: Utils::anchor_or_uuid(node), 
-          align: node.attr("align"),
-        }
+        { id: Utils::anchor_or_uuid(node), align: node.attr("align") }
       end
 
       def quote_attribution(node, out)
-        if node.attr("attribution")
-          out.fullname do |f|
-            f.surname { |s| s << node.attr("attribution") }
-            # TODO: will break up into name components
-          end
-        end
         if node.attr("citetitle")
-          # TODO: eref
+          m = /^(?<cite>[^,]+)(,(?<text>.*$))?$/.match node.attr("citetitle")
+          out.source m[:text], 
+            **attr_code(target: m[:cite], type: "inline")
+        end
+        if node.attr("attribution")
+          out.author { |a| a << node.attr("attribution") }
         end
       end
 
       def quote(node)
         noko do |xml|
           xml.quote **attr_code(quote_attrs(node)) do |q|
-            quote_attribution(node, out)
-            if node.blocks? then q << node.content
-            else
-              q.p { |p| p << node.content }
-            end
+            quote_attribution(node, q)
+            wrap_in_para(node, q)
           end
         end
       end
@@ -179,8 +187,8 @@ module Asciidoctor
         # NOTE: html escaping is performed by Nokogiri
         noko do |xml|
           if node.parent.context != :example
-            xml.figure do |xml_figure|
-              xml_figure.sourcecode **id_attr(node) do |s| 
+            xml.example **id_attr(node) do |e|
+              e.sourcecode **id_attr(node) do |s| 
                 s << node.content 
               end
             end