asciidoctor-iso 0.6.0 → 0.6.1

data/lib/asciidoctor/iso/isostandard_diff.rnc

@@ -6,23 +6,15 @@ start = iso-standard
 
 iso-standard = 
   element iso-standard {
-    title+,
-    status,
-    creator,
-    language,
-    script,
-    type,
-    id,
-    version?,
-    copyright,
-    sections
+    #title+, status, creator, language, script, type, id, version?, copyright, sections
+    bibdata, version?, sections+
   }
 
 language =
   element language { ( "en" | "fr" ) }
 
 script =
-  element script { "latn" }
+  element script { "Latn" }
 
 # draft into isodoc? To replace version/version?
 version =
@@ -34,44 +26,47 @@ version =
 
 draft = element draft {text}
 
-copyright = 
-  element copyright {
-    from, owner
+# TODO to docidentifier
+#id =
+  #element id {
+    #documentnumber,
+    #tc-documentnumber?
+  #}
+
+# add type to docidentifier in isodoc?
+docidentifier =
+  element docidentifier {
+    ( text | documentnumber | tc-documentnumber )
 }
 
-owner = 
-  element owner {
-    owner-affiliation  
+# TODO to orgname
+#creator =
+  #element creator { 
+    #attribute role { text },
+    #technical-committee,
+    #subcommittee?,
+    #workgroup?,
+    #secretariat?
+  #}
+
+organization = 
+  element organization {
+    orgname, uri?, org-identifier*, contact*,
+    technical-committee?, subcommittee?, workgroup?, secretariat?  
 }
 
-owner-affiliation = element affiliation { "ISO" }
-
-id =
-  element id {
-    documentnumber,
-    tc-documentnumber?
-  }
-
-creator =
-  element creator { 
-    attribute role { text },
-    technical-committee,
-    subcommittee?,
-    workgroup?,
-    secretariat?
-  }
-
-type =
-  element type {
-     ( "international-standard" | "technical-specification" | 
-       "technical-report" | "publicly-available-specification" | 
-        "international-workshop-agreement" | "guide" )
-  }
+# Do not constrain in XML: add to validation
+# type =
+  # element type {
+     # ( "international-standard" | "technical-specification" | 
+       # "technical-report" | "publicly-available-specification" | 
+        # "international-workshop-agreement" | "guide" )
+  # }
 
 status =
   element status {
-     stage,
-     substage?
+    FormattedString |
+     ( stage, substage? )
   }
 
 stage = 
@@ -116,10 +111,10 @@ workgroup =
 secretariat =
   element secretariat { text }
 
-title = 
+btitle = 
   element title { 
-    attribute language { text }, 
-    title-intro?, title-main, title-part? 
+     text | 
+    ( title-intro?, title-main, title-part? )
 }
 
 title-intro =
@@ -279,17 +274,6 @@ Clause-Section =
        clause-subsection+
     )
 
-
-BibliographicItem =
-     attribute id { xsd:ID },
-     attribute type { "article" | "book" | "booklet" | "conference" | "manual" |
-                      "proceedings" | "presentation" | "thesis" | "techreport" |
-                      "standard" | "unpublished" }?,
-    (bname | formatted), source?, publishdate?, docidentifier*, accesseddate?, creator*,
-    publisher*, edition?,
-    biblionote*, partof*, creationdate?, language*, script*, abstract?
-
-
 # }
 
 

data/lib/asciidoctor/iso/lists.rb

@@ -7,12 +7,12 @@ module Asciidoctor
           style(item, item.text)
           if item.blocks?
             xml_li.p **id_attr(item) do |t|
-              t << item.text 
+              t << item.text
             end
             xml_li << item.content
           else
             xml_li.p **id_attr(item) do |p|
-              p << item.text 
+              p << item.text
             end
           end
         end
@@ -31,40 +31,41 @@ module Asciidoctor
       end
 
       def iso_publisher(t)
-        t.publisher **{ role: "publisher" } do |p|
-          p.affiliation do |aff|
+        t.contributor do |c|
+          c.role **{ type: "publisher" } 
+          c.organization do |aff|
             aff.name "ISO"
           end
         end
       end
 
-      def isorefmatches(xml, matched)
-        ref_attributes = { id: matched[:anchor], type: "standard" }
+      def isorefmatches(xml, m)
+        ref_attributes = { id: m[:anchor], type: "standard" }
         xml.bibitem **attr_code(ref_attributes) do |t|
-          t.name { |i| i << ref_normalise(matched[:text]) }
-          t.publishDate matched[:year] if matched[:year]
-          t.docidentifier matched[:code]
+          t.title **{ format: "text/plain" } { |i| i << ref_normalise(m[:text]) }
+          t.docidentifier m[:code]
+          t.date m[:year], { type: "published" } if m[:year]
           iso_publisher(t)
         end
       end
 
-      def isorefmatches2(xml, matched)
-        ref_attributes = { id: matched[:anchor], type: "standard" }
+      def isorefmatches2(xml, m)
+        ref_attributes = { id: m[:anchor], type: "standard" }
         xml.bibitem **attr_code(ref_attributes) do |t|
-          t.name { |i| i << ref_normalise(matched[:text]) }
-          t.publishDate "--"
-          t.docidentifier matched[:code]
+          t.title **{ format: "text/plain" } { |i| i << ref_normalise(m[:text]) }
+          t.docidentifier m[:code]
+          t.date "--", { type: "published" }
           iso_publisher(t)
-          t.note { |p| p << "ISO DATE: #{matched[:fn]}" }
+          t.note **{ format: "text/plain" } { |p| p << "ISO DATE: #{m[:fn]}" }
         end
       end
 
-      def isorefmatches3(xml, matched)
-        ref_attributes = { id: matched[:anchor], type: "standard" }
+      def isorefmatches3(xml, m)
+        ref_attributes = { id: m[:anchor], type: "standard" }
         xml.bibitem **attr_code(ref_attributes) do |t|
-          t.name { |i| i << ref_normalise(matched[:text]) }
-          t.publishDate matched[:year] if matched[:year]
-          t.docidentifier "#{matched[:code]}:All Parts"
+          t.title **{ format: "text/plain" } { |i| i << ref_normalise(m[:text]) }
+          t.docidentifier "#{m[:code]}:All Parts"
+          t.date m[:year], { type: "published" } if m[:year]
           iso_publisher(t)
         end
       end
@@ -74,7 +75,9 @@ module Asciidoctor
         if m.nil? then Utils::warning(node, "no anchor on reference", item)
         else
           xml.bibitem **attr_code(id: m[:anchor]) do |t|
-            t.formatted { |i| i << ref_normalise_no_format(m[:text]) }
+            t.formattedref  **{ format: "application/x-isodoc+xml" } do |i| 
+              i << ref_normalise_no_format(m[:text]) 
+            end
             code = m[:code]
             code = "[#{code}]" if /^\d+$?/.match? code
             t.docidentifier code
@@ -96,15 +99,15 @@ module Asciidoctor
       end
 
       ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[ISO\s(?<code>[0-9-]+)(:(?<year>[0-9]+))?\]</ref>,?\s
+      \[(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+)(:(?<year>[0-9]+))?\]</ref>,?\s
       (?<text>.*)$}xm
 
       ISO_REF_NO_YEAR = %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[ISO\s(?<code>[0-9-]+):--\]</ref>,?\s?
+      \[(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+):--\]</ref>,?\s?
       <fn[^>]*>\s*<p>(?<fn>[^\]]+)</p>\s*</fn>,?\s?(?<text>.*)$}xm
 
       ISO_REF_ALL_PARTS = %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[ISO\s(?<code>[0-9]+)\s\(all\sparts\)\]</ref>(<p>)?,?\s?
+      \[(?<code>(ISO|IEC)[^0-9]*\s[0-9]+)\s\(all\sparts\)\]</ref>(<p>)?,?\s?
       (?<text>.*)(</p>)?$}xm
 
       NON_ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
@@ -122,9 +125,8 @@ module Asciidoctor
         elsif !matched3.nil? then isorefmatches3(xml, matched3)
         end
         if matched3.nil? && matched2.nil? && matched.nil? && normative
-          Utils::warning(node, 
-                         "non-ISO/IEC reference not expected as normative",
-                         item)
+          w = "non-ISO/IEC reference not expected as normative"
+          Utils::warning(node, w, item)
         end
       end
 
@@ -169,7 +171,7 @@ module Asciidoctor
           return
         end
         xml_dl.dd do |xml_dd|
-          style(dd, dd.text)
+          style(dd, dd.text) if dd.text?
           xml_dd.p { |t| t << dd.text } if dd.text?
           xml_dd << dd.content if dd.blocks?
         end

data/lib/asciidoctor/iso/macros.rb

@@ -0,0 +1,37 @@
+require 'asciidoctor/extensions'
+module Asciidoctor
+  module ISO
+    class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :alt
+      parse_content_as :text
+      using_format :short
+
+      def process parent, target, attrs
+        %{<admitted>#{Asciidoctor::Inline.new(parent, :quoted, attrs['text']).convert}</admitted>}
+      end
+    end
+
+    class DeprecatedTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :deprecated
+      parse_content_as :text
+      using_format :short
+
+      def process parent, target, attrs
+        %{<deprecates>#{attrs["text"]}</deprecates>}
+      end
+    end
+
+    class DomainTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :domain
+      parse_content_as :text
+      using_format :short
+
+      def process parent, target, attrs
+        %{<domain>#{attrs["text"]}</domain>}
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/section.rb

@@ -131,7 +131,7 @@ module Asciidoctor
       end
 
       def introduction_parse(attrs, xml, node)
-        xml.content **attr_code(attrs) do |xml_section|
+        xml.introduction **attr_code(attrs) do |xml_section|
           xml_section.title = "Introduction"
           content = node.content
           xml_section << content

data/lib/asciidoctor/iso/utils.rb

@@ -97,6 +97,15 @@ module Asciidoctor
         end.to_h
       end
 
+      # if the contents of node are blocks, output them to out;
+      # else, wrap them in <p>
+      def wrap_in_para(node, out)
+        if node.blocks? then out << node.content
+        else
+          out.p { |p| p << node.content }
+        end
+      end
+
     end
   end
 end

data/lib/asciidoctor/iso/validate.rb

@@ -1,5 +1,6 @@
 require "asciidoctor/iso/utils"
-require_relative './validate_style.rb'
+require_relative "./validate_style.rb"
+require_relative "./validate_section.rb"
 require "nokogiri"
 require "jing"
 require "pp"
@@ -7,10 +8,9 @@ require "pp"
 module Asciidoctor
   module ISO
     module Validate
-
       def title_intro_validate(root)
-        title_intro_en = root.at("//title[@language='en']/title-intro")
-        title_intro_fr = root.at("//title[@language='fr']/title-intro")
+        title_intro_en = root.at("//title-intro[@language='en']")
+        title_intro_fr = root.at("//title-intro[@language='fr']")
         if title_intro_en.nil? && !title_intro_fr.nil?
           warn "No English Title Intro!"
         end
@@ -20,8 +20,8 @@ module Asciidoctor
       end
 
       def title_part_validate(root)
-        title_part_en = root.at("//title[@language='en']/title-part")
-        title_part_fr = root.at("//title[@language='fr']/title-part")
+        title_part_en = root.at("//title-part[@language='en']")
+        title_part_fr = root.at("//title-part[@language='fr']")
         if title_part_en.nil? && !title_part_fr.nil?
           warn "No English Title Part!"
         end
@@ -33,11 +33,11 @@ module Asciidoctor
       def title_names_type_validate(root)
         doctypes = /International\sStandard | Technical\sSpecification |
         Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
-        title_main_en = root.at("//title[@language='en']/title-main")
+        title_main_en = root.at("//title-main[@language='en']")
         if doctypes.match? title_main_en.text
           warn "Main Title may name document type"
         end
-        title_intro_en = root.at("//title[@language='en']/title-intro")
+        title_intro_en = root.at("//title-intro[@language='en']")
         if !title_intro_en.nil? && doctypes.match?(title_intro_en.text)
           warn "Part Title may name document type"
         end
@@ -54,121 +54,12 @@ module Asciidoctor
         root.xpath(q).each do |c|
           next unless c.xpath("../subsection").size == 1
           title = c.at("./title")
-          location = if c["id"].nil? && title.nil?
-                       c.text[0..60] + "..."
-                     else
-                       c["id"]
-                     end
-          location += ":#{title.text}" unless title.nil?
+          location = c["id"] || c.text[0..60] + "..."
+          location += ":#{title.text}" if c["id"] && !title.nil?
           warn "ISO style: #{location}: subsection is only child"
         end
       end
 
-      def foreword_validate(root)
-        f = root.at("//content[title = 'Foreword']")
-        s = f.at("./subsection")
-        warn "ISO style: foreword contains subsections" unless s.nil?
-      end
-
-      def normref_validate(root)
-        f = root.at("//references[title = 'Normative References']")
-        f.at("./references") and
-          warn "ISO style: normative references contains subsections"
-      end
-
-      def symbols_validate(root)
-        f = root.at("//clause[title = 'Symbols and Abbreviations']") 
-        return if f.nil?
-        f.elements do |e|
-          unless e.name == "dl"
-            warn "ISO style: Symbols and Abbreviations can only contain "\
-              "a definition list"
-            return
-          end
-        end
-      end
-
-      def seqcheck(names, msg, accepted)
-        n = names.shift
-        unless accepted.include? n
-          warn "ISO style: #{msg}"
-          names = []
-        end
-        names
-      end
-
-      # spec of permissible section sequence
-      SEQ = [
-        {
-          msg: "Initial section must be (content) Foreword",
-          val:  [{ tag: "content", title: "Foreword" }],
-        },
-        {
-          msg: "Prefatory material must be followed by (clause) Scope",
-          val:  [{ tag: "content", title: "Introduction" },
-                 { tag: "clause", title: "Scope" }],
-        },
-        {
-          msg: "Prefatory material must be followed by (clause) Scope",
-          val: [{ tag: "clause", title: "Scope" }],
-        },
-        {
-          msg: "Scope must be followed by Normative References",
-          val: [{ tag: "references", title: "Normative References" }]
-        },
-        { 
-          msg: "Normative References must be followed by "\
-          "Terms and Definitions",
-          val: [
-            { tag: "terms", title: "Terms and Definitions" },
-            { tag: "terms", 
-              title: "Terms, Definitions, Symbols and Abbreviations" }
-          ]
-        },
-      ]
-
-      def sections_sequence_validate(root)
-        f = root.xpath(" //sections/content | //sections/terms | "\
-                       "//sections/clause | //sections/references | "\
-                       "//sections/annex")
-        names = f.map { |s| { tag: s.name, title: s.at("./title").text } }
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) or return
-        n = names[0]
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) or return
-        if n == { tag: "content", title: "Introduction" }
-          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) or return
-        end
-        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) or return
-        names = seqcheck(names, SEQ[4][:msg], SEQ[4][:val]) or return
-        n = names.shift
-        if n == { tag: "clause", title: "Symbols and Abbreviations" }
-          n = names.shift or return
-        end
-        n[:tag] == "clause" or
-          warn "ISO style: Document must contain at least one clause"
-        n == { tag: "clause", title: "Scope" } and
-          warn "ISO style: Scope must occur before Terms and Definitions"
-        n = names.shift or return
-        while n[:tag] == "clause"
-          n[:title] == "Scope" and
-            warn "ISO style: Scope must occur before Terms and Definitions"
-          n[:title] == "Symbols and Abbreviations" and
-            warn "ISO style: Symbols and Abbreviations must occur "\
-            "right after Terms and Definitions"
-          n = names.shift or return
-        end
-        unless n[:tag] == "annex" or n[:tag] == "references"
-          warn "ISO style: Only annexes and references can follow clauses"
-        end
-        while n[:tag] == "annex"
-          n = names.shift or return
-        end
-        n == { tag: "references", title: "Bibliography" } or
-          warn "ISO style: Final section must be (references) Bibliography"
-        names.empty? or
-          warn "ISO style: There are sections after the final Bibliography"
-      end
-
       def iso8601_validate(root)
         root.xpath("//review/@date | //revision-date").each do |d|
           /^\d{8}(T\d{4,6})?$/.match? d.text or
@@ -176,8 +67,22 @@ module Asciidoctor
         end
       end
 
+      def isosubgroup_validate(root)
+        root.xpath("//technical-committee/@type").each do |t|
+          unless %w{TC PC JTC JPC}.include? t.text
+            warn "ISO: invalid technical committee type #{t}"
+          end
+        end
+        root.xpath("//subcommittee/@type").each do |t|
+          unless %w{SC JSC}.include? t.text
+            warn "ISO: invalid subcommittee type #{t}"
+          end
+        end
+      end
+
       def content_validate(doc)
         title_validate(doc.root)
+        isosubgroup_validate(doc.root)
         foreword_validate(doc.root)
         normref_validate(doc.root)
         symbols_validate(doc.root)
@@ -199,9 +104,25 @@ module Asciidoctor
         end
       end
 
+      # RelaxNG cannot cope well with wildcard attributes. So we strip
+      # any attributes from FormattedString instances (which can contain
+      # xs:any markup, and are signalled with @format) before validation.
+      def formattedstr_strip(doc)
+        doc.xpath("//*[@format]").each do |n|
+          n.elements.each do |e|
+            e.traverse do |e1|
+              next unless e1.element?
+              e1.each { |k, v| e.delete(k) }
+            end
+          end
+        end
+        doc
+      end
+
       def validate(doc)
         content_validate(doc)
-        schema_validate(doc, File.join(File.dirname(__FILE__), "isostandard.rng"))
+        schema_validate(formattedstr_strip(doc.dup), 
+                        File.join(File.dirname(__FILE__), "isostandard.rng"))
       end
     end
   end