metanorma-ieee 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bbf250e70bbe6d7c3ce624147d503935bf9005694965377bee47b61d3260c67
+  data.tar.gz: cd6e4e3f393d870c38f0d31ae11254123b7301659ed519e9a39988b472de9dcc
+SHA512:
+  metadata.gz: 7c10105ed014eb7919a245ee2b1ca5bb9165768aa9cd3390cf7782abcaac24e1ff35fd0fbf9c14bcedfb39f7b4090ef17b43c7ba1bc36dbd6f7ad96abef9a04a
+  data.tar.gz: 41d392c1240e1ad3f31660d22b3d46ff2471e4e4001fc990eea12ff388877aa39b6eb49fd119b19d707a26096f55955e8d31ea76827bdfdc3715e597896089fd

data/.github/workflows/rake.yml

@@ -0,0 +1,13 @@
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/metanorma-build-scripts/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}" }
+
+gemspec
+
+if File.exist? 'Gemfile.devel'
+  eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
+end

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,30 @@
+= metanorma-ieee: Metanorma for IEEE
+
+image:https://img.shields.io/gem/v/metanorma-ieee.svg["Gem Version", link="https://rubygems.org/gems/metanorma-ieee"]
+image:https://github.com/metanorma/metanorma-ieee/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-ieee/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/metanorma-ieee/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-ieee"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-ieee.svg["Pull Requests", link="https://github.com/metanorma/metanorma-ieee/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-ieee/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-ieee/releases"]
+
+== Functionality
+
+This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating ITU
+standards and documents.
+
+The implementation inherits from https://github.com/metanorma/metanorma-standoc.
+
+== Usage
+
+== Usage and installation
+
+See https://www.metanorma.com.
+
+== Documentation
+
+See https://www.metanorma.com/author/ieee/[Write IEEE documents with Metanorma].
+
+== Examples
+
+* Example documents are available at the https://github.com/metanorma/mn-samples-ieee[mn-samples-ieee] repository.
+* Document templates are available at the https://github.com/metanorma/mn-templates-ieee[mn-templates-ieee] repository.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "isodoc/gem_tasks"
+
+IsoDoc::GemTasks.install
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metanorma/itu"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile", Pathname.new(__FILE__).realpath
+)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/html2doc/ieee.rb

@@ -0,0 +1,89 @@
+class Html2Doc
+  class IEEE < ::Html2Doc
+    def process_footnote_texts(docxml, footnotes)
+      body = docxml.at("//body")
+      list = body.add_child("<div style='mso-element:footnote-list'/>")
+      footnotes.each_with_index do |f, i|
+        if i.zero?
+          fn = list.first.add_child(footnote_container_nofn(docxml, i + 1))
+          f.parent = fn.first
+          footnote_div_to_p_unstyled(f)
+        else
+          fn = list.first.add_child(footnote_container(docxml, i + 1))
+          f.parent = fn.first
+          footnote_div_to_p(f)
+        end
+      end
+      footnote_cleanup(docxml)
+    end
+
+    def footnote_container_nofn(_docxml, idx)
+      <<~DIV
+        <div style='mso-element:footnote' id='ftn#{idx}'>
+          <a style='mso-footnote-id:ftn#{idx}' href='#_ftn#{idx}'
+             name='_ftnref#{idx}' title='' id='_ftnref#{idx}'></a></div>
+      DIV
+    end
+
+    def footnote_div_to_p_unstyled(elem)
+      if %w{div aside}.include? elem.name
+        if elem.at(".//p")
+          elem.replace(elem.children)
+        else
+          elem.name = "p"
+        end
+      end
+    end
+
+    def transform_footnote_text(note)
+      note["id"] = ""
+      note.xpath(".//div").each { |div| div.replace(div.children) }
+      note.xpath(".//aside | .//p").each do |p|
+        p.name = "p"
+        %w(IEEEStdsCRTextReg IEEEStdsCRTextItal).include?(p["class"]) or
+          p["class"] = "IEEEStdsFootnote"
+      end
+      note.remove
+    end
+
+    def list2para(list)
+      return if list.xpath("./li").empty?
+
+      if list.name == "ol"
+        list2para_ol(list)
+      else
+        list2para_ul(list)
+      end
+    end
+
+    def list2para_ul(list)
+      list.xpath("./li").first["class"] ||= "IEEEStdsUnorderedListCxSpFirst"
+      list.xpath("./li").last["class"] ||= "IEEEStdsUnorderedListCxSpLast"
+      list.xpath("./li/p").each do |p|
+        p["class"] ||= "IEEEStdsUnorderedListCxSpMiddle"
+      end
+      list.xpath("./li").each do |l|
+        l.name = "p"
+        l["class"] ||= "IEEEStdsUnorderedListCxSpMiddle"
+        l&.first_element_child&.name == "p" and
+          l.first_element_child.replace(l.first_element_child.children)
+      end
+      list.replace(list.children)
+    end
+
+    def list2para_ol(list)
+      list.xpath("./li").first["class"] ||= "IEEEStdsNumberedListLevel1CxSpFirst"
+      list.xpath("./li").last["class"] ||= "IEEEStdsNumberedListLevel1CxSpLast"
+      list.xpath("./li/p").each do |p|
+        p["class"] ||= "IEEEStdsNumberedListLevel1CxSpMiddle"
+      end
+      list.xpath("./li").each do |l|
+        l.name = "p"
+        l["class"] ||= "IEEEStdsNumberedListLevel1CxSpMiddle"
+        l&.first_element_child&.name == "p" and
+          l.first_element_child.replace(l.first_element_child.children)
+      end
+      list.replace(list.children)
+    end
+  end
+end

data/lib/isodoc/ieee/base_convert.rb

@@ -0,0 +1,33 @@
+require "isodoc"
+require "fileutils"
+
+module IsoDoc
+  module IEEE
+    module BaseConvert
+      def clause_attrs(node)
+        { id: node["id"], type: node["type"] }
+      end
+
+      def scope(isoxml, out, num)
+        f = isoxml.at(ns("//clause[@type = 'overview']")) or return num
+        out.div **attr_code(id: f["id"]) do |div|
+          num = num + 1
+          clause_name(num, f&.at(ns("./title")), div, nil)
+          f.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
+        num
+      end
+
+      def middle_clause(_docxml = nil)
+        "//clause[parent::sections][not(@type = 'overview')]"\
+          "[not(descendant::terms)]"
+      end
+
+      def para_attrs(node)
+        super.merge(type: node["type"])
+      end
+    end
+  end
+end

data/lib/isodoc/ieee/html/header.html

@@ -0,0 +1,146 @@
+<html xmlns:v="urn:schemas-microsoft-com:vml"
+xmlns:o="urn:schemas-microsoft-com:office:office"
+xmlns:w="urn:schemas-microsoft-com:office:word"
+xmlns:m="http://schemas.microsoft.com/office/2004/12/omml"
+xmlns="http://www.w3.org/TR/REC-html40">
+
+<head>
+<meta http-equiv=Content-Type content="text/html; charset=utf-8">
+<meta name=ProgId content=Word.Document>
+<meta name=Generator content="Microsoft Word 15">
+<meta name=Originator content="Microsoft Word 15">
+<link id=Main-File rel=Main-File href="../{{ filename}}.html">
+<!--[if gte mso 9]><xml>
+ <o:shapedefaults v:ext="edit" spidmax="2050"/>
+</xml><![endif]-->
+</head>
+
+<body lang=EN-AU link=blue vlink=purple>
+
+<div style='mso-element:footnote-separator' id=fs>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1 width="33%">
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:footnote-continuation-separator' id=fcs>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-continuation-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1>
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:endnote-separator' id=es>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1 width="33%">
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:endnote-continuation-separator' id=ecs>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-continuation-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1>
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:header' id=h1>
+
+  <p class=MsoHeader><span lang=EN-US>P{{ docnumeric }}{% if draft %}/D{{ draft }},
+    {{ draft_month }} {{ draft_year }}{% endif %}</span></p>
+
+  <p class=MsoHeader><span lang=EN-US>{% if draft %}Draft{% endif %} {{ doctype_abbrev }} for
+    {{ doctitle }}</span></p>
+
+</div>
+
+<div style='mso-element:footer' id=ef1>
+
+<div style='mso-element:frame;mso-element-wrap:around;mso-element-anchor-vertical:
+paragraph;mso-element-anchor-horizontal:margin;mso-element-left:center;
+mso-element-top:.05pt;mso-height-rule:exactly'>
+
+<table cellspacing=0 cellpadding=0 hspace=0 vspace=0 align=center>
+ <tr>
+  <td valign=top align=left style='padding-top:0cm;padding-right:0cm;
+  padding-bottom:0cm;padding-left:0cm'>
+  <p class=MsoFooter style='mso-element:frame;mso-element-wrap:around;
+  mso-element-anchor-vertical:paragraph;mso-element-anchor-horizontal:margin;
+  mso-element-left:center;mso-element-top:.05pt;mso-height-rule:exactly'><!--[if supportFields]><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><span
+  style='mso-element:field-begin'></span>PAGE<span style='mso-spacerun:yes'> 
+  </span></span></span><![endif]--><!--[if supportFields]><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><span
+  style='mso-element:field-end'></span></span></span><![endif]--><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><o:p></o:p></span></span></p>
+  </td>
+ </tr>
+</table>
+
+</div>
+
+<p class=MsoFooter style='margin-right:18.0pt'><span lang=EN-US><o:p>&#xa0;</o:p></span></p>
+
+</div>
+
+<div style='mso-element:header' id=fh1>
+
+  <p class=IEEEStdsTitlePgHead><span lang=EN-US>IEEE Std {{docnumeric}}™-0</span></p>
+
+</div>
+
+<div style='mso-element:footer' id=f3>
+
+<div style='mso-element:frame;mso-element-wrap:no-wrap-beside;mso-element-anchor-vertical:
+paragraph;mso-element-anchor-horizontal:margin;mso-element-left:center;
+mso-element-top:.05pt;mso-height-rule:exactly'>
+
+<table cellspacing=0 cellpadding=0 hspace=0 vspace=0 align=center>
+ <tr>
+  <td valign=top align=left style='padding-top:0cm;padding-right:0cm;
+  padding-bottom:0cm;padding-left:0cm'>
+  <p class=MsoFooter style='tab-stops:right 432.0pt;mso-element:frame;
+  mso-element-wrap:no-wrap-beside;mso-element-anchor-vertical:paragraph;
+  mso-element-anchor-horizontal:margin;mso-element-left:center;mso-element-top:
+  .05pt;mso-height-rule:exactly'><!--[if supportFields]><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><span
+  style='mso-element:field-begin'></span><span
+  style='mso-spacerun:yes'> </span>PAGE <span style='mso-element:field-separator'></span></span></span><![endif]--><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'>ix</span></span><!--[if supportFields]><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><span
+  style='mso-element:field-end'></span></span></span><![endif]--><span
+  class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><o:p></o:p></span></span></p>
+  </td>
+ </tr>
+</table>
+
+</div>
+
+<![if !supportTextWrap]><br clear=ALL>
+<![endif]>
+
+<p class=MsoFooter style='tab-stops:right 432.0pt'><span lang=EN-US>Copyright ©
+  {{ docyear }} IEEE. All rights reserved.</span></p>
+
+<p class=MsoFooter style='tab-stops:right 432.0pt'><span lang=EN-US>{% if draft %}This is an
+  unapproved IEEE Standards Draft, subject to change.{% endif %}</span></p>
+
+</div>
+
+</body>
+
+</html>
+

data/lib/isodoc/ieee/html/html_ieee_intro.html

@@ -0,0 +1,12 @@
+ <div id="boilerplate-legal-destination"/>
+<div id="boilerplate-license-destination"/>
+
+
+<nav>
+  <h1 id="content">{{ labels["table_of_contents"]}}</h1>
+  <div id="toc"></div>
+
+</nav>
+
+
+<div class="rule toc"></div>

data/lib/isodoc/ieee/html/html_ieee_titlepage.html

@@ -0,0 +1,44 @@
+<div id='toggle'> <span>•</span> </div>
+
+<div class="doctitle-en"><span>P{{ docnumeric }}™{% if draft %}/D{{ draft }}{% endif %}</span><br/>
+   <span lang="EN-US">{{ full_doctitle }}</span></div>
+{% if doctitleamdlabel %}
+<div class="doctitle-part">{{ doctitleamdlabel }}{% if doctitleamd %}: {{ doctitleamd }}{% endif %}</div>
+{% endif %}
+{% if doctitlecorrlabel %}
+<div class="doctitle-part">{{ doctitlecorrlabel }}</div>
+{% endif %}
+</div>
+
+<div><p>Developed by the</p>
+  <p><b>{{ technical_committee }}</b></p>
+<p>of the</p>
+<p><b>IEEE {{ society }}</b></p>
+<p>Approved {{ confirmeddate }}</p>
+<p>IEEE SA Standards Board</p>
+</div>
+
+
+
+
+<div class="coverpage_docstage">
+  {% if unpublished %}
+  <p>{{ stageabbr }} stage</p>
+  {% endif %}
+</div>
+
+{% if unpublished %}
+<div class="coverpage_warning">
+  <div id="boilerplate-license-destination"/>
+</div>
+{% endif %}
+<div class="coverpage-warning" id="coverpage-note-destination"/>
+
+{% if ics %}
+<p><b>ICS:</b> {{ ics }}</p>
+{% endif %}
+
+{% if keywords.size > 0 %}
+<p><b>Descriptors:</b> {{ keywords | join: ", " }}
+{% endif %}
+