metanorma-bsi 0.0.1

data/lib/asciidoctor/bsi/bsi.rng

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/bsi" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!-- default namespace = "https://www.metanorma.com/ns/bsi" -->
+  <include href="isostandard.rng">
+    <start>
+      <ref name="bsi-standard"/>
+    </start>
+    <define name="DocumentType">
+      <choice>
+        <value>specification</value>
+        <value>management-systems-standard</value>
+        <value>code-of-practice</value>
+        <value>guide</value>
+        <value>method-of-test</value>
+        <value>method-of-specifying</value>
+        <value>vocabulary</value>
+        <value>classification</value>
+      </choice>
+    </define>
+    <define name="BibDataExtensionType">
+      <ref name="doctype"/>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <ref name="structuredidentifier"/>
+      <optional>
+        <ref name="stagename"/>
+      </optional>
+      <optional>
+        <ref name="price-code"/>
+      </optional>
+      <optional>
+        <ref name="cen-processing"/>
+      </optional>
+    </define>
+    <define name="admonition">
+      <element name="admonition">
+        <attribute name="type">
+          <ref name="AdmonitionType"/>
+        </attribute>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="target">
+            <data type="IDREF"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+  </include>
+  <!-- end overrides -->
+  <define name="AdmonitionType" combine="choice">
+    <value>commentary</value>
+  </define>
+  <define name="price-code">
+    <element name="price-code">
+      <text/>
+    </element>
+  </define>
+  <define name="cen-processing">
+    <element name="cen-processing">
+      <data type="boolean"/>
+    </element>
+  </define>
+  <!--
+    We display the Normative References between scope and terms; but to keep the
+    grammar simple, we keep the references together
+  -->
+  <define name="bsi-standard">
+    <element name="bsi-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
+      <ref name="bibdata"/>
+      <zeroOrMore>
+        <ref name="termdocsource"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
+      <ref name="preface"/>
+      <oneOrMore>
+        <ref name="sections"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="annex"/>
+      </zeroOrMore>
+      <ref name="bibliography"/>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/bsi/bsi_intro_en.xml

@@ -0,0 +1,105 @@
+<boilerplate>
+  <copyright-statement>
+    <clause>  
+      {% if unpublished %}
+      <p><strong>Copyright © {{ docyear }} International Electrotechnical Commission, IEC.</strong>
+        All rights reserved. It is permitted to download this electronic file, to make a copy and to
+        print out the content for the sole purpose of preparing National Committee positions. You
+        may not copy or "mirror" the file or printed version of the document, or any part of it,
+        for any other purpose without permission in writing from IEC.
+      {% else %}
+      <p id="boilerplate-year">
+        © {{ agency }} {{ docyear }}, Published in Switzerland
+      </p>
+      <p id="boilerplate-message">
+        All rights
+        reserved. Unless otherwise specified, no part of this publication may be
+        reproduced or utilized otherwise in any form or by any means, electronic or
+        mechanical, including photocopying, or posting on the internet or an intranet,
+        without prior written permission. Permission can be requested from either IEC
+        at the address below or IEC's member body in the country of the requester.
+      </p>
+      <p id="boilerplate-name">IEC Central Office</p>
+      <p id="boilerplate-address" align="left">
+        3, rue de Varembé<br/>
+        CH-1211 Geneva 20, Switzerland<br/>
+        Tel.&#xa0;&#xa0;+ 41 22 919 02 11<br/>
+        Fax&#xa0;&#xa0;+ 41 22 919 03 00<br/>
+        info@iec.ch<br/>
+        www.iec.ch
+      {% endif %}
+      </p>
+    </clause>
+  </copyright-statement>
+  <legal-statement>
+    <clause>
+        <p>Attention is drawn to the possibility that some of the elements of this IEC Publication may be the subject of patent rights. IEC shall not be held responsible for identifying any or all such patent rights.</p>
+    </clause>
+  </legal-statement>
+  {% if unpublished %}
+  <license-statement>
+    <clause>
+      {% if stage_int < 50 %}
+      <p>This document is still under study and subject to change. It should not be used for reference purposes.</p>
+      until published as such.</p>
+    {% endif %}
+      {% if stage_int >= 50 %}
+      <p>This document is a draft distributed for approval. It may not be referred to as an International Standard
+        until published as such.</p>
+      {% endif %}
+      {% if stage_int >= 50 %}
+      <p>In addition to their evaluation as being acceptable for industrial, technological, commercial and user
+        purposes, Final Draft International Standards may on occasion have to be considered in the light of their
+        potential to become standards to which reference may be made in national regulations.</p>
+      {% endif %}
+      <p>Recipients of this document are invited to submit, with their comments, notification of any relevant
+        patent rights of which they are aware and to provide supporting documentation.</p>
+    </clause>
+  </license-statement>
+  {% endif %}
+  <feedback-statement>
+    {% if unpublished %}
+    <clause id="boilerplate-cenelec-attention">
+      <title>Attention IEC-CENELEC parallel voting</title>
+      <p>The attention of IEC National Committees, members of CENELEC, is drawn to the fact that this
+        {% if stage_int >= 30 and stage_int < 40 %}Committee Draft{% endif %}
+        {% if stage_int >= 40 and stage_int < 50 %}Committee Draft For Vote{% endif %}
+        {% if stage_int >= 50 and stage_int < 60 %}Final Draft International Standard{% endif %}
+        ({{ stageabbr }})
+        is submitted for parallel voting.</p>
+      <p>The CENELEC members are invited to vote through the CENELEC voting system.</p>
+    </clause>
+    {% else %}
+    <clause>
+      <title>About the IEC</title>
+      <p>The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes International Standards for all electrical, electronic and related technologies.</p>
+    </clause>
+    <clause>
+      <title>About IEC publications</title>
+      <p>The technical content of IEC publications is kept under constant review by the IEC. Please make sure that you have the latest edition, a corrigenda or an amendment might have been published.</p>
+    </clause>
+    <clause>
+      <clause>
+        <title>IEC Catalogue - <link target="https://webstore.iec.ch/catalogue">webstore.iec.ch/catalogue</link></title>
+        <p>The stand-alone application for consulting the entire bibliographical information on IEC International Standards, Technical Specifications, Technical Reports and other documents. Available for PC, Mac OS, Android Tablets and iPad.</p>
+      </clause>
+      <clause><title>IEC publications search - <link target="https://www.iec.ch/searchpub">www.iec.ch/searchpub</link></title>
+        <p>The advanced search enables to find IEC publications by a variety of criteria (reference number, text, technical committee,...). It also gives information on projects, replaced and withdrawn publications.</p>
+      </clause>
+      <clause><title>IEC Just Published - <link target="https://webstore.iec.ch/justpublished">webstore.iec.ch/justpublished</link></title>
+        <p>Stay up to date on all new IEC publications. Just Published details all new publications released. Available online and also once a month by email.</p>
+      </clause>
+      <clause><title>Electropedia - <link target="http://www.electropedia.org">www.electropedia.org</link></title>
+        <p>The world's leading online dictionary of electronic and electrical terms containing more than 30 000 terms and definitions in English and French, with equivalent terms in 14 additional languages. Also known as the International Electrotechnical Vocabulary (IEV) online.</p>
+      </clause>
+      <clause><title>IEC Glossary - <link target="http://std.iec.ch/glossary">std.iec.ch/glossary</link></title>
+        <p>More than 55 000 electrotechnical terminology entries in English and French extracted from the Terms and Definitions clause of IEC publications issued since 2002. Some entries have been collected from earlier publications of IEC TC 37, 77, 86 and CISPR.</p>
+      </clause>
+      <clause><title>IEC Customer Service Centre - <link target="https://webstore.iec.ch/csc">webstore.iec.ch/csc</link></title>
+        <p>If you wish to give us your feedback on this publication or need further assistance, please contact the Customer Service Centre: <link target="mailto://csc@iec.ch">csc@iec.ch</link>.</p>
+      </clause>
+    </clause>
+    {% endif %}
+  </feedback-statement>
+</boilerplate>
+

data/lib/asciidoctor/bsi/cleanup.rb

@@ -0,0 +1,78 @@
+require_relative "cleanup_ref"
+
+module Asciidoctor
+  module BSI
+    class Converter < ISO::Converter
+      def cleanup(xmldoc)
+        super
+        ol_cleanup(xmldoc)
+        commentary_cleanup(xmldoc)
+        xmldoc
+      end
+
+      def ol_cleanup(doc)
+        doc.xpath("//clause[not(.//clause)] | //annex | //preface/* | //note")
+          .each do |c|
+          (c.xpath(".//ol") - c.xpath(".//ul//ol | .//ol//ol"))
+            .each_with_index do |l, i|
+            ol_cleanup1(l, i)
+          end
+        end
+      end
+
+      def ol_cleanup1(list, idx)
+        styles = %w(alphabet arabic roman)
+        list["type"] = styles[idx % styles.size]
+        (list.xpath(".//ol") - list.xpath(".//ol//ol")).each do |l|
+          ol_cleanup1(l, idx + 1)
+        end
+      end
+
+      def commentary_cleanup(xmldoc)
+        @isodoc ||= isodoc(@lang, @script)
+        xmldoc.xpath("//admonition[@type = 'commentary'][not(@target)]")
+          .each do |a|
+          a["target"] = @isodoc.get_clause_id(a)
+        end
+      end
+
+      def get_id_prefix(xmldoc)
+        prefix = []
+        xmldoc.xpath("//bibdata/contributor[role/@type = 'publisher']"\
+                     "/organization").each do |x|
+          x1 = x.at("abbreviation")&.text || x.at("name")&.text
+          x1 == "BSI" and prefix.unshift("BS") or prefix << x1
+        end
+        prefix
+      end
+
+      # BS as a prefix goes first
+      def docidentifier_cleanup(xmldoc)
+        prefix = get_id_prefix(xmldoc)
+        id = xmldoc.at("//bibdata/docidentifier[@type = 'BS']") or return
+        id.content = id_prefix(prefix, id)
+        id = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") and
+          id.content = id_prefix(prefix, id)
+      end
+
+      def table_footnote_renumber1(fn, i, seen)
+        content = footnote_content(fn)
+        if seen[content] then outnum = seen[content]
+        else
+          i += 1
+          outnum = i
+          seen[content] = outnum
+        end
+        fn["reference"] = (outnum - 1 + "A".ord).chr
+        fn["table"] = true
+        [i, seen]
+      end
+
+      # TODO: Rules for structure 10.5 amendments:
+      # cite as BS 6380:2012+A1, reference as BS 6380:2012+A1:2016
+
+      # TODO: Rules for structure 16.5.2 wording of terms boilerplate:
+      # "British Standard (part of BS..)
+    end
+  end
+end

data/lib/asciidoctor/bsi/cleanup_ref.rb

@@ -0,0 +1,183 @@
+module Asciidoctor
+  module BSI
+    class Converter < ISO::Converter
+      def biblio_cleanup(xmldoc)
+        biblio_metanorma_ids_informative(xmldoc)
+        super
+        xmldoc.xpath("//bibliography//references | //clause//references | "\
+                     "//annex//references").each do |r|
+          next if r["normative"] == "true"
+
+          if r.at("./bibitem/docidentifier[@type = 'metanorma']") &&
+              r.at("./bibitem[not(docidentifier[@type = 'metanorma'])]")
+            split_ref(r, false)
+          end
+        end
+      end
+
+      # Rules for Structure 15.4
+      def biblio_metanorma_ids_normative(xmldoc)
+        xmldoc.xpath("//references[@normative = 'true']/bibitem")
+          .each_with_index do |b, i|
+          biblio_metanorma_ids1(b, i)
+        end
+      end
+
+      def biblio_metanorma_ids_informative(xmldoc)
+        xmldoc.xpath("//references[@normative = 'false']/bibitem")
+          .each_with_index do |b, i|
+          biblio_metanorma_ids1(b, i)
+        end
+      end
+
+      def biblio_metanorma_ids1(bib, idx)
+        bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
+               "@type = 'ISSN' or @type = 'ISBN')]") and return
+        bib&.at("./docidentifier[@type = 'metanorma']")&.remove
+        bib.at("./docidentifier").previous =
+          "<docidentifier type='metanorma'>[#{idx}]</docidentifier>"
+      end
+
+      # Rules for Structure 21.4
+      def biblio_metanorma_ids_informative(xmldoc)
+        xmldoc.xpath("//references[@normative = 'false']/bibitem")
+          .each_with_index do |b, i|
+          biblio_metanorma_ids1(b, i)
+        end
+      end
+
+      def biblio_reorder(xmldoc)
+        @sort_bib_by_appearance = true
+        xmldoc.xpath("//references[@normative = 'false']").each do |r|
+          biblio_reorder1(r)
+        end
+        @sort_bib_by_appearance = false
+        xmldoc.xpath("//references[@normative = 'true']").each do |r|
+          biblio_reorder1(r)
+        end
+      end
+
+      def sort_biblio(bib)
+        @sort_bib_by_appearance and sort_biblio_appearance(bib) or
+          sort_norm_appearance(bib)
+      end
+
+      def citation_order(bib)
+        return {} if bib.empty?
+
+        ids = bib.each_with_object({}) { |b, m| m[b["id"]] = nil }
+        bib.first.document.xpath(".//xref").each_with_index do |b, i|
+          next unless ids.has_key?(b["target"])
+
+          ids[b["target"]] ||= i + 1
+        end
+        ids
+      end
+
+      def id_to_num(bib, ids)
+        return "000000000" if bib["id"].nil?
+
+        sprintf("%09d", ids[bib["id"]] || 0)
+      end
+
+      def sort_biblio_appearance(bib)
+        ids = citation_order(bib)
+        bib.sort do |a, b|
+          id_to_num(a, ids) <=> id_to_num(b, ids)
+        end
+      end
+
+      def sort_norm_appearance(bib)
+        ids = citation_order(bib)
+        bib.each do |b|
+          ids[b["id"]] = 0 unless b.at("./docidentifier[@type = 'metanorma']")
+        end
+        bib.sort do |a, b|
+          "#{id_to_num(a, ids)} :: #{sort_biblio_key(a)}" <=>
+          "#{id_to_num(b, ids)} :: #{sort_biblio_key(b)}"
+        end
+      end
+
+      # Rules for Structure 15.4
+      # Normative references ordering
+      # sort by: alphanumeric
+      # prefix, then docnumber if present, numeric sort
+      #      else alphanumeric metanorma id (abbreviation)
+      # then doc part number if present, numeric sort
+      # then doc id (not DOI &c)
+      # then title
+      def sort_biblio_key(bib)
+        num = bib&.at("./docnumber")&.text
+        id = bib&.at("./docidentifier[not(#{OTHERIDS})]")
+        metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
+        abbrid = metaid unless /^\[\d+\]$/.match?(metaid)
+        /\d-(?<partid>\d+)/ =~ id&.text
+        type = id["type"] if id
+        title = bib&.at("./title[@type = 'main']")&.text ||
+          bib&.at("./title")&.text || bib&.at("./formattedref")&.text
+        "#{type} :: "\
+          "#{num.nil? ? abbrid : sprintf('%09d', num.to_i)} :: "\
+          "#{partid} :: #{id&.text} :: #{title}"
+      end
+
+      def biblio_renumber(xmldoc)
+        ["true", "false"].each do |norm|
+          i = 0
+          xmldoc.xpath("//bibliography//references | //clause//references | "\
+                       "//annex//references").each do |r|
+            next if r["normative"] != norm
+
+            r.xpath("./bibitem").each do |b|
+              next unless docid = b.at("./docidentifier[@type = 'metanorma']")
+              next unless /^\[\d+\]$/.match?(docid.text)
+
+              i += 1
+              docid.children = "[#{norm == 'true' ? 'N' : ''}#{i}]"
+            end
+          end
+        end
+      end
+
+      # Rules for Structure 15.4
+      def normref_cleanup(xmldoc)
+        biblio_metanorma_ids_normative(xmldoc)
+        super
+        xmldoc.xpath("//bibliography//references | //clause//references | "\
+                     "//annex//references").each do |r|
+          next if r["normative"] == "false"
+
+          if r.at("./bibitem/docidentifier[@type = 'metanorma']") &&
+              r.at("./bibitem[not(docidentifier[@type = 'metanorma'])]")
+            split_ref(r, true)
+          end
+        end
+      end
+
+      def new_ref(title, norm)
+        "<references normative='#{norm}' unnumbered='true'>"\
+          "<title>#{title}</title></references>"
+      end
+
+      def split_ref(ref, norm)
+        std = ref.add_child(new_ref("Standards publications", norm)).first
+        other = ref.add_child(new_ref("Other publications", norm)).first
+        ref.xpath("./bibitem").each do |b|
+          b.parent =
+            b.at("./docidentifier[@type = 'metanorma']") ? other : std
+        end
+      end
+
+      def boilerplate_cleanup(xmldoc)
+        super
+        f = xmldoc.at("//bibliography//references[@normative = 'false']"\
+                      "[not(references)]")
+        f and biblio_preface(f)
+      end
+
+      # Rules for Structure 21.5
+      def biblio_preface(ref)
+        ref.at("./title").next = "<p>#{@i18n.biblio_pref}</p>"
+      end
+    end
+  end
+end