asciidoctor-csand 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a6d22ce8dc776cd2f64ef77b55df5a903abc98a56fc6cd2245f7b5fe97c04c
-  data.tar.gz: db40f9ed86dd73a03a32d73e4348cd006b86257539db653c9fa52237aaa27d7c
+  metadata.gz: a0b9a7c1dddf60cd463c47b59fd40b21f97089f77347e25587a16d728eda9bff
+  data.tar.gz: 7162ad6d864ea523d6710fe44725b563f58d74186af640eef45779970582081b
 SHA512:
-  metadata.gz: '0158a7ca61c916bd4ddf0ef1c0360ba8bf5f142ba74e245f245608713e8f9f0d3c86e3312b763c419cc1c1a4ee178b022f1632883acabdfab0918ae1001bc475'
-  data.tar.gz: 341cab8af82ecd42c3c321da3dc5fffd008ba08169df04c0afe5bde038842e43c17f458af37b89197f090b7404d7dfca41a439dd8e53e526c13291f196ed352d
+  metadata.gz: 53354dcb72c62ee58cfcb3b7d2f1e4f62e0f5f021f5fb668346032caf1928a32281c08a579e692f0d50514ed7d396f55d16c0649394598f72a5f087df9e5d193
+  data.tar.gz: ae75ceb67875df08ac2f6f7f00ad4928916239f04ea938872df9d032d6ae723a5d3c5e92c2e76a00bcb1891370947e16b6d7ed77dbe7e299c84c39ef99a562af

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/riboseinc/asciidoctor-iso
-  revision: 1fca67f1a4e7a67461ea3999918abc10bca3ca2c
+  revision: 575341655824ef6fd612e710dcee60aa30177b9d
   specs:
-    asciidoctor-iso (0.9.0)
+    asciidoctor-iso (0.9.1)
       asciidoctor (~> 1.5.7)
       iso-bib-item (~> 0.1.6)
       isobib (~> 0.1.6)
@@ -51,9 +51,50 @@ GEM
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     asciidoctor (1.5.7.1)
+    asciidoctor-csd (0.4.0)
+      asciidoctor-iso (>= 0.9.0)
+      isodoc (>= 0.8.0)
+    asciidoctor-gb (0.3.0)
+      asciidoctor-iso (>= 0.9.0)
+      isodoc (>= 0.8.0)
+      twitter_cldr
+    asciidoctor-m3d (0.3.1)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.9.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.8.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
+    asciidoctor-rfc (0.9.0)
+      asciidoctor (~> 1.5.7)
+      htmlentities (~> 4.3.4)
+      nokogiri
+      ruby-jing
+      thread_safe
+    asciidoctor-rsd (0.3.1)
+      asciidoctor (~> 1.5.7)
+      asciidoctor-iso (>= 0.8.0)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      isodoc (>= 0.7.0)
+      mime-types
+      nokogiri
+      ruby-jing
+      ruby-xslt
+      thread_safe
+      uuidtools
     asciimath (1.0.4)
     ast (2.4.0)
     byebug (9.1.0)
+    camertron-eprun (1.1.1)
+    cldr-plurals-runtime-rb (1.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -88,11 +129,11 @@ GEM
     htmlentities (4.3.4)
     httpclient (2.8.3)
     image_size (2.0.0)
-    iso-bib-item (0.1.6)
+    iso-bib-item (0.1.8)
       duplicate
       isoics (~> 0.1.6)
       nokogiri
-    isobib (0.1.6)
+    isobib (0.1.7)
       algoliasearch
       iso-bib-item (~> 0.1.2)
     isoics (0.1.6)
@@ -104,6 +145,15 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
+    metanorma (0.2.2)
+      asciidoctor-csand (>= 0.3.0)
+      asciidoctor-csd (>= 0.4.0)
+      asciidoctor-gb (>= 0.3.0)
+      asciidoctor-iso (>= 0.9.0)
+      asciidoctor-m3d (>= 0.3.1)
+      asciidoctor-rfc (>= 0.9.0)
+      asciidoctor-rsd (>= 0.3.0)
+      isodoc (>= 0.8.0)
     method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -169,6 +219,12 @@ GEM
     thor (0.20.0)
     thread_safe (0.3.6)
     timecop (0.9.1)
+    twitter_cldr (4.4.3)
+      camertron-eprun
+      cldr-plurals-runtime-rb (~> 1.0)
+      tzinfo
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
     uuidtools (2.1.5)
 
@@ -184,6 +240,7 @@ DEPENDENCIES
   guard (~> 2.14)
   guard-rspec (~> 4.7)
   isodoc!
+  metanorma
   rake (~> 12.0)
   rspec (~> 3.6)
   rubocop (~> 0.50)

data/README.adoc

@@ -28,20 +28,19 @@ expressions.
 International Standards.
 * The XML representation is processed in turn to generate the following outputs
 as end deliverable CSAND standard drafts.
-** Microsoft Word output (`.doc`), following the style conventions of the
-https://www.csand.org/csand-templates.html[CSAND Standard Microsoft Word template].
-(In development)
-** PDF (forthcoming)
-** HTML (forthcoming)
+** HTML output.
 
 This AsciiDoc syntax for writing CSAND standards is hereby named "AsciiCSAND".
 
 == Usage
 
+The preferred way to invoke this gem is via the `metanorma` script:
+
 [source,console]
 ----
-$ asciidoctor a.adoc  # HTML output of Asciidoc file
-$ asciidoctor -b csand -r 'asciidoctor-csand' a.adoc  # CSAND XML output
+$ metanorma --type csand a.adoc                   # output just HTML
+$ metanorma --type csand a.adoc --extensions html # output just HTML
+$ metanorma --type csand a.adoc --extensions xml  # output CSAND XML
 ----
 
 The gem translates the document into CSAND XML format, and then
@@ -50,42 +49,30 @@ reported to console against the XML, and are intended for users to
 check that they have provided all necessary components of the
 document.
 
-TODO: The gem will then convert the XML to Word Document, HTML, and
-PDF, and output those files with the appropriate file suffixes.
-`lib/asciidoctor/csand/csand2wordhtml.rb` is work in progress, and not yet
-integrated into the executable.
-
-=== Content Warnings
-
-The gem also realises several format checks as prescribed in ISO/IEC
-DIR 2, and warns the user about them in the console:
-
-* Numbers with what looks like dots instead of commas for decimal points.
-
-* Groups of numbers without spacing for every three digits. (The gem attempts
-to ignore CSAND references.)
+The gem then converts the XML to HTML, and
+outputs that files with the appropriate `.html` suffix.
 
-* No space before percent sign.
+The gem can also be invoked directly within asciidoctor, though this is deprecated:
 
-* No bracketing of tolerance in percentage (e.g. `15 ± 7 % .`)
-
-* No recommendations, permissions or requirements (detected by keyword) in:
-foreword, scope, introduction, term examples and examples, notes, footnotes.
-
-* No subclauses that are the only child of a clause. (In clauses, annexes, or
-scopes.)
+[source,console]
+----
+$ asciidoctor -b csand -r 'asciidoctor-csand' a.adoc  
+----
 
-* 5 levels of subclause nesting. (Never actuated, AsciiDoc only permits 4
-levels of subsections.)
+=== Installation
 
-* Non-CSAND/IEC reference turning up as normative.
+If you are using a Mac, the https://github.com/riboseinc/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:
 
-* Term definition starts with an article, or ends with a period.
+[source,console]
+----
+$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ gem install asciidoctor-csand
 
-* Title intro or title part appears in only one of French or English.
+----
 
 == Approach
-
 === Document model
 
 The Ribose Standard Document model is an instance of the
@@ -119,102 +106,6 @@ recognised by fixed titles such as `Normative References`). Authoring CSAND
 standards in this fashion assumes that users will be populating an Asciidoc
 template, and not removing needed formatting instructions.
 
-=== Features not visible in HTML preview
-
-The gem uses built-in Asciidoc formatting as much as possible, so that users
-can retain the ability to preview documents; for _Terms and Definitions_
-clauses, which have a good deal of explicit structure, macros have been
-introduced for semantic markup (admitted terms, deprecated terms, etc). The
-default HTML output of an Asciidoc-formatted CSAND document is quite close to the
-intended final output, with the following exceptions. Note that the final
-outputs of the conversion (Microsoft Word, PDF, HTML) do not have these exceptions,
-and comply with the CSAND Standard specifications.
-
-* _Terms and Definitions_: each term is marked up as an unnumbered subclause,
-the semantic markup of alternate and other terms is not rendered visually.
-
-* _Formulas_: Asciidoctor has no provision for the automated numbering of
-isolated block formulas ("stem"), and does not display the number assigned a
-block formula in its default HTML processor—although it does provide automated
-numbering of examples. Formula numbering is provided in the final outputs
-of the conversion.
-
-* _Missing elements_: The document model does not yet include Asciidoc elements
-that do not appear to be relevant to CSAND Standards; these will be ignored in
-generating CSAND XML. Those elements include:
-* sidebars (`aside`) (as distinct from warnings),
-* ASCII art/preformatted text (`literal`) (as distinct from sourcecode listings),
-* page breaks (`thematic break`).
-
-* _Markup_: Some connecting text which is used to convey markup structure is
-left out: in particular, `DEPRECATED` and `SOURCE` (replaced by formatting
-macros).
-
-* _Tables_: Table footnotes are treated like all other footnotes: they are
-rendered at the bottom of the document, rather than the bottom of the table,
-and they are not numbered separately.
-
-* _Cross-references_: Footnoted cross-references are indicated with the reference
-text `fn` in csandlation, or `fn:` as a prefix to the reference text. The default
-HTML processor leaves these as is: if no reference text is given, only `fn`
-will be displayed (though it will still hyperlink to the right reference).
-
-* _References_: The convention for references is that CSAND documents are cited
-without brackets by CSAND number, and optionally year, whether they are normative
-or in the bibliography (e.g. `CSAND 20483:2013`); while all other references are
-cited by bracketed number in the bibliography (e.g. `[1]`). The default HTML
-processor treats all references the same, and will bracket them (e.g. `[CSAND
-20483:2013]`). For the same reason, CSAND references listed in the bibliography
-will be listed under an CSAND reference, rather than a bracketed number.
-
-* _References_: References are rendered cited throughout, since they are
-automated. For that reason, if reference is to be made to both an undated and a
-dated version of an CSAND reference, these need to be explicitly listed as
-separate references. (This is not done in the Rice model document, which lists
-CSAND 6646, but under _Terms and Definitions_ cites the dated CSAND 6646:2011.
-
-* _References_: CSAND references that are undated but published have their date
-indicated under the CSAND standards format in an explanatory footnote. Because of
-constraints introduced by Asciidoctor, that explanation is instead given in
-square brackets in Asciidoc format.
-
-* _Annexes_: Subheadings cannot preserve subsection numbering, while also
-appearing inline with their text (e.g. Rice document, Annex B.2): they appear
-as headings in separate lines.
-
-* _Annexes_: Cross-references to Annex subclauses are automatically prefixed
-with `Clause` rather than `Annex` or nothing.
-
-* _Metadata_: Document metadata such as document numbers, technical committees
-and title wording are not rendered in the default HTML output.
-
-* _Patent Notice_: Patent notices are treated and rendered as a subsection of
-the introduction, with an explicit subheading.
-
-* _Numbering_: The numbering of figures and tables is sequential in the default
-HTML processor: it does not include the Clause or Annex number. This,
-_Figure 1_, not _Figure A.1_.
-
-* _Notes_: There is no automatic note numbering by the default HTML processor.
-
-* _Review Notes_: The reviewer on the review note is not displayed.
-
-* _Keys_: Keys to formulas and figures are expected to be marked up as
-definition lists consistently, rather than as inline prose.
-
-* _Figures_: Simple figures are marked up as images, figures containing
-subfigures as examples. Numbering by the default HTML processor may be
-inconsistent. Subfigures are automatically numbered as independent figures.
-
-* _Markup_: The default HTML processor does not support CSS extensions such as
-small caps or strike through, though these can be marked up as CSS classes
-through custom macros in Asciidoctor: a custom CSS stylesheet will be needed to
-render them.
-
-
-
-TODO: May need to only encode figures as examples.
-
 == Document Attributes
 
 The gem relies on Asciidoctor document attributes to provide necessary

data/asciidoctor-csand.gemspec

@@ -49,4 +49,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 0.50"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "metanorma"
 end

data/lib/asciidoctor/csand/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Csand
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/metanorma/csand/processor.rb

@@ -16,6 +16,10 @@ module Metanorma
         }
       end
 
+      def version
+        "Asciidoctor::Csand #{Asciidoctor::Csand::VERSION}"
+      end
+
       def input_to_isodoc(file)
         Metanorma::Input::Asciidoc.new.process(file, @asciidoctor_backend)
       end
@@ -29,4 +33,4 @@ module Metanorma
 
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-csand
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -318,6 +318,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: metanorma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   asciidoctor-csand lets you write CSA Normal Documents (CSAND) in AsciiDoc syntax.
 
@@ -380,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: asciidoctor-csand lets you write CSA Normal Documents (CSAND) in AsciiDoc.