metanorma-iso 1.1.3 → 1.1.4

data/docs/styling-output-html.adoc

@@ -2,7 +2,7 @@
 
 [TIP]
 ====
-* Clone the metanorma-sample gem: https://github.com/riboseinc/metanorma-sample.
+* Clone the metanorma-sample gem: https://github.com/metanorma/metanorma-sample.
 * Edit the `html_sample_titlepage.html` and `html_sample_intro.html` pages to match your organisation's branding.
 ** Leave the Liquid Template instructions alone (`{{`, `{%`) unless you know what you're doing with them: they are how the pages are populated with metadata.
 * Edit the `default_fonts()` method in your `IsoDoc::...::HtmlConvert` class, to match your desired fonts.

data/docs/styling-output-msword.adoc

@@ -4,7 +4,7 @@
 ====
 * There is no quick way of doing this.
 * Everything you can do in Word, you can do in Word HTML. Save Word documents as Word HTML to see how.
-* Clone the metanorma-sample gem: https://github.com/riboseinc/metanorma-sample.
+* Clone the metanorma-sample gem: https://github.com/metanorma/metanorma-sample.
 * Edit the `word_sample_titlepage.html` and `word_sample_intro.html` pages to match your organisation's branding. With lots of iterations of saving Word documents as HTML, for trial and error.
 ** Leave the Liquid Template instructions alone (`{{`, `{%`) unless you know what you're doing with them: they are how the pages are populated with metadata.
 * Edit the `default_fonts()` method in your `IsoDoc::...::WordConvert` class, to match your desired fonts.
@@ -12,9 +12,9 @@
 * Edit the `wordstyle.scss` and `sample.scss` stylesheets to match your organisation's branding. With lots of iterations of saving Word documents as HTML, for trial and error.
 ====
 
-Word output in the document toolset is generated through Word HTML, the variant of HTML that you get when you save a Word document as HTML. (That is why documents are saved in `.doc`, not `.docx`.) This has the advantage over https://en.wikipedia.org/wiki/Office_Open_XML[OOXML], the native markup of DOCX, of using a well-known markup language, with a low barrier to entry: if you want to work out how to do something in Word HTML, do it in Word, save the document as HTML, and open up the HTML in a text editor. (For more on the choice of using Word HTML, see https://github.com/riboseinc/html2doc/wiki/Why-not-docx%3F.)
+Word output in the document toolset is generated through Word HTML, the variant of HTML that you get when you save a Word document as HTML. (That is why documents are saved in `.doc`, not `.docx`.) This has the advantage over https://en.wikipedia.org/wiki/Office_Open_XML[OOXML], the native markup of DOCX, of using a well-known markup language, with a low barrier to entry: if you want to work out how to do something in Word HTML, do it in Word, save the document as HTML, and open up the HTML in a text editor. (For more on the choice of using Word HTML, see https://github.com/metanorma/html2doc/wiki/Why-not-docx%3F.)
 
-However Word HTML is not quite the HTML you are used to: it is a restricted, syntactically idiosyncratic variant of HTML 4, with a non-standard and weakened form of CSS. Doing any styling in Word HTML involves lots of trial and error, and paying close attention to how Word HTML does things in its CSS. We have documented a few of the clearer gotchas in https://github.com/riboseinc/html2doc/blob/master/README.adoc.
+However Word HTML is not quite the HTML you are used to: it is a restricted, syntactically idiosyncratic variant of HTML 4, with a non-standard and weakened form of CSS. Doing any styling in Word HTML involves lots of trial and error, and paying close attention to how Word HTML does things in its CSS. We have documented a few of the clearer gotchas in https://github.com/metanorma/html2doc/blob/master/README.adoc.
 
 It's still better than learning OOXML.
 

data/lib/asciidoctor/iso/biblio.rng

@@ -156,9 +156,9 @@
       <zeroOrMore>
         <ref name="contact"/>
       </zeroOrMore>
-      <optional>
+      <zeroOrMore>
         <ref name="uri"/>
-      </optional>
+      </zeroOrMore>
     </element>
   </define>
   <define name="fullname">
@@ -246,9 +246,9 @@
       <optional>
         <ref name="abbreviation"/>
       </optional>
-      <optional>
+      <zeroOrMore>
         <ref name="uri"/>
-      </optional>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="org-identifier"/>
       </zeroOrMore>
@@ -469,12 +469,13 @@
       <value>film</value>
       <value>video</value>
       <value>broadcast</value>
-      <value>graphic work</value>
+      <value>graphic_work</value>
       <value>music</value>
       <value>patent</value>
       <value>inbook</value>
       <value>incollection</value>
       <value>inproceedings</value>
+      <value>journal</value>
     </choice>
   </define>
   <define name="BibliographicItem">
@@ -739,39 +740,44 @@
     <element name="series">
       <optional>
         <attribute name="type">
-          <choice>
-            <value>main</value>
-            <value>alt</value>
-          </choice>
+          <ref name="SeriesType"/>
         </attribute>
       </optional>
       <choice>
-        <ref name="btitle"/>
         <ref name="formattedref"/>
+        <group>
+          <ref name="btitle"/>
+          <optional>
+            <ref name="bplace"/>
+          </optional>
+          <optional>
+            <ref name="seriesorganization"/>
+          </optional>
+          <optional>
+            <ref name="abbreviation"/>
+          </optional>
+          <optional>
+            <ref name="seriesfrom"/>
+          </optional>
+          <optional>
+            <ref name="seriesto"/>
+          </optional>
+          <optional>
+            <ref name="seriesnumber"/>
+          </optional>
+          <optional>
+            <ref name="seriespartnumber"/>
+          </optional>
+        </group>
       </choice>
-      <optional>
-        <ref name="bplace"/>
-      </optional>
-      <optional>
-        <ref name="seriesorganization"/>
-      </optional>
-      <optional>
-        <ref name="abbreviation"/>
-      </optional>
-      <optional>
-        <ref name="seriesfrom"/>
-      </optional>
-      <optional>
-        <ref name="seriesto"/>
-      </optional>
-      <optional>
-        <ref name="seriesnumber"/>
-      </optional>
-      <optional>
-        <ref name="seriespartnumber"/>
-      </optional>
     </element>
   </define>
+  <define name="SeriesType">
+    <choice>
+      <value>main</value>
+      <value>alt</value>
+    </choice>
+  </define>
   <define name="seriesorganization">
     <element name="organization">
       <text/>
@@ -849,6 +855,7 @@
           <value>includes</value>
           <value>instance</value>
           <value>partOf</value>
+          <value>hasDraft</value>
         </choice>
       </attribute>
       <element name="bibitem">
@@ -861,9 +868,6 @@
   </define>
   <define name="version">
     <element name="version">
-      <optional>
-        <ref name="vedition"/>
-      </optional>
       <optional>
         <ref name="revision-date"/>
       </optional>

data/lib/asciidoctor/iso/isodoc.rng

@@ -18,6 +18,7 @@
   of this.
 -->
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <include href="reqt.rng"/>
   <include href="biblio.rng">
     <define name="status">
       <element name="status">

data/lib/asciidoctor/iso/reqt.rng

@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/iso/validate_requirements.rb

@@ -23,7 +23,7 @@ module Asciidoctor
         Regexp.new(REQUIREMENT_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
                    Regexp::IGNORECASE)
 
-      def requirement(text)
+      def requirement_check(text)
         text.split(/\.\s+/).each do |t|
           return t if REQUIREMENT_RE.match t
         end
@@ -41,7 +41,7 @@ module Asciidoctor
         Regexp.new(RECOMMENDATION_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
                    Regexp::IGNORECASE)
 
-      def recommendation(text)
+      def recommendation_check(text)
         text.split(/\.\s+/).each do |t|
           return t if RECOMMENDATION_RE.match t
         end
@@ -60,7 +60,7 @@ module Asciidoctor
         Regexp.new(PERMISSION_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
                    Regexp::IGNORECASE)
 
-      def permission(text)
+      def permission_check(text)
         text.split(/\.\s+/).each do |t|
           return t if PERMISSION_RE.match t
         end
@@ -93,11 +93,11 @@ module Asciidoctor
       end
 
       def style_no_guidance(node, text, docpart)
-        r = requirement(text)
+        r = requirement_check(text)
         style_warning(node, "#{docpart} may contain requirement", r) if r
-        r = permission(text)
+        r = permission_check(text)
         style_warning(node, "#{docpart} may contain permission", r) if r
-        r = recommendation(text)
+        r = recommendation_check(text)
         style_warning(node, "#{docpart} may contain recommendation", r) if r
       end
     end

data/lib/asciidoctor/iso/validate_style.rb

@@ -26,13 +26,13 @@ module Asciidoctor
 
       def introduction_style(node)
         return if @novalid
-        r = requirement(extract_text(node))
+        r = requirement_check(extract_text(node))
         style_warning(node, "Introduction may contain requirement", r) if r
       end
 
       def definition_style(node)
         return if @novalid
-        r = requirement(extract_text(node))
+        r = requirement_check(extract_text(node))
         style_warning(node, "Definition may contain requirement", r) if r
       end
 

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

@@ -18,9 +18,21 @@
 <p class="coverpage_techcommittee"><a
 name="CVP_Secretariat_Loca">Secretariat</a>: {{ secretariat }}</p>
 
-<div class="doctitle-en"><span class="title">{{ doctitleintro }}</span> <span class="subtitle">{{ doctitlemain }}</span> <span class="part">{{ doctitlepart }}</span></div>
+<div class="doctitle-en"><div><span class="title">{{ doctitleintro }}{% if doctitleintro and doctitlemain %} &mdash; {% endif %}</span><span class="subtitle">{{ doctitlemain }}{% if doctitlemain and doctitlepart %} &mdash;{% endif %}</span>
+  {% if doctitlepart %}
+</div><div>
+  {% if doctitlepartlabel %}<span class="partlabel">{{ doctitlepartlabel }}: </span>{% endif %}
+  <span class="part">{{ doctitlepart }}</span>
+  {% endif %}
+</div></div>
 
-<div class="doctitle-fr"><span class="title">{{ docsubtitleintro }}</span> <span class="subtitle">{{ docsubtitlemain }}</span> <span class="part">{{ docsubtitlepart }}</span></div>
+<div class="doctitle-fr"><div><span class="title">{{ docsubtitleintro }}{% if docsubtitleintro and docsubtitlemain %} &mdash; {% endif %}</span><span class="subtitle">{{ docsubtitlemain }}{% if docsubtitlemain and docsubtitlepart %} &mdash;{% endif %}</span>
+  {% if docsubtitlepart %}
+  </div><div>
+  {% if docsubtitlepartlabel %}<span class="partlabel">{{ docsubtitlepartlabel }}: </span>{% endif %}
+  <span class="part">{{ docsubtitlepart }}</span>
+  {% endif %}
+</div></div>
 
 <div class="coverpage_docstage">
   {% if unpublished %}

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

@@ -526,7 +526,7 @@ table.MsoISOTable
 	mso-para-margin-bottom:.0001pt;
 	mso-pagination:widow-orphan;
 	border-collapse:collapse;
-	mso-table-layout-alt:fixed;
+	/*mso-table-layout-alt:fixed;*/
 	border:solid windowtext 2pt;
 	mso-border-alt:solid windowtext 2pt;
 	mso-yfti-tbllook:480;

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

@@ -157,7 +157,7 @@ main {
 .doctitle-en {
     padding-left: 3em;
     margin-left: -3em;
-    padding-top: 2em;
+    /*padding-top: 2em;*/
     padding-bottom: 2em;
     
 }
@@ -165,7 +165,6 @@ main {
 .doctitle-en span {
     font-size: 2em;
     line-height: 1.5em;
-    display: block;
 }
 
 
@@ -173,14 +172,23 @@ main {
     font-size: 1.5em;
     line-height: 1.2em;
     font-style: italic;
-    display: block;
 }
 
+/*
 span.title {
     text-transform: uppercase;
     font-size: 1em;
     font-weight: 800;
 }
+*/
+
+span.title, span.subtitle, span.part {
+    font-weight: 800;
+}
+
+span.partlabel {
+  display: block;
+}
 
 .coverpage_docstage {
     margin-top: 2em;