metanorma-iho 0.0.1

data/lib/asciidoctor/iho/boilerplate.xml

@@ -0,0 +1,30 @@
+<boilerplate>
+  <copyright-statement>
+    <clause>
+      <p align="center"> © Copyright International Hydrographic Organization {{ docyear }}</p>
+      <p>This work is copyright. Apart from any use permitted in accordance with the Berne Convention for the Protection of Literary and Artistic Works (1886), and except in the circumstances described below, no part may be translated, reproduced by any process, adapted, communicated or commercially exploited without prior written permission from the International Hydrographic Organization (IHO). Copyright in some of the material in this publication may be owned by another party and permission for the translation and/or reproduction of that material must be obtained from the owner.</p>
+    </clause>
+  </copyright-statement>
+  <license-statement>
+    <clause>
+      <p>This document or partial material from this document may be translated, reproduced or distributed for general information, on no more than a cost recovery basis. Copies may not be sold or distributed for profit or gain without prior written agreement of the IHO and any other copyright holders.</p>
+      <p>In the event that this document or partial material from this document is reproduced, translated or distributed under the terms described above, the following statements are to be included:</p>
+      <quote>
+        <p><em>"Material from IHO publication [reference to extract: Title, Edition] is reproduced with the permission of the International Hydrographic Organization (IHO) Secretariat (Permission No ……./…) acting for the International Hydrographic Organization (IHO), which does not accept responsibility for the correctness of the material as reproduced: in case of doubt, the IHO's authentic text shall prevail. The incorporation of material sourced from IHO shall not be construed as constituting an endorsement by IHO of this product."</em></p>
+        <p><em>"This [document/publication] is a translation of IHO [document/publication] [name]. The IHO has not checked this translation and therefore takes no responsibility for its accuracy. In case of doubt the source version of [name] in [language] should be consulted."</em></p>
+</quote>
+<p>The IHO Logo or other identifiers shall not be used in any derived product without prior written permission from the IHO.</p>
+    </clause>
+  </license-statement>
+  <feedback-statement>
+    <p>Published by the<br/>
+      International Hydrographic Organization<br/>
+      4b quai Antoine 1er<br/>
+      Principauté de Monaco<br/>
+      Tel: (377) 93.10.81.00<br/>
+      Fax: (377) 93.10.81.40<br/>
+      info@iho.int<br/>
+www.iho.int</p>
+  </feedback-statement>
+</boilerplate>
+

data/lib/asciidoctor/iho/converter.rb

@@ -0,0 +1,94 @@
+require "asciidoctor/standoc/converter"
+require 'asciidoctor/generic/converter'
+
+module Asciidoctor
+  module IHO
+    # A {Converter} implementation that generates RSD output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class Converter < Asciidoctor::Generic::Converter
+      XML_ROOT_TAG = 'iho-standard'.freeze
+      XML_NAMESPACE = 'https://www.metanorma.org/ns/iho'.freeze
+
+      register_for "iho"
+
+      def clause_parse(attrs, xml, node)
+        node.option? "appendix" and
+          return appendix_parse(attrs, xml, node)
+        super
+      end
+
+      def appendix_parse(attrs, xml, node)
+        attrs["inline-header".to_sym] = node.option? "inline-header"
+        set_obligation(attrs, node)
+        xml.appendix **attr_code(attrs) do |xml_section|
+          xml_section.title { |name| name << node.title }
+          xml_section << node.content
+        end
+      end
+
+      SERIESNAME = {
+        B: "Bathymetric",
+        C: "Capacity Building",
+        M: "Miscellaneous",
+        P: "Periodic",
+        S: "Standards and Specifications",
+      }
+
+      def metadata_series(node, xml)
+        series = node.attr("series") or return
+        xml.series **{ type: "main" } do |s|
+          s.title SERIESNAME[series.to_sym] || "N/A"
+          s.abbreviation series
+        end
+      end
+
+      def metadata_ext(node, ext)
+        super
+        metadata_commentperiod(node, ext)
+      end
+
+      def metadata_commentperiod(node, xml)
+        from = node.attr("comment-from") or return
+        to = node.attr("comment-to")
+        xml.commentperiod do |c|
+          c.from from
+          c.to to if to
+        end
+      end
+
+      def metadata_committee(node, xml)
+        return unless node.attr("workgroup")
+        xml.editorialgroup do |a|
+          a.committee node.attr("committee")
+          a.workgroup node.attr("workgroup")
+        end
+        i = 2
+        while node.attr("workgroup_#{i}") do
+          xml.editorialgroup do |a|
+            a.committee node.attr("committee_#{i}")
+            a.workgroup node.attr("workgroup_#{i}")
+          end
+          i += 1
+        end
+      end
+
+      def configuration
+        Metanorma::IHO.configuration
+      end
+
+      def html_converter(node)
+        IsoDoc::IHO::HtmlConvert.new(html_extract_attributes(node))
+      end
+
+      def pdf_converter(node)
+        return nil if node.attr("no-pdf")
+        IsoDoc::IHO::PdfConvert.new(html_extract_attributes(node))
+      end
+
+      def word_converter(node)
+        IsoDoc::IHO::WordConvert.new(doc_extract_attributes(node))
+      end
+    end
+  end
+end

data/lib/asciidoctor/iho/iho.rng

@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/iho" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
+    we cannot have a new default namespace: we will end up with a grammar with two different
+    namespaces, one for isostandard and one for csand additions. And we do not want that.
+  -->
+  <include href="isodoc.rng">
+    <start>
+      <ref name="iho-standard"/>
+    </start>
+    <define name="DocumentType">
+      <choice>
+        <value>policy-and-procedures</value>
+        <value>best-practices</value>
+        <value>supporting-document</value>
+        <value>report</value>
+        <value>legal</value>
+        <value>directives</value>
+        <value>proposal</value>
+        <value>standard</value>
+      </choice>
+    </define>
+    <define name="editorialgroup">
+      <element name="editorialgroup">
+        <ref name="committee"/>
+        <ref name="workgroup"/>
+      </element>
+    </define>
+    <define name="BibDataExtensionType">
+      <optional>
+        <ref name="doctype"/>
+      </optional>
+      <oneOrMore>
+        <ref name="editorialgroup"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="commentperiod"/>
+      </optional>
+    </define>
+    <define name="annex">
+      <element name="annex">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="language"/>
+        </optional>
+        <optional>
+          <attribute name="script"/>
+        </optional>
+        <optional>
+          <attribute name="inline-header">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+        <optional>
+          <ref name="section-title"/>
+        </optional>
+        <group>
+          <group>
+            <zeroOrMore>
+              <ref name="BasicBlock"/>
+            </zeroOrMore>
+            <zeroOrMore>
+              <ref name="note"/>
+            </zeroOrMore>
+          </group>
+          <zeroOrMore>
+            <choice>
+              <ref name="annex-subsection"/>
+              <ref name="terms"/>
+              <ref name="definitions"/>
+              <ref name="references"/>
+            </choice>
+          </zeroOrMore>
+        </group>
+        <zeroOrMore>
+          <ref name="annex-appendix"/>
+        </zeroOrMore>
+      </element>
+    </define>
+  </include>
+  <define name="committee">
+    <element name="committee">
+      <choice>
+        <value>hssc</value>
+        <value>ircc</value>
+      </choice>
+    </element>
+  </define>
+  <define name="workgroup">
+    <element name="workgroup">
+      <text/>
+    </element>
+  </define>
+  <define name="annex-appendix">
+    <element name="appendix">
+      <ref name="Clause-Section"/>
+    </element>
+  </define>
+  <define name="commentperiod">
+    <element name="commentperiod">
+      <element name="from">
+        <ref name="ISO8601Date"/>
+      </element>
+      <optional>
+        <element name="to">
+          <ref name="ISO8601Date"/>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="iho-standard">
+    <element name="iho-standard">
+      <ref name="bibdata"/>
+      <zeroOrMore>
+        <ref name="termdocsource"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
+      <ref name="preface"/>
+      <oneOrMore>
+        <ref name="sections"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="annex"/>
+      </zeroOrMore>
+      <ref name="bibliography"/>
+    </element>
+  </define>
+</grammar>