metanorma-iso 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb8e2d8ba55d114b48bbf4439f9cc41cc5a81a849e381f036e1fcf891cb8ea28
-  data.tar.gz: 4a9af511a463c8a6cb671b9f35c29484cd9db28bcb5bfd18aa37f8f90379e269
+  metadata.gz: 74f562a97f61ede014047ff5de43c57d8bb2533f5f6af5c66c5dffb6e1d3258d
+  data.tar.gz: 8b1580aec30059481d83adf7332739af65e401829aafb0231733c38d108c1dc5
 SHA512:
-  metadata.gz: 48c16952ec194912088f9c1659118a1a6afa744f589cc9c7300b194612d5a011380f3d26954356db43289e70a9558143b2f0d18f59c84560926794edf9bfa789
-  data.tar.gz: 8dcd77c06ab8e11eb0ca051a11ea7760b8d7355e0488891f2c45026f30fd74de1d733ff9f83d10b04d999fd443e8b871819c5b5edfcabb95a57062aa12ee8921
+  metadata.gz: 7a410beff5aa39e6d68283e207d16e9ee8d35e593bac34475aa8b8b22bc134dcf6394fc11dee3f5fc7495fb28ec3685167d5da848927d8ae8778e3b04ff76e7a
+  data.tar.gz: 2e5a08f9f9d6da7bc9bf72fa0352324c38eaac424bc5decbf133550ed5adf662a1d8bcc944e1316809132a0528ca581d8511f73af12160d25049a7e35052488f

data/lib/asciidoctor/iso/cleanup.rb

@@ -52,9 +52,44 @@ module Asciidoctor
         prefix = get_id_prefix(xmldoc)
         id = xmldoc.at("//bibdata/docidentifier[@type = 'iso']") or return
         id.content = id_prefix(prefix, id)
-        id = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") or return
+        id = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") or
+          return
         id.content = id_prefix(prefix, id)
       end
+
+      PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
+
+      def pub_class(bib)
+        return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
+        return 1 if bib.at("#{PUBLISHER}[name = 'International Organization "\
+                           "for Standardization']")
+        return 2 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
+        return 2 if bib.at("#{PUBLISHER}[name = 'International "\
+                           "Electrotechnical Commission']")
+        return 3 if bib.at("./docidentifier[@type][not(@type = 'DOI')]"\
+                           "[not(@type = 'metanorma')]")
+        return 3 if bib.at("./docidentifier[not(@type)]") &&
+          !bib.at("./docidentifier[@type]")
+        4
+      end
+
+      def sort_biblio(bib)
+        bib.sort do |a, b|
+          sort_biblio_key(a) <=> sort_biblio_key(b)
+        end
+      end
+
+      # TODO sort by authors
+      def sort_biblio_key(bib)
+        pubclass = pub_class(bib)
+        num = bib&.at("./docnumber")&.text
+        id = bib&.at("./docidentifier[not(@type = 'metanorma')]"\
+                     "[not(@type = 'DOI')]")
+        type = id['type'] if id
+        title = bib&.at("./title[@type = 'main']")&.text ||
+          bib&.at("./title")&.text || bib&.at("./formattedref")&.text
+        "#{pubclass} :: #{num} :: #{type} :: #{id&.text} :: #{title}"
+      end
     end
   end
 end

data/lib/asciidoctor/iso/reqt.rng

@@ -87,7 +87,7 @@
     </element>
   </define>
   <define name="reqinherit">
-    <element name="subject">
+    <element name="inherit">
       <text/>
     </element>
   </define>

data/lib/asciidoctor/iso/validate.rb

@@ -41,6 +41,7 @@ module Asciidoctor
           warn("No French Title Part!")
       end
 
+      # ISO/IEC DIR 2, 11.4
       def title_subpart_validate(root)
         docid = root.at("//bibdata/docidentifier[@type = 'iso']")
         subpart = /-\d+-\d+/.match docid
@@ -50,6 +51,7 @@ module Asciidoctor
         warn("Subpart defined on non-IEC document!") if subpart && !iec
       end
 
+      # ISO/IEC DIR 2, 11.5.2
       def title_names_type_validate(root)
         doctypes = /International\sStandard | Technical\sSpecification |
         Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
@@ -63,6 +65,7 @@ module Asciidoctor
         end
       end
 
+      # ISO/IEC DIR 2, 22.2
       def title_first_level_validate(root)
         root.xpath(SECTIONS_XPATH).each do |s|
           title = s&.at("./title")&.text || s.name
@@ -74,6 +77,7 @@ module Asciidoctor
         end
       end
 
+      # ISO/IEC DIR 2, 22.2
       def title_all_siblings(xpath, label)
         notitle = false
         withtitle = false
@@ -98,6 +102,7 @@ module Asciidoctor
         title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
       end
 
+      # ISO/IEC DIR 2, 22.3.2
       def onlychild_clause_validate(root)
         root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
           next unless c.xpath("../clause").size == 1
@@ -121,11 +126,12 @@ module Asciidoctor
         end
       end
 
+      # ISO/IEC DIR 2, 15.5.3
       def see_xrefs_validate(root)
         root.xpath("//xref").each do |t|
           # does not deal with preceding text marked up
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\bsee\s*$/mi.match(preceding)
+          next unless !preceding.nil? && /\b(see| refer to)\s*$/mi.match(preceding)
           (target = root.at("//*[@id = '#{t['target']}']")) || next
           if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
             warn "ISO: 'see #{t['target']}' is pointing to a normative section"
@@ -133,10 +139,11 @@ module Asciidoctor
         end
       end
 
+      # ISO/IEC DIR 2, 15.5.3
       def see_erefs_validate(root)
         root.xpath("//eref").each do |t|
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\bsee\s*$/mi.match(preceding)
+          next unless !preceding.nil? && /\b(see|refer to)\s*$/mi.match(preceding)
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
             warn "ISO: '#{t} is not pointing to a real reference"
             next
@@ -148,6 +155,7 @@ module Asciidoctor
         end
       end
 
+      # ISO/IEC DIR 2, 10.4
       def locality_erefs_validate(root)
         root.xpath("//eref[locality]").each do |t|
           if /^(ISO|IEC)/.match t["citeas"]
@@ -163,6 +171,7 @@ module Asciidoctor
         re.match(text) && warn("ISO style: #{term}: #{msg}")
       end
 
+      # ISO/IEC DIR 2, 16.5.6
       def termdef_style(xmldoc)
         xmldoc.xpath("//term").each do |t|
           para = t.at("./definition") || return
@@ -175,6 +184,7 @@ module Asciidoctor
         cited_term_style(xmldoc)
       end
 
+      # ISO/IEC DIR 2, 16.5.10
       def cited_term_style(xmldoc)
         xmldoc.xpath("//term//xref").each do |x|
           next unless xmldoc.at("//term[@id = '#{x['target']}']")

data/lib/asciidoctor/iso/validate_section.rb

@@ -13,12 +13,14 @@ module Asciidoctor
         super
       end
 
+      # ISO/IEC DIR 2, 12.4
       def foreword_validate(root)
         f = root.at("//foreword") || return
         s = f.at("./clause")
         warn "ISO style: foreword contains subclauses" unless s.nil?
       end
 
+      # ISO/IEC DIR 2, 15.4
       def normref_validate(root)
         f = root.at("//references[title = 'Normative References']") || return
         f.at("./references | ./clause") &&
@@ -150,13 +152,14 @@ module Asciidoctor
       end
 
       NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze
-      SCOPE_WARN = "Scope contains subclauses: should be succint".freeze
+      SCOPE_WARN = "Scope contains subclauses: should be succinct".freeze
 
       def section_style(root)
         foreword_style(root.at("//foreword"))
         introduction_style(root.at("//introduction"))
         scope_style(root.at("//clause[title = 'Scope']"))
         scope = root.at("//clause[title = 'Scope']/clause")
+        # ISO/IEC DIR 2, 14.4
         scope.nil? || style_warning(scope, SCOPE_WARN, nil)
       end
 
@@ -167,6 +170,7 @@ module Asciidoctor
       NORM_BIBITEMS =
         "//references[title = 'Normative References']/bibitem".freeze
 
+      # ISO/IEC DIR 2, 10.2
       def norm_bibitem_style(root)
         root.xpath(NORM_BIBITEMS).each do |b|
           if b.at(Standoc::Converter::ISO_PUBLISHER_XPATH).nil?

data/lib/asciidoctor/iso/validate_style.rb

@@ -14,40 +14,48 @@ module Asciidoctor
         ret
       end
 
+      # ISO/IEC DIR 2, 12.2
       def foreword_style(node)
         return if @novalid
         style_no_guidance(node, extract_text(node), "Foreword")
       end
 
+      # ISO/IEC DIR 2, 14.2
       def scope_style(node)
         return if @novalid
         style_no_guidance(node, extract_text(node), "Scope")
       end
 
+      # ISO/IEC DIR 2, 13.2
       def introduction_style(node)
         return if @novalid
         r = requirement_check(extract_text(node))
         style_warning(node, "Introduction may contain requirement", r) if r
       end
 
+      # ISO/IEC DIR 2, 16.5.6
       def definition_style(node)
         return if @novalid
         r = requirement_check(extract_text(node))
         style_warning(node, "Definition may contain requirement", r) if r
       end
 
+      # ISO/IEC DIR 2, 16.5.7
+      # ISO/IEC DIR 2, 25.5
       def example_style(node)
         return if @novalid
-        style_no_guidance(node, extract_text(node), "Term Example")
+        style_no_guidance(node, extract_text(node), "Example")
         style(node, extract_text(node))
       end
 
+      # ISO/IEC DIR 2, 24.5
       def note_style(node)
         return if @novalid
         style_no_guidance(node, extract_text(node), "Note")
         style(node, extract_text(node))
       end
 
+      # ISO/IEC DIR 2, 26.5
       def footnote_style(node)
         return if @novalid
         style_no_guidance(node, extract_text(node), "Footnote")
@@ -80,6 +88,8 @@ module Asciidoctor
         style_units(n, t)
       end
 
+      # ISO/IEC DIR 2, 9.1
+      # ISO/IEC DIR 2, Table B.1
       def style_number(n, t)
         style_two_regex_not_prev(n, t, /^(?<num>-?[0-9]{4,}[,0-9]*)$/,
                                  %r{(\bISO|\bIEC|\bIEEE/)$},
@@ -90,6 +100,7 @@ module Asciidoctor
                     "ambiguous number", n, t)
       end
 
+      # ISO/IEC DIR 2, 9.2.1
       def style_percent(n, t)
         style_regex(/\b(?<num>[0-9.,]+%)/,
                     "no space before percent sign", n, t)
@@ -97,6 +108,8 @@ module Asciidoctor
                     "unbracketed tolerance before percent sign", n, t)
       end
 
+      # ISO/IEC DIR 2, 8.4
+      # ISO/IEC DIR 2, 9.3
       def style_abbrev(n, t)
         style_regex(/(^|\s)(?!e\.g\.|i\.e\.)
                     (?<num>[a-z]{1,2}\.([a-z]{1,2}|\.))\b/ix,
@@ -110,6 +123,7 @@ module Asciidoctor
         "V|kV|W|MW|kW|F|μF|Ω|Wb|°C|lm|lx|Bq|Gy|Sv|kat|l|t|eV|u|Np|Bd|"\
         "bit|kB|MB|Hart|nat|Sh|var)".freeze
 
+      # ISO/IEC DIR 2, 9.3
       def style_units(n, t)
         style_regex(/\b(?<num>[0-9][0-9,]*\s+[\u00b0\u2032\u2033])/,
                     "space between number and degrees/minutes/seconds", n, t)
@@ -123,6 +137,7 @@ module Asciidoctor
         "lit": "l", "amp": "A", "amps": "A", "rpm": "r/min"
       }.freeze
 
+      # ISO/IEC DIR 2, 9.3
       def style_non_std_units(n, t)
         NONSTD_UNITS.each do |k, v|
           style_regex(/\b(?<num>[0-9][0-9,]*\s+#{k})\b/,

data/lib/isodoc/iso/html/html_iso_titlepage.html

@@ -1,4 +1,4 @@
-    <div id='toggle'> <span>•</span> </div>
+<div id='toggle'> <span>•</span> </div>
     {% if tc_docnumber %}
 <p class="coverpage_docnumber">{{ tc_docnumber }}</p>
     {% else %}
@@ -44,7 +44,7 @@ name="CVP_Secretariat_Loca">Secretariat</a>: {{ secretariat }}</p>
 <div class="coverpage_warning">
 
 <p>Warning for WDs
-and CDs<o:p></o:p></span></b></p>
+and CDs</p>
 
 <p>This
 document is not an ISO International Standard. It is distributed for review and
@@ -55,8 +55,6 @@ an International Standard.</p>
 of this draft are invited to submit, with their comments, notification of any
 relevant patent rights of which they are aware and to provide supporting
 documentation.</p>
-{% endif %}
 
 </div>
-
-
+{% endif %}

data/lib/isodoc/iso/html/style-human.scss

@@ -489,7 +489,7 @@ p.document-type, p.document-stage {
     letter-spacing: 0.05em;
     margin:0;
     margin-left: 6px;
-    writing-mode:tb-rl;
+    writing-mode:vertical-rl;
 	-webkit-transform:rotate(180deg);
 	-moz-transform:rotate(180deg);
 	-o-transform: rotate(180deg);

data/lib/isodoc/iso/html/style-iso.scss

@@ -482,7 +482,7 @@ p.document-type, p.document-stage {
     letter-spacing: 0.05em;
     margin:0;
     margin-left: 6px;
-    writing-mode:tb-rl;
+    writing-mode:vertical-rl;
 	-webkit-transform:rotate(180deg);
 	-moz-transform:rotate(180deg);
 	-o-transform: rotate(180deg);

data/lib/isodoc/iso/html/wordstyle.scss

@@ -268,6 +268,7 @@ h2
 	tab-stops:list 36.0pt left 44.0pt;
 	font-size:11.0pt;
 	font-family:$headerfont;
+        font-weight:bold;
 	mso-fareast-font-family:$headerfont;
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
@@ -293,6 +294,7 @@ h3      {mso-list:l1 level3 lfo6;}
 	tab-stops:51.05pt 57.0pt 68.0pt;
 	font-size:11.0pt;
 	font-family:$headerfont;
+        font-weight:bold;
 	mso-fareast-font-family:$headerfont;
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
@@ -318,6 +320,7 @@ h4      {mso-list:l1 level4 lfo6;}
 	tab-stops:51.05pt list 54.0pt;
 	font-size:11.0pt;
 	font-family:$headerfont;
+        font-weight:bold;
 	mso-fareast-font-family:$headerfont;
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
@@ -343,6 +346,7 @@ h6
 	tab-stops:51.05pt list 72.0pt;
 	font-size:11.0pt;
 	font-family:$headerfont;
+        font-weight:bold;
 	mso-fareast-font-family:$headerfont;
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "1.2.4".freeze
+    VERSION = "1.3.0".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 1.5.7"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 0.10.0"
-  spec.add_dependency "metanorma-standoc", "~> 1.2.0"
+  spec.add_dependency "isodoc", "~> 1.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.3.0"
 
   spec.add_development_dependency "bundler", "~> 2.0.1"
   spec.add_development_dependency "byebug"

data/spec/asciidoctor-iso/cleanup_spec.rb

@@ -763,4 +763,167 @@ r = 1 %</stem>
 </iso-standard>
     OUTPUT
   end
+
+  it "reorders references in bibliography, and renumbers citations accordingly" do
+    expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
+    #{ASCIIDOC_BLANK_HDR}
+    
+    == Clause 1
+    <<ref1>>
+    <<ref2>>
+    <<ref3>>
+    <<ref4>>
+    <<ref5>>
+    <<ref6>>
+    <<ref7>>
+    <<ref8>>
+    <<ref9>>
+    <<ref10>>
+
+    [bibliography]
+    == Bibliography
+
+    [bibliography]
+    === Clause 1
+    * [[[ref3,IEC 123]]], _Standard IEC 123_
+    * [[[ref5,20]]], _Standard 10_
+    * [[[ref1,ISO 123]]], _Standard ISO 123_
+    * [[[ref4,GB 123]]], _Standard GB 123_
+    * [[[ref2,ISO/IEC 123]]], _Standard ISO/IEC 123_
+
+    [bibliography]
+    === {blank}
+    * [[[ref10,20]]], _Standard 10_
+    * [[[ref9,GB 123]]], _Standard GB 123_
+    * [[[ref8,IEC 123]]], _Standard IEC 123_
+    * [[[ref7,ISO 123]]], _Standard ISO 123_
+    * [[[ref6,ISO/IEC 123]]], _Standard ISO/IEC 123_
+    INPUT
+        #{BLANK_HDR}
+    <sections><clause id="_" inline-header="false" obligation="normative">
+         <title>Clause 1</title>
+         <p id="_"><eref type="inline" bibitemid="ref1" citeas="ISO 123"/>
+       <eref type="inline" bibitemid="ref2" citeas="ISO/IEC 123"/>
+       <eref type="inline" bibitemid="ref3" citeas="IEC 123"/>
+       <eref type="inline" bibitemid="ref4" citeas="GB 123"/>
+       <eref type="inline" bibitemid="ref5" citeas="[5]"/>
+       <eref type="inline" bibitemid="ref6" citeas="ISO/IEC 123"/>
+       <eref type="inline" bibitemid="ref7" citeas="ISO 123"/>
+       <eref type="inline" bibitemid="ref8" citeas="IEC 123"/>
+       <eref type="inline" bibitemid="ref9" citeas="GB 123"/>
+       <eref type="inline" bibitemid="ref10" citeas="[10]"/></p>
+       </clause>
+       </sections><bibliography><clause id="_" obligation="informative"><title>Bibliography</title><references id="_" obligation="informative">
+         <title>Clause 1</title><bibitem id="ref1" type="standard">
+         <title format="text/plain">Standard ISO 123</title>
+         <docidentifier>ISO 123</docidentifier>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem><bibitem id="ref2" type="standard">
+         <title format="text/plain">Standard ISO/IEC 123</title>
+         <docidentifier>ISO/IEC 123</docidentifier>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
+           </organization>
+         </contributor>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Electrotechnical Commission</name>
+             <abbreviation>IEC</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem><bibitem id="ref3" type="standard">
+         <title format="text/plain">Standard IEC 123</title>
+         <docidentifier>IEC 123</docidentifier>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Electrotechnical Commission</name>
+             <abbreviation>IEC</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem><bibitem id="ref4">
+         <formattedref format="application/x-isodoc+xml">
+           <em>Standard GB 123</em>
+         </formattedref>
+         <docidentifier>GB 123</docidentifier>
+       </bibitem><bibitem id="ref5">
+         <formattedref format="application/x-isodoc+xml">
+           <em>Standard 10</em>
+         </formattedref>
+         <docidentifier type="metanorma">[5]</docidentifier>
+       </bibitem>
+
+
+
+
+
+       </references>
+       <references id="_" obligation="informative">
+         <bibitem id="ref7" type="standard">
+         <title format="text/plain">Standard ISO 123</title>
+         <docidentifier>ISO 123</docidentifier>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem><bibitem id="ref6" type="standard">
+         <title format="text/plain">Standard ISO/IEC 123</title>
+         <docidentifier>ISO/IEC 123</docidentifier>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
+           </organization>
+         </contributor>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Electrotechnical Commission</name>
+             <abbreviation>IEC</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem><bibitem id="ref8" type="standard">
+         <title format="text/plain">Standard IEC 123</title>
+         <docidentifier>IEC 123</docidentifier>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Electrotechnical Commission</name>
+             <abbreviation>IEC</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem><bibitem id="ref9">
+         <formattedref format="application/x-isodoc+xml">
+           <em>Standard GB 123</em>
+         </formattedref>
+         <docidentifier>GB 123</docidentifier>
+       </bibitem><bibitem id="ref10">
+         <formattedref format="application/x-isodoc+xml">
+           <em>Standard 10</em>
+         </formattedref>
+         <docidentifier type="metanorma">[10]</docidentifier>
+       </bibitem>
+
+
+
+
+
+       </references></clause></bibliography>
+       </iso-standard>
+    OUTPUT
+  end
 end