metanorma-itu 0.2.8 → 1.0.2

data/lib/asciidoctor/itu/isodoc.rng

@@ -207,9 +207,9 @@
     </optional>
     <choice>
       <group>
-        <optional>
+        <zeroOrMore>
           <ref name="BasicBlock"/>
-        </optional>
+        </zeroOrMore>
         <zeroOrMore>
           <ref name="note"/>
         </zeroOrMore>
@@ -244,9 +244,9 @@
     </optional>
     <choice>
       <group>
-        <optional>
+        <zeroOrMore>
           <ref name="BasicBlock"/>
-        </optional>
+        </zeroOrMore>
         <zeroOrMore>
           <ref name="note"/>
         </zeroOrMore>
@@ -289,9 +289,9 @@
       </optional>
       <choice>
         <group>
-          <optional>
+          <zeroOrMore>
             <ref name="BasicBlock"/>
-          </optional>
+          </zeroOrMore>
           <zeroOrMore>
             <ref name="note"/>
           </zeroOrMore>

data/lib/asciidoctor/itu/isostandard.rng

@@ -6,7 +6,9 @@
     </start>
     <define name="organization">
       <element name="organization">
-        <ref name="orgname"/>
+        <oneOrMore>
+          <ref name="orgname"/>
+        </oneOrMore>
         <optional>
           <ref name="abbreviation"/>
         </optional>
@@ -74,10 +76,12 @@
     <define name="sections">
       <element name="sections">
         <ref name="clause"/>
-        <choice>
-          <ref name="term-clause"/>
-          <ref name="terms"/>
-        </choice>
+        <optional>
+          <choice>
+            <ref name="term-clause"/>
+            <ref name="terms"/>
+          </choice>
+        </optional>
         <optional>
           <ref name="definitions"/>
         </optional>
@@ -395,6 +399,7 @@
         </optional>
         <choice>
           <ref name="image"/>
+          <ref name="pre"/>
           <oneOrMore>
             <ref name="subfigure"/>
           </oneOrMore>

data/lib/asciidoctor/itu/itu.rng

@@ -49,6 +49,24 @@
         </choice>
       </element>
     </define>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="class">
+            <value>steps</value>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="DocumentType">
       <choice>
         <value>recommendation</value>
@@ -130,6 +148,36 @@
       </element>
     </define>
   </include>
+  <define name="TextElement" combine="choice">
+    <choice>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
   <define name="ipnoticereceived">
     <element name="ip-notice-received">
       <data type="boolean"/>

data/lib/asciidoctor/itu/itu_intro.xml

@@ -0,0 +1,48 @@
+<boilerplate>
+  <legal-statement>
+    <clause>
+      <title>FOREWORD</title>
+<p>The International Telecommunication Union (ITU) is the United Nations specialized agency in the field of telecommunications , information and communication technologies (ICTs). The ITU Telecommunication Standardization Sector (ITU-T) is a permanent organ of ITU. ITU-T is responsible for studying technical, operating and tariff questions and issuing Recommendations on them with a view to standardizing telecommunications on a worldwide basis.</p>
+<p>The World Telecommunication Standardization Assembly (WTSA), which meets every four years, establishes the topics for study by the ITU T study groups which, in turn, produce Recommendations on these topics.</p>
+<p>The approval of ITU-T Recommendations is covered by the procedure laid down in WTSA Resolution 1 .</p>
+<p>In some areas of information technology which fall within ITU-T's purview, the necessary standards are prepared on a collaborative basis with ISO and IEC.</p>
+
+
+<clause>
+<title>NOTE</title>
+<p>In this Recommendation, the expression "Administration" is used for conciseness to indicate both a telecommunication administration and a recognized operating agency .</p>
+<p>Compliance with this Recommendation is voluntary. However, the Recommendation may contain certain mandatory provisions (to ensure, e.g., interoperability or applicability) and compliance with the Recommendation is achieved when all of these mandatory provisions are met. The words "shall" or some other obligatory language such as "must" and the negative equivalents are used to express requirements. The use of such words does not suggest that compliance with the Recommendation is required of any party .</p>
+</clause>
+    </clause>
+
+    {% if unpublished %}
+    <clause id="draft-warning">
+      <title>CAUTION! PREPUBLISHED {{ doctype  | upcase }}</title>
+      <p>This
+        prepublication is an unedited version of a recently approved {{doctype}}.
+  It will be replaced by the published version after editing. Therefore,
+  there will be differences between this prepublication and the published
+  version.</p>
+    </clause>
+    {% endif %}
+  </legal-statement>
+
+  <copyright-statement>
+    <clause>
+      <p>&copy; ITU {{ docyear }}</p>
+<p>All rights reserved. No part of this publication may be reproduced, by any means whatsoever, without the prior written permission of ITU.</p>
+    </clause>
+  </copyright-statement>
+
+  <license-statement>
+    <clause>
+      <title>INTELLECTUAL PROPERTY RIGHTS</title>
+      <p>ITU draws attention to the possibility that the practice or implementation of this Recommendation may involve the use of a claimed Intellectual Property Right. ITU takes no position concerning the evidence, validity or applicability of claimed Intellectual Property Rights, whether asserted by ITU members or others outside of the Recommendation development process.</p>
+<p>As of the date of approval of this Recommendation, ITU had {% if ip_notice_received %}{% else %}not{% endif %} received notice of intellectual property, protected by patents, which may be required to implement this Recommendation. However, implementers are cautioned that this may not represent the latest information and are therefore strongly urged to consult the TSB patent database at <link target="http://www.itu.int/ITU-T/ipr/"/>.
+</p>
+</clause>
+</license-statement>
+</boilerplate>
+
+
+

data/lib/asciidoctor/itu/macros.rb

@@ -1,19 +1,27 @@
-require "asciidoctor/extensions"
+module Asciidoctor
+  module ITU
+    class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :add
+      parse_content_as :text
+      using_format :short
 
-class PseudocodeBlockMacro < Asciidoctor::Extensions::BlockProcessor
-  use_dsl
-  named :pseudocode
-  on_context :example, :sourcecode
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<add>#{out}</add>}
+      end
+    end
 
-  def init_indent(s)
-    /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
-    prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0").gsub(/ /, "\u00a0")
-    prefix + suffix
-  end
+    class DelMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :del
+      parse_content_as :text
+      using_format :short
 
-  def process parent, reader, attrs
-    attrs['role'] = 'pseudocode'
-    create_block parent, :example, reader.lines.map { |m| init_indent(m) }, attrs,
-      content_model: :compound
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<del>#{out}</del>}
+      end
+    end
   end
 end

data/lib/asciidoctor/itu/validate.rb

@@ -26,6 +26,7 @@ module Asciidoctor
         approval_validate(doc)
         itu_identifier_validate(doc)
         bibdata_validate(doc.root)
+        termdef_style(doc.root)
       end
 
       def approval_validate(xmldoc)
@@ -46,6 +47,19 @@ module Asciidoctor
         end
       end
 
+      def termdef_style(xmldoc)
+        xmldoc.xpath("//term").each do |t|
+          para = t.at("./definition") || return
+          term = t.at("./preferred").text
+          termdef_warn(term, /^[A-Z][a-z]+/, term, "term is not lowercase")
+          termdef_warn(para.text, /^[a-z]/, term, "term definition does not start with capital")
+          termdef_warn(para.text, /[^.]$/, term, "term definition does not end with period")
+        end
+      end
+
+      def termdef_warn(text, re, term, msg)
+        re.match(text) && warn("ITU style: #{term}: #{msg}")
+      end
     end
   end
 end

data/lib/isodoc/itu/base_convert.rb

@@ -3,6 +3,7 @@ require_relative "metadata"
 require "fileutils"
 require_relative "./ref.rb"
 require_relative "./xref.rb"
+require_relative "./terms.rb"
 
 module IsoDoc
   module ITU
@@ -40,21 +41,32 @@ module IsoDoc
         ""
       end
 
-      def figure_parse(node, out)
-        return pseudocode_parse(node, out) if node["type"] == "pseudocode"
-        super
+      def note_label(node)
+        n = get_anchors[node["id"]]
+        return "#{@note_lbl} – " if n.nil? || n[:label].nil? || n[:label].empty?
+        l10n("#{@note_lbl} #{n[:label]} – ")
       end
 
-      def pseudocode_parse(node, out)
-        @in_figure = true
-        name = node.at(ns("./name"))
-        out.div **attr_code(id: node["id"], class: "pseudocode") do |div|
-          node.children.each do |n|
-            parse(n, div) unless n.name == "name"
-          end
-          sourcecode_name_parse(node, div, name) if name
-        end
-        @in_figure = false
+      def formula_where(dl, out)
+        return unless dl
+        out.p { |p| p << l10n("#{@where_lbl}:") }
+        parse(dl, out)
+      end
+
+      def prefix_container(container, linkend, _target)
+        l10n("#{linkend} #{@labels["in"]} #{anchor(container, :xref)}")
+      end
+
+      def ol_depth(node)
+        return super unless node["class"] == "steps" or
+          node.at(".//ancestor::xmlns:ol[@class = 'steps']")
+        depth = node.ancestors("ul, ol").size + 1
+        type = :arabic
+        type = :alphabet if [2, 7].include? depth
+        type = :roman if [3, 8].include? depth
+        type = :alphabet_upper if [4, 9].include? depth
+        type = :roman_upper if [5, 10].include? depth
+        ol_style(type)
       end
 
       def annex_name(annex, name, div)
@@ -112,70 +124,6 @@ module IsoDoc
         super
       end
 
-      def terms_defs_title(node)
-        t = node.at(ns("./title")) and return t.text
-        super
-      end
-
-      def terms_defs(node, out, num)
-        f = node.at(ns(IsoDoc::Convert::TERM_CLAUSE)) or return num
-        out.div **attr_code(id: f["id"]) do |div|
-          num = num + 1
-          clause_name(num, terms_defs_title(f), div, nil)
-          if f.at(ns("./clause | ./terms | ./term")).nil? then out.p "None."
-          else
-            f.children.reject { |c1| c1.name == "title" }.each do |c1|
-              parse(c1, div)
-            end
-          end
-        end
-        num
-      end
-
-      def terms_parse(node, out)
-        out.div **attr_code(id: node["id"]) do |div|
-          clause_parse_title(node, div, node.at(ns("./title")), out)
-          title = node.at(ns("./title"))&.text&.downcase
-          title == "terms defined elsewhere" and
-            out.p @labels["elsewhere_terms"]
-          title == "terms defined in this recommendation" and
-            out.p @labels["here_terms"]
-          if node.at(ns("./clause | ./term")).nil? then out.p "None."
-          else
-            node.children.reject { |c1| c1.name == "title" }.each do |c1|
-              parse(c1, div)
-            end
-          end
-        end
-      end
-
-      def termdef_parse1(node, div, term, defn, source)
-        div.p **{ class: "TermNum", id: node["id"] } do |p|
-          p.b do |b|
-            b << anchor(node["id"], :label)
-            insert_tab(b, 1)
-            term.children.each { |n| parse(n, b) }
-          end
-          source and p << " [#{source.value}]"
-          p << ": "
-        end
-        defn and defn.children.each { |n| parse(n, div) }
-      end
-
-      def termdef_parse(node, out)
-        term = node.at(ns("./preferred"))
-        defn = node.at(ns("./definition"))
-        source = node.at(ns("./termsource/origin/@citeas"))
-        out.div **attr_code(id: node["id"]) do |div|
-          termdef_parse1(node, div, term, defn, source)
-          set_termdomain("")
-          node.children.each do |n|
-            next if %w(preferred definition termsource title).include? n.name
-            parse(n, out)
-          end
-        end
-      end
-
       def get_eref_linkend(node)
         link = "[#{anchor_linkend(node, docid_l10n(node["target"] || node["citeas"]))}]"
         link += eref_localities(node.xpath(ns("./locality")), link)
@@ -211,6 +159,74 @@ module IsoDoc
           insert_tab(s, 1)
         end
       end
+
+      def add_parse(node, out)
+        out.span **{class: "addition"} do |e|
+          node.children.each { |n| parse(n, e) }
+        end
+      end
+
+      def del_parse(node, out)
+        out.span **{class: "deletion"} do |e|
+          node.children.each { |n| parse(n, e) }
+        end
+      end
+
+      def error_parse(node, out)
+        case node.name
+        when "add" then add_parse(node, out)
+        when "del" then del_parse(node, out)
+        when "copyright-statement"
+          out.div **{class: "copyright"} do |div|
+            node.children.each { |n| parse(n, div) }
+          end
+        when "license-statement"
+          out.div **{class: "license"} do |div|
+            node.children.each { |n| parse(n, out) }
+          end
+        when "legal-statement"
+          out.div **{class: "legal"} do |div|
+            node.children.each { |n| parse(n, out) }
+          end
+        else
+          super
+        end
+      end
+
+      def note_p_parse(node, div)
+        div.p do |p|
+          p.span **{ class: "note_label" } do |s|
+            s << note_label(node)
+          end
+          node.first_element_child.children.each { |n| parse(n, p) }
+        end
+        node.element_children[1..-1].each { |n| parse(n, div) }
+      end
+
+      def note_parse1(node, div)
+        div.p do |p|
+          p.span **{ class: "note_label" } do |s|
+            s << note_label(node)
+          end
+        end
+        node.children.each { |n| parse(n, div) }
+      end
+
+      def boilerplate(node, out)
+        boilerplate = node.at(ns("//boilerplate")) or return
+        out.div **{class: "authority"} do |s|
+          boilerplate.children.each do |n|
+            if n.name == "title"
+              s.h1 do |h|
+                n.children.each { |nn| parse(nn, h) }
+              end
+            else
+              parse(n, s)
+            end
+          end
+        end
+      end
+
     end
   end
 end