metanorma-ogc 1.2.6 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4ede26f8e1b13ab6f0ad902f2bd43fa03e17ce923feae18c8e4b1af67418ea
-  data.tar.gz: 16f48b39d7afc5d0a3858a6643d76c96a42b402e9d1688fb56264fb69641efc0
+  metadata.gz: e15d1d5244c56742241206793480e35f4147e85f20718fe003da6b8609138b9e
+  data.tar.gz: 71fc5a1f0e1583e1b4de15b23626bdadbe6acc6e533824c33cf15b9f4dbf0578
 SHA512:
-  metadata.gz: 422db95a5b4b10a1241cf55efd7daaa4d4bba2e642c76e4455068fe3553cdf27e7e229e2c3ace03cfffdc2a93c1fccaae7b504db4e887ea4fea821664e7a5066
-  data.tar.gz: 66ccf79741efd88899f443b70c235794d6af2551e8fee4d57e5bb6319dc0b91751179f0b2a50c39920dd19f55638566cf7718d44ee21622e071415aad6993804
+  metadata.gz: c217d011a9b1177160d097c7e706d074ad6313daec50e36de1ff7d45c93d50d3b7a88ac0823cf2434ce5ca83f9532988ddd47e04497cfac144db541ff7c364cb
+  data.tar.gz: c963da6c2086b761979d59bcb38b157f34ea0ad6ea5f3739f6b240c95945f49424d5c4bf5a9dfaa7ceb9f030a854ae96b8d0933ebbd6e4629d2ccd97e60917df

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main  ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,14 +32,34 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
 
-      - name: Run specs
-        run: bundle exec rake
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/README.adoc

@@ -1,16 +1,15 @@
 = metanorma-ogc: Metanorma processor for the Open Geospatial Consortium document class
 
 image:https://img.shields.io/gem/v/metanorma-ogc.svg["Gem Version", link="https://rubygems.org/gems/metanorma-ogc"]
-image:https://github.com/metanorma/metanorma-ogc/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-ogc/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-ogc/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-ogc/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-ogc/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-ogc/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-ogc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-ogc/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-ogc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-ogc"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-ogc.svg["Pull Requests", link="https://github.com/metanorma/metanorma-ogc/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-ogc/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-ogc/releases"]
 
 == Functionality
 
-This gem processes Metanorma documents into the OGC document class.
+This gem processes https://www.metanorma.com[Metanorma documents] following
+a template for generating OGC standards and documents.
 
 It provides the following functions:
 

data/lib/asciidoctor/ogc/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -728,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
     </element>
   </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </element>
+  </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/ogc/boilerplate.xml

@@ -92,7 +92,7 @@
   </license-statement>
 
   <legal-statement>
-    {% if doctype == "Standard" or doctype == "Community Standard" %}
+    {% if doctype == "Standard" or doctype == "Community Standard" or doctype == "Abstract Specification" %}
     {% if stage == "Approved" or stage == "Withdrawn" %}
     <clause>
       <title>Warning</title>

data/lib/asciidoctor/ogc/converter.rb

@@ -127,7 +127,6 @@ module Asciidoctor
       end
 
       def termdef_boilerplate_cleanup(xmldoc)
-        return
       end
 
       def bibdata_cleanup(xmldoc)

data/lib/asciidoctor/ogc/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -47,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -141,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -233,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +777,18 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -801,6 +839,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -856,9 +897,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1028,6 +1071,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1081,6 +1127,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1183,6 +1232,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1511,6 +1563,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1541,6 +1594,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

data/lib/isodoc/ogc/base_convert.rb

@@ -7,7 +7,6 @@ module IsoDoc
   module Ogc
     module BaseConvert
       def cleanup(docxml)
-        #requirement_table_cleanup(docxml)
         super
         term_cleanup(docxml)
       end
@@ -36,7 +35,7 @@ module IsoDoc
         end
       end
 
-      def middle_clause
+      def middle_clause(_docxml)
         "//clause[parent::sections][not(@type = 'scope' or "\
         "@type = 'conformance')][not(descendant::terms)]"
       end
@@ -47,7 +46,7 @@ module IsoDoc
       end
 
       def middle(isoxml, out)
-        middle_title(out)
+        middle_title(isoxml, out)
         middle_admonitions(isoxml, out)
         i = scope isoxml, out, 0
         i = conformance isoxml, out, i

data/lib/isodoc/ogc/biblio.rb

@@ -12,6 +12,7 @@ module IsoDoc
         list.p **attr_code(iso_bibitem_entry_attrs(b, bibliography)) do |r|
           id = bibitem_ref_code(b)
           identifier = render_identifier(id)
+          identifier[1] = nil
           if bibliography
             ref_entry_code(r, ordinal, identifier, id)
           end

data/lib/isodoc/ogc/html/htmlstyle.css

@@ -264,11 +264,213 @@ a.FootnoteRef + a.FootnoteRef:before {
 #retired {
   border-bottom: solid 3px #7e0d13; }
 
+.coverpage-maturity, .coverpage-stage {
+  font-family: {{headerfont}};
+  font-weight: 400;
+  font-size: 1.3em;
+  margin: 0 0 2em 0;
+  text-transform: uppercase; }
+
+.icon-svg {
+  width: 100%;
+  color: #5ecf86; }
+
+.wrapper-top {
+  background: #00335b;
+  background: linear-gradient(130deg, #00335b 45%, #f1f8ff 100%);
+  color: #ffffff;
+  padding: 5em 0;
+  width: 100%; }
+
+.wrapper-top-bottom {
+  width: 0;
+  height: 0;
+  border-top: 100px solid #00335b;
+  border-right: 100px solid transparent;
+  position: absolute; }
+
+.document-type-band {
+  top: 260px; }
+
+.document-stage-band > :first-child {
+  height: 240px; }
+
+.coverpage-metadata {
+  margin-top: 35px;
+  padding-top: 15px;
+  margin-right: 25px;
+  border-top: solid 1px white; }
+
+.coverpage-metadata,
+.coverpage-alt-formats {
+  font-size: 12px;
+  font-family: {{headerfont}};
+  margin-left: 1em;
+  text-align: left; }
+  .coverpage-metadata span,
+  .coverpage-alt-formats span {
+    display: block;
+    text-align: left; }
+    .coverpage-metadata span a,
+    .coverpage-alt-formats span a {
+      color: white; }
+      .coverpage-metadata span a:hover,
+      .coverpage-alt-formats span a:hover {
+        text-decoration: underline;
+        background: none;
+        box-shadow: none !important;
+        font-weight: 400; }
+  .coverpage-metadata .value,
+  .coverpage-alt-formats .value {
+    font-size: 15px;
+    margin-bottom: 15px; }
+  .coverpage-metadata .label,
+  .coverpage-alt-formats .label {
+    font-size: 12px;
+    padding: 0; }
+
+.coverpage-alt-formats span {
+  display: inline;
+  text-align: left; }
+  .coverpage-alt-formats span a {
+    padding-right: 5px; }
+
+.coverpage-title {
+  padding-bottom: 0.5em;
+  font-family: {{headerfont}};
+  font-weight: 100;
+  padding-left: 1em;
+  padding-right: 1em; }
+  .coverpage-title span {
+    font-family: {{headerfont}};
+    font-size: 1.8em;
+    line-height: 1; }
+
+.docstage-box table {
+  width: auto; }
+
+.docstage-box th {
+  background-color: #93c0d6; }
+
+.docstage-box td {
+  vertical-align: top;
+  background-color: #daeef3;
+  padding: 0.5em;
+  border: 0; }
+
+.docstage-box th:first-child {
+  border-radius: 1em 0 0 0; }
+
+.docstage-box th:last-child {
+  border-radius: 0 1em 0 0; }
+
+.docstage-box tr:first-child {
+  border-radius: 0 0 0 1em; }
+
+.docstage-box tr:last-child {
+  border-radius: 0 1em 0 0; }
+
+.docstage-box tr:last-child > td:first-child {
+  border-radius: 0 0 0 1em; }
+
+.docstage-box tr:last-child > td:last-child {
+  border-radius: 0 0 1em 0; }
+
+.WordSection11 {
+  padding: 0 2em 0 3em; }
+
+.info-section {
+  padding: 0 2em 0 5em; }
+
+.prefatory-section {
+  padding: 0 3em 0 6em; }
+
+.zzSTDTitle1, .MsoCommentText {
+  display: none; }
+
+.coverpage {
+  text-align: center;
+  padding-left: 1.5em; }
+
+.coverpage-logo span, .coverpage-tc-name span {
+  font-family: {{bodyfont}};
+  text-transform: none;
+  font-weight: 300;
+  margin-left: 1em; }
+
+.coverpage-tc-name {
+  font-size: 1.2em;
+  line-height: 1.2em;
+  margin: 0.25em 0; }
+
+.copyright {
+  padding: 1em;
+  font-size: 0.9em;
+  text-align: left; }
+
+/* Document Identity */
+.coverpage-doc-identity {
+  font-size: 2em;
+  line-height: 2em; }
+
+.coverpage-title .title-second {
+  display: none; }
+
+.coverpage-stage-block {
+  font-family: {{headerfont}};
+  font-weight: 600;
+  font-size: 1.25em;
+  margin: 2em 0em 2em 0em;
+  text-transform: uppercase; }
+
+.authors {
+  margin-top: 2em; }
+  .authors span {
+    display: block;
+    line-height: 2; }
+  .authors span.roletag {
+    display: inline-block;
+    font-size: 12px;
+    color: #00335b;
+    background-color: white;
+    padding: 2px 5px;
+    margin-left: 7px;
+    border-radius: 5px; }
+
+/* Draft Warning */
+.coverpage-warning {
+  border: #f36f36 solid 2px;
+  color: #f36f36 !important;
+  margin: 1em 2em;
+  color: #2e81c2;
+  padding: 2em 1em 1em 1em;
+  border-radius: 25px; }
+  .coverpage-warning h1 {
+    font-family: {{headerfont}};
+    font-weight: 300;
+    text-transform: uppercase;
+    font-size: 1.2em; }
+
+@media print {
+  .document-info, .copyright {
+    page-break-before: always; }
+  .coverpage {
+    height: 23cm; }
+  .info-section {
+    display: none; }
+  .wrapper-top {
+    top: 0;
+    padding-top: 4cm;
+    padding-bottom: 4cm; }
+  .wrapper-top-bottom {
+    margin-top: -5px;
+    display: none; } }
+
 body {
   margin-left: auto;
   margin-right: auto;
   max-width: 100%;
-  font-size: 16px;
+  font-size: {{normalfontsize}};
   font-weight: 300;
   line-height: 1.5;
   color: #00335b;
@@ -501,208 +703,6 @@ dl {
 #published {
   color: #9ABD48; }
 
-.coverpage-maturity, .coverpage-stage {
-  font-family: {{headerfont}};
-  font-weight: 400;
-  font-size: 1.3em;
-  margin: 0 0 2em 0;
-  text-transform: uppercase; }
-
-.icon-svg {
-  width: 100%;
-  color: #5ecf86; }
-
-.wrapper-top {
-  background: #00335b;
-  background: linear-gradient(130deg, #00335b 45%, #f1f8ff 100%);
-  color: #ffffff;
-  padding: 5em 0;
-  width: 100%; }
-
-.wrapper-top-bottom {
-  width: 0;
-  height: 0;
-  border-top: 100px solid #00335b;
-  border-right: 100px solid transparent;
-  position: absolute; }
-
-.document-type-band {
-  top: 260px; }
-
-.document-stage-band > :first-child {
-  height: 240px; }
-
-.coverpage-metadata {
-  margin-top: 35px;
-  padding-top: 15px;
-  margin-right: 25px;
-  border-top: solid 1px white; }
-
-.coverpage-metadata,
-.coverpage-alt-formats {
-  font-size: 12px;
-  font-family: {{headerfont}};
-  margin-left: 1em;
-  text-align: left; }
-  .coverpage-metadata span,
-  .coverpage-alt-formats span {
-    display: block;
-    text-align: left; }
-    .coverpage-metadata span a,
-    .coverpage-alt-formats span a {
-      color: white; }
-      .coverpage-metadata span a:hover,
-      .coverpage-alt-formats span a:hover {
-        text-decoration: underline;
-        background: none;
-        box-shadow: none !important;
-        font-weight: 400; }
-  .coverpage-metadata .value,
-  .coverpage-alt-formats .value {
-    font-size: 15px;
-    margin-bottom: 15px; }
-  .coverpage-metadata .label,
-  .coverpage-alt-formats .label {
-    font-size: 12px;
-    padding: 0; }
-
-.coverpage-alt-formats span {
-  display: inline;
-  text-align: left; }
-  .coverpage-alt-formats span a {
-    padding-right: 5px; }
-
-.coverpage-title {
-  padding-bottom: 0.5em;
-  font-family: {{headerfont}};
-  font-weight: 100;
-  padding-left: 1em;
-  padding-right: 1em; }
-  .coverpage-title span {
-    font-family: {{headerfont}};
-    font-size: 1.8em;
-    line-height: 1; }
-
-.docstage-box table {
-  width: auto; }
-
-.docstage-box th {
-  background-color: #93c0d6; }
-
-.docstage-box td {
-  vertical-align: top;
-  background-color: #daeef3;
-  padding: 0.5em;
-  border: 0; }
-
-.docstage-box th:first-child {
-  border-radius: 1em 0 0 0; }
-
-.docstage-box th:last-child {
-  border-radius: 0 1em 0 0; }
-
-.docstage-box tr:first-child {
-  border-radius: 0 0 0 1em; }
-
-.docstage-box tr:last-child {
-  border-radius: 0 1em 0 0; }
-
-.docstage-box tr:last-child > td:first-child {
-  border-radius: 0 0 0 1em; }
-
-.docstage-box tr:last-child > td:last-child {
-  border-radius: 0 0 1em 0; }
-
-.WordSection11 {
-  padding: 0 2em 0 3em; }
-
-.info-section {
-  padding: 0 2em 0 5em; }
-
-.prefatory-section {
-  padding: 0 3em 0 6em; }
-
-.zzSTDTitle1, .MsoCommentText {
-  display: none; }
-
-.coverpage {
-  text-align: center;
-  padding-left: 1.5em; }
-
-.coverpage-logo span, .coverpage-tc-name span {
-  font-family: {{bodyfont}};
-  text-transform: none;
-  font-weight: 300;
-  margin-left: 1em; }
-
-.coverpage-tc-name {
-  font-size: 1.2em;
-  line-height: 1.2em;
-  margin: 0.25em 0; }
-
-.copyright {
-  padding: 1em;
-  font-size: 0.9em;
-  text-align: left; }
-
-/* Document Identity */
-.coverpage-doc-identity {
-  font-size: 2em;
-  line-height: 2em; }
-
-.coverpage-title .title-second {
-  display: none; }
-
-.coverpage-stage-block {
-  font-family: {{headerfont}};
-  font-weight: 600;
-  font-size: 1.25em;
-  margin: 2em 0em 2em 0em;
-  text-transform: uppercase; }
-
-.authors {
-  margin-top: 2em; }
-  .authors span {
-    display: block;
-    line-height: 2; }
-  .authors span.roletag {
-    display: inline-block;
-    font-size: 12px;
-    color: #00335b;
-    background-color: white;
-    padding: 2px 5px;
-    margin-left: 7px;
-    border-radius: 5px; }
-
-/* Draft Warning */
-.coverpage-warning {
-  border: #f36f36 solid 2px;
-  color: #f36f36 !important;
-  margin: 1em 2em;
-  color: #2e81c2;
-  padding: 2em 1em 1em 1em;
-  border-radius: 25px; }
-  .coverpage-warning h1 {
-    font-family: {{headerfont}};
-    font-weight: 300;
-    text-transform: uppercase;
-    font-size: 1.2em; }
-
-@media print {
-  .document-info, .copyright {
-    page-break-before: always; }
-  .coverpage {
-    height: 23cm; }
-  .info-section {
-    display: none; }
-  .wrapper-top {
-    top: 0;
-    padding-top: 4cm;
-    padding-bottom: 4cm; }
-  .wrapper-top-bottom {
-    margin-top: -5px;
-    display: none; } }
-
 p {
   margin-top: 1em;
   margin-bottom: 1em; }
@@ -888,7 +888,7 @@ pre {
   font-family: {{monospacefont}};
   font-variant-ligatures: none;
   background-color: #f7f7f7;
-  font-size: 0.8em;
+  font-size: {{monospacefontsize}};
   line-height: 1.6em;
   padding: 1.5em;
   margin: 2em 0 1em 0;
@@ -921,7 +921,7 @@ pre {
 .figure, pre, .pseudocode {
   background-color: #e1eef1;
   color: #424242;
-  font-size: 0.8em; }
+  font-size: {{monospacefontsize}}; }
 
 .Note {
   background-color: #fff8bb;
@@ -1091,4 +1091,4 @@ a.footnote-number {
   font-size: 0.8em; }
 
 .footnote {
-  font-size: 0.9em; }
+  font-size: {{footnotefontsize}}; }