metanorma-itu 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b6bcda9ee8aa042d7647e9b8865c7bac5a07943541e6278ac311ae35b7ecdb
-  data.tar.gz: 2c2916e7706336f89a13d65cd63022a0a2288a576957684856134f482ecfa7eb
+  metadata.gz: 37546876b8125697954fc7ff980c07cf756aae329566249a31c9ea51fa48ec6a
+  data.tar.gz: 5ce41dcc79d10901912a44bbaa7bdb0ed8da9cd1f1bf7a23d5e8d336fbe0f183
 SHA512:
-  metadata.gz: 3905f473b483696859238779600e0074eb3fb668cef4898ce288d62be053339426afee23d8c6e32e36c8a706dbe0be0f60c5626181c45f78cea30b2baa9e7a23
-  data.tar.gz: 21907c33e9ad329cf2852b10ccce61b9ca407c9fb0e01896a69c60d380d665df3366721cd155db14c48549b1b350c6f74922fe2213f5fdef6c21468a9ad2d586
+  metadata.gz: dadba1953785697e5f6f49ec05696b86c3ceeaca9c437dcd6804f8270d6ebc37cab2926ec9a961232ed727af30cca7691a1799c8c8389f4245611684b6fd5d41
+  data.tar.gz: 7b7bd5a5024cbd4b81a4dd52556bd50a0c4583394b97e3b01b159e98338a3c85748e9d238278b9b38a7501b2fff1a64fe7653ead1ff1755f86b11e3625d1b2b8

data/.github/workflows/macos.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: macos
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-macos:

data/.github/workflows/ubuntu.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: ubuntu
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-linux:
@@ -25,7 +24,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          gem install bundler 
+          gem install bundler
           bundle install --jobs 4 --retry 3
       - name: Use Node
         uses: actions/setup-node@v1
@@ -37,3 +36,15 @@ jobs:
       - name: Run specs
         run: |
           bundle exec rake
+      - name: Trigger dependent repositories
+        if: github.ref == 'refs/heads/master'
+        env:
+          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
+          GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
+        run: |
+          curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
+          [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
+          for repo in $DEPENDENT_REPOS
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY
+          done

data/.github/workflows/windows.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: windows
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-windows:
@@ -26,7 +25,7 @@ jobs:
       - name: Update gems
         shell: pwsh
         run: |
-          gem install bundler 
+          gem install bundler
           bundle config --local path vendor/bundle
           bundle update
           bundle install --jobs 4 --retry 3

data/README.adoc

@@ -1,64 +1,24 @@
-= metanorma-itu: Asciidoctor processor for ITU
+= metanorma-itu: Metanorma for ITU
 
 image:https://img.shields.io/gem/v/metanorma-itu.svg["Gem Version", link="https://rubygems.org/gems/metanorma-itu"]
-image:https://travis-ci.com/metanorma/metanorma-itu.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-itu"]
-image:https://ci.appveyor.com/api/projects/status/pl6lh4a9224ijbe1?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma-itu"]
+image:https://github.com/metanorma/metanorma-itu/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-itu/actions?workflow=macos"]
+image:https://github.com/metanorma/metanorma-itu/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-itu/actions?workflow=ubuntu"]
+image:https://github.com/metanorma/metanorma-itu/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-itu/actions?workflow=windows"]
 image:https://codeclimate.com/github/metanorma/metanorma-itu/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-itu"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-itu.svg["Pull Requests", link="https://github.com/metanorma/metanorma-itu/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-itu/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-itu/releases"]
 
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
-a template for generating ITU documents.
+This gem processes Metanorma input for generating ITU (ITU-T, ITU-D) documents.
 
-The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
-gem, and aligns closely to it. Refer to the ISO gem documentation
-for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring
-
-The following outputs are generated.
-
-* an XML representation of the document, intended as a document model for ITU documents.
-* The XML representation is processed in turn to generate the following outputs
-as end deliverable ITU documents.
-** HTML
-** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting.
-The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
-which is syntactically stricter than the common MathJax processor;
-if you do not get expected results, try bracketing terms your in AsciiMathML
-expressions.
+The implementation inherits from https://github.com/metanorma/metanorma-standoc.
 
 == Usage
 
-The preferred way to invoke this gem is via the `metanorma` script:
-
-[source,console]
-----
-$ metanorma --type itu a.adoc                   # output HTML
-$ metanorma --type itu --extensions html a.adoc # output just HTML
-$ metanorma --type itu --extensions xml a.adoc  # output RSD XML
-----
-
-The gem translates the document into Metanorma XML format, and then
-validates its output against the Metanorma XML document model; errors are
-reported to console against the XML, and are intended for users to
-check that they have provided all necessary components of the
-document.
-
-The gem then converts the XML into HTML.
-
-=== Installation
-
-If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup
-repository has instructions on setting up your machine to run Metanorma
-scripts such as this one. You need only run the following in a Terminal console:
+== Usage and installation
 
-[source,console]
-----
-$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
-$ gem install metanorma-acme
-$ gem install metanorma-cli
-----
+See https://www.metanorma.com.
 
 == Documentation
 
@@ -66,6 +26,6 @@ See https://www.metanorma.com/author/itu/[Write ITU-T documents with Metanorma].
 
 == Examples
 
-* Example documents are avalable at the https://github.com/metanorma/mn-samples-itu[mn-samples-itu] repository.
+* Example documents are available at the https://github.com/metanorma/mn-samples-itu[mn-samples-itu] repository.
 * Document templates are available at the https://github.com/metanorma/mn-templates-itu[mn-templates-itu] repository.
 

data/lib/asciidoctor/itu/biblio.rng

@@ -703,21 +703,11 @@
   </define>
   <define name="TypedTitleString">
     <optional>
-      <attribute name="type">
-        <ref name="TitleType"/>
-      </attribute>
+      <attribute name="type"/>
     </optional>
     <ref name="FormattedString"/>
   </define>
-  <define name="TitleType">
-    <choice>
-      <value>alternative</value>
-      <value>original</value>
-      <value>unofficial</value>
-      <value>subtitle</value>
-      <value>main</value>
-    </choice>
-  </define>
+  <!-- TitleType = ( "alternative" | "original" | "unofficial" | "subtitle" | "main" ) -->
   <define name="TypedUri">
     <optional>
       <attribute name="type"/>

data/lib/asciidoctor/itu/cleanup.rb

@@ -30,7 +30,7 @@ module Asciidoctor
           x.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
           "<sections><sentinel/></sections>"
         x.at("./*/sections/*") or x.at("./*/sections") << "<sentinel/>"
-        ins = x.at("//sections").children.first
+        ins = x.at("//sections").elements.first
         unless x.at("//sections/clause/title[text() = 'Scope']")
           ins.previous = "<clause><title>Scope</title><p>"\
             "#{@labels['clause_empty']}</p></clause>"
@@ -39,9 +39,10 @@ module Asciidoctor
       end
 
       def insert_norm_ref(x)
-        x.at("//bibliography") or x.at("./*/annex[last()] | ./*/sections").next =
+        x.at("//bibliography") or
+          x.at("./*/annex[last()] | ./*/sections").next =
           "<bibliography><sentinel/></bibliography>"
-        ins = x.at("//bibliography").children.first
+        ins = x.at("//bibliography").elements.first
         unless x.at("//bibliography/references/title[text() = 'References']")
           ins.previous = "<references><title>References</title><p>"\
             "#{@labels['clause_empty']}</p></references>"
@@ -50,15 +51,16 @@ module Asciidoctor
       end
 
       def insert_terms(x)
-        ins =  x.at("//sections/clause/title[text() = 'Scope']")
-        unless x.at("//sections/terms")
+        ins =  x.at("//sections/clause/title[text() = 'Scope']/..")
+        unless x.at("//sections//terms")
           ins.next = "<terms><title>Definitions</title><p>"\
             "#{@labels['clause_empty']}</p></terms>"
         end
       end
 
       def insert_symbols(x)
-        ins =  x.at("//terms")
+        ins =  x.at("//sections/terms") ||
+          x.at("//sections/clause[descendant::terms]")
         unless x.at("//sections//definitions")
           ins.next = "<definitions><title>Definitions</title><p>"\
             "#{@labels['clause_empty']}</p></definitions>"
@@ -66,7 +68,8 @@ module Asciidoctor
       end
 
       def insert_conventions(x)
-        ins =  x.at("//sections//definitions")
+        ins =  x.at("//sections//definitions") ||
+          x.at("//sections/clause[descendant::definitions]")
         unless x.at("//sections/clause/title[text() = 'Conventions']")
           ins.next = "<clause><title>Conventions</title><p>"\
             "#{@labels['clause_empty']}</p></clause>"

data/lib/asciidoctor/itu/converter.rb

@@ -65,7 +65,7 @@ module Asciidoctor
           word_converter(node).convert filename unless node.attr("nodoc")
           pdf_converter(node).convert filename unless node.attr("nodoc")
         end
-        @log.write(@filename + ".err") unless @novalid
+        @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end

data/lib/asciidoctor/itu/isodoc.rng

@@ -101,9 +101,7 @@
         <ref name="structuredidentifier"/>
       </zeroOrMore>
     </define>
-    <define name="TitleType">
-      <text/>
-    </define>
+    <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
         <oneOrMore>

data/lib/isodoc/itu/base_convert.rb

@@ -139,7 +139,7 @@ module IsoDoc
 
       def middle_title(out)
         out.p(**{ class: "zzSTDTitle1" }) do |p|
-          id = @meta.get[:docidentifier] and p << "Recommendation #{id}" 
+          id = @meta.get[:docnumber] and p << "Recommendation #{id}" 
         end
         out.p(**{ class: "zzSTDTitle2" }) { |p| p << @meta.get[:doctitle] }
       end
@@ -186,7 +186,7 @@ module IsoDoc
 
       def table_footnote_reference_format(a)
         a.content = a.content + ")"
-    end
+      end
     end
   end
 end

data/lib/isodoc/itu/html/word_itu_titlepage.html

@@ -267,7 +267,7 @@ _Hlk526346232'><span lang="EN-US" style='font-size:9.0pt;mso-bidi-font-size:10.0
 font-family:"Arial",sans-serif;mso-bidi-font-family:"Times New Roman";
 mso-ansi-language:EN-US;mso-fareast-language:ZH-CN;mso-no-proof:yes'><v:shape
  id="Picture_x0020_1" o:spid="_x0000_i1033" type="#_x0000_t75" alt="logo_E"
- style='width:70pt;height:70pt;visibility:visible;mso-wrap-style:square'>
+ style='width:68pt;height:75pt;visibility:visible;mso-wrap-style:square'>
 <v:imagedata src="{{ logo_word }}" o:title="logo_E"/>
 </v:shape></span></span><span style='mso-bookmark:_Hlk526346232'><span
 lang="EN-US" style='font-size:9.0pt;mso-bidi-font-size:10.0pt;font-family:"Arial",sans-serif;

data/lib/isodoc/itu/metadata.rb

@@ -8,11 +8,9 @@ module IsoDoc
         super
         here = File.dirname(__FILE__)
         set(:logo_html,
-            #File.expand_path(File.join(here, "html", "Logo_ITU.jpg")))
             File.expand_path(File.join(here, "html", "International_Telecommunication_Union_Logo.svg")))
         set(:logo_comb,
             File.expand_path(File.join(here, "html", "itu-document-comb.png")))
-        #set(:logo_word, File.expand_path(File.join(here, "html", "logo.png")))
         set(:logo_word, File.expand_path(File.join(here, "html", "International_Telecommunication_Union_Logo.svg")))
       end
 
@@ -40,11 +38,12 @@ module IsoDoc
         set(:bureau, bureau.text) if bureau
         tc = isoxml.at(ns("//bibdata/ext/editorialgroup/committee"))
         set(:tc, tc.text) if tc
+        super
       end
 
       def docid(isoxml, _out)
-        dn = isoxml.at(ns("//bibdata/docidentifier"))
-        set(:docidentifier, dn&.text)
+        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'ITU']"))
+        set(:docnumber, dn&.text)
         dn = isoxml.at(ns("//bibdata/ext/structuredidentifier/annexid"))
         oblig = isoxml&.at(ns("//annex/@obligation"))&.text
         lbl = oblig == "informative" ? @labels["appendix"] : @labels["annex"]
@@ -55,27 +54,6 @@ module IsoDoc
         %w(in-force-prepublished draft).include? status.downcase
       end
 
-      def version(isoxml, _out)
-        super
-        revdate = get[:revdate]
-        set(:revdate_monthyear, monthyr(revdate))
-      end
-
-      MONTHS = {
-        "01": "January",
-        "02": "February",
-        "03": "March",
-        "04": "April",
-        "05": "May",
-        "06": "June",
-        "07": "July",
-        "08": "August",
-        "09": "September",
-        "10": "October",
-        "11": "November",
-        "12": "December",
-      }.freeze
-
       def bibdate(isoxml, _out)
         pubdate = isoxml.xpath(ns("//bibdata/date[@type = 'published']"))
         pubdate and set(:pubdate_monthyear, monthyr(pubdate.text))

data/lib/isodoc/itu/ref.rb

@@ -38,11 +38,13 @@ module IsoDoc
         s.gsub(/ |\_|\-/, " ").split(/ /).map(&:capitalize).join(" ")
       end
 
+      IGNORE_IDS =
+        "@type = 'DOI' or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor'".freeze
+
       def bibitem_ref_code(b)
         id = b.at(ns("./docidentifier[@type = 'metanorma']"))
         id ||= b.at(ns("./docidentifier[@type = 'ITU']"))
-        id ||= b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'ISSN' or "\
-                       "@type = 'ISBN')]"))
+        id ||= b.at(ns("./docidentifier[not(#{IGNORE_IDS})]"))
         id ||= b.at(ns("./docidentifier"))
         return id if id
         id = Nokogiri::XML::Node.new("docidentifier", b.document)
@@ -51,12 +53,9 @@ module IsoDoc
       end
 
       def multi_bibitem_ref_code(b)
-        id = b.xpath(ns("./docidentifier[not(@type = 'DOI' or @type = "\
-                        "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]"))
-        id.empty? and id = b.xpath(ns("./docidentifier[not(@type = 'DOI' or "\
-                                      "@type = 'ISSN' or @type = 'ISBN')]"))
-        id.empty? and id = b.xpath(ns("./docidentifier"))
-        return ["(NO ID)"] if id.empty?
+        id = b.xpath(ns("./docidentifier[not(@type = 'metanorma' or #{IGNORE_IDS})]"))
+        id.empty? and id = b.xpath(ns("./docidentifier[not(@type = 'metanorma')]"))
+        return [] if id.empty?
         id.sort_by { |i| i["type"] == "ITU" ? 0 : 1 }
       end
 
@@ -79,10 +78,11 @@ module IsoDoc
 
       def reference_format_start(b, r)
         id = multi_bibitem_ref_code(b)
-        r << render_identifiers(id)
+        id1 = render_identifiers(id)
+        r << id1
         date = b.at(ns("./date[@type = 'published']")) and
           r << " (#{date.text.sub(/-.*$/, '')})"
-        r << ", "
+        r << ", " if (date || !id1.empty?)
       end
 
       def reference_format_title(b, r)
@@ -96,6 +96,10 @@ module IsoDoc
           /\.$/.match(title&.text) or r << "."
         end
       end
+
+      def format_ref(ref, prefix, isopub, date, allparts)
+        docid_prefix(prefix, ref).sub(/^\[/, "").sub(/\]$/, "")
+      end
     end
   end
 end

data/lib/metanorma/itu/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ITU
-    VERSION = "1.0.11"
+    VERSION = "1.0.12"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-itu
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities