asciidoctor-csand 0.2.5

data/lib/asciidoctor/csand/converter.rb

@@ -0,0 +1,174 @@
+require "asciidoctor"
+require "asciidoctor/csand/version"
+require "asciidoctor/csand/csandconvert"
+require "asciidoctor/iso/converter"
+
+module Asciidoctor
+  module Csand
+    CSAND_NAMESPACE = "https://open.ribose.com/standards/csand"
+
+    # A {Converter} implementation that generates CSAND output, and a document
+    # schema encapsulation of the document for validation
+    class Converter < ISO::Converter
+
+      register_for "csand"
+
+      def metadata_author(node, xml)
+        xml.contributor do |c|
+          c.role **{ type: "author" }
+          c.organization do |a|
+            a.name "Ribose"
+          end
+        end
+      end
+
+      def metadata_publisher(node, xml)
+        xml.contributor do |c|
+          c.role **{ type: "publisher" }
+          c.organization do |a|
+            a.name "Ribose"
+          end
+        end
+      end
+
+      def metadata_committee(node, xml)
+        xml.editorialgroup do |a|
+          a.technical_committee node.attr("technical-committee"),
+            **attr_code(type: node.attr("technical-committee-type"))
+        end
+      end
+
+      def title(node, xml)
+        ["en"].each do |lang|
+          xml.title **{ language: lang, format: "plain" } do |t|
+            t << asciidoc_sub(node.attr("title"))
+          end
+        end
+      end
+
+      def metadata_status(node, xml)
+        xml.status **{ format: "plain" } { |s| s << node.attr("status") }
+      end
+
+      def metadata_id(node, xml)
+        xml.docidentifier { |i| i << node.attr("docnumber") }
+      end
+
+      def metadata_copyright(node, xml)
+        from = node.attr("copyright-year") || Date.today.year
+        xml.copyright do |c|
+          c.from from
+          c.owner do |owner|
+            owner.organization do |o|
+              o.name "Ribose"
+            end
+          end
+        end
+      end
+
+      def title_validate(root)
+        nil
+      end
+
+      def makexml(node)
+        result = ["<?xml version='1.0' encoding='UTF-8'?>\n<csand-standard>"]
+        @draft = node.attributes.has_key?("draft")
+        result << noko { |ixml| front node, ixml }
+        result << noko { |ixml| middle node, ixml }
+        result << "</csand-standard>"
+        result = textcleanup(result.flatten * "\n")
+        ret1 = cleanup(Nokogiri::XML(result))
+        validate(ret1)
+        ret1.root.add_namespace(nil, CSAND_NAMESPACE)
+        ret1
+      end
+
+      def document(node)
+        init(node)
+        ret1 = makexml(node)
+        ret = ret1.to_xml(indent: 2)
+        filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
+          gsub(%r{^.*/}, "")
+        File.open(filename, "w") { |f| f.write(ret) }
+        html_converter(node).convert filename unless node.attr("nodoc")
+        @files_to_delete.each { |f| system "rm #{f}" }
+        ret
+      end
+
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "csand.rng"))
+      end
+
+      def html_doc_path(file)
+        File.join(File.dirname(__FILE__), File.join("html", file))
+      end
+
+      def literal(node)
+        noko do |xml|
+          xml.figure **id_attr(node) do |f|
+            figure_title(node, f)
+            f.pre node.lines.join("\n")
+          end
+        end
+      end
+
+      def sections_cleanup(x)
+        super
+        x.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+      end
+
+      def style(n, t)
+        return
+      end
+
+      def html_converter(_node)
+        CsandConvert.new(
+          htmlstylesheet: generate_css(html_doc_path("htmlstyle.scss"), true),
+          standardstylesheet: generate_css(html_doc_path("csand.scss"), true),
+          htmlcoverpage: html_doc_path("html_csand_titlepage.html"),
+          htmlintropage: html_doc_path("html_csand_intro.html"),
+          scripts: html_doc_path("scripts.html"),
+        )
+      end
+
+      def default_fonts(node)
+        b = node.attr("body-font") ||
+          (node.attr("script") == "Hans" ? '"SimSun",serif' :
+           '"Overpass",sans-serif')
+        h = node.attr("header-font") ||
+          (node.attr("script") == "Hans" ? '"SimHei",sans-serif' :
+           '"Overpass",sans-serif')
+        m = node.attr("monospace-font") || '"Space Mono",monospace'
+        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
+      end
+
+      def inline_quoted(node)
+        noko do |xml|
+          case node.type
+          when :emphasis then xml.em node.text
+          when :strong then xml.strong node.text
+          when :monospaced then xml.tt node.text
+          when :double then xml << "\"#{node.text}\""
+          when :single then xml << "'#{node.text}'"
+          when :superscript then xml.sup node.text
+          when :subscript then xml.sub node.text
+          when :asciimath then stem_parse(node.text, xml)
+          else
+            case node.role
+            when "strike" then xml.strike node.text
+            when "smallcap" then xml.smallcap node.text
+            when "keyword" then xml.keyword node.text
+            else
+              xml << node.text
+            end
+          end
+        end.join
+      end
+
+    end
+  end
+end

data/lib/asciidoctor/csand/csand.rng

@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    default namespace = "http://riboseinc.com/csand"
+    Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
+    we cannot have a new default namespace: we will end up with a grammar with two different
+    namespaces, one for isostandard and one for csand additions. And we do not want that.
+  -->
+  <include href="isostandard.rng">
+    <start>
+      <ref name="csand-standard"/>
+    </start>
+    <define name="language">
+      <element name="language">
+        <value>en</value>
+      </element>
+    </define>
+    <define name="docidentifier">
+      <element name="docidentifier">
+        <text/>
+      </element>
+    </define>
+    <define name="btitle">
+      <element name="title">
+        <ref name="FormattedString"/>
+      </element>
+    </define>
+    <define name="status">
+      <element name="status">
+        <choice>
+          <value>proposal</value>
+          <value>working-draft</value>
+          <value>committee-draft</value>
+          <value>draft-standard</value>
+          <value>final-draft</value>
+          <value>published</value>
+          <value>withdrawn</value>
+        </choice>
+      </element>
+    </define>
+    <define name="figure">
+      <element name="figure">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <ref name="source"/>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <choice>
+          <oneOrMore>
+            <ref name="figure"/>
+          </oneOrMore>
+          <group>
+            <choice>
+              <zeroOrMore>
+                <ref name="TextElement"/>
+              </zeroOrMore>
+              <ref name="pre"/>
+            </choice>
+            <zeroOrMore>
+              <ref name="note"/>
+            </zeroOrMore>
+            <optional>
+              <ref name="dl"/>
+            </optional>
+          </group>
+        </choice>
+      </element>
+    </define>
+    <!-- TextElement |= keyword -->
+    <define name="TextElement">
+      <choice>
+        <text/>
+        <ref name="em"/>
+        <ref name="eref"/>
+        <ref name="strong"/>
+        <ref name="stem"/>
+        <ref name="sub"/>
+        <ref name="sup"/>
+        <ref name="tt"/>
+        <ref name="strike"/>
+        <ref name="smallcap"/>
+        <ref name="xref"/>
+        <ref name="br"/>
+        <ref name="hyperlink"/>
+        <ref name="hr"/>
+        <ref name="pagebreak"/>
+        <ref name="bookmark"/>
+        <ref name="keyword"/>
+      </choice>
+    </define>
+  </include>
+  <define name="BibItemType" combine="choice">
+    <choice>
+      <value>code</value>
+      <value>presentation</value>
+      <value>proposal</value>
+      <value>standard</value>
+      <value>report</value>
+    </choice>
+  </define>
+  <define name="pre">
+    <element name="pre">
+      <text/>
+    </element>
+  </define>
+  <define name="keyword">
+    <element name="keyword">
+      <text/>
+    </element>
+  </define>
+  <define name="csand-standard">
+    <element name="csand-standard">
+      <ref name="bibdata"/>
+      <optional>
+        <ref name="version"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="termdocsource"/>
+      </zeroOrMore>
+      <ref name="preface"/>
+      <oneOrMore>
+        <ref name="sections"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="annex"/>
+      </zeroOrMore>
+      <ref name="bibliography"/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/csand/csandconvert.rb

@@ -0,0 +1,135 @@
+require "isodoc"
+
+module Asciidoctor
+  module Csand
+    # A {Converter} implementation that generates CSAND output, and a document
+    # schema encapsulation of the document for validation
+    class CsandConvert < IsoDoc::Convert
+      def initialize(options)
+        super
+        set_metadata(:status, "XXX")
+      end
+
+      def init_metadata
+        super
+      end
+
+      def title(isoxml, _out)
+        main = isoxml&.at(ns("//title[@language='en']"))&.text
+        set_metadata(:doctitle, main)
+      end
+
+      def subtitle(_isoxml, _out)
+        nil
+      end
+
+      def author(isoxml, _out)
+        set_metadata(:tc, "XXXX")
+        tc = isoxml.at(ns("//editorialgroup/technical-committee"))
+        set_metadata(:tc, tc.text) if tc
+      end
+
+
+      def docid(isoxml, _out)
+        docnumber = isoxml.at(ns("//bibdata/docidentifier"))
+        docstatus = isoxml.at(ns("//bibdata/status"))
+        dn = docnumber&.text
+        if docstatus
+          set_metadata(:status, status_print(docstatus.text))
+          abbr = status_abbr(docstatus.text)
+          dn = "#{dn}(#{abbr})" unless abbr.empty?
+        end
+        set_metadata(:docnumber, dn)
+      end
+
+      def status_print(status)
+        status.split(/-/).map{ |w| w.capitalize }.join(" ")
+      end
+
+      def status_abbr(status)
+        case status
+        when "working-draft" then "wd"
+        when "committee-draft" then "cd"
+        when "draft-standard" then "d"
+        else
+          ""
+        end
+      end
+
+      def pre_parse(node, out)
+        out.pre node.text # content.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+      end
+
+      def term_defs_boilerplate(div, source, term)
+        if source.empty? && term.nil?
+          div << @no_terms_boilerplate
+        else
+          div << term_defs_boilerplate_cont(source, term)
+        end
+      end
+
+      def i18n_init(lang, script)
+        super
+        @annex_lbl = "Appendix"
+      end
+
+      def error_parse(node, out)
+        # catch elements not defined in ISO
+        case node.name
+        when "pre" 
+          pre_parse(node, out)
+        when "keyword"
+          out.span node.text, **{ class: "keyword" }
+        else
+          super
+        end
+      end
+
+      HEAD = <<~HEAD.freeze
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+
+    <!--TOC script import-->
+    <script type="text/javascript"  src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"></script>
+
+    <!--Google fonts-->
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+    <!--Font awesome import for the link icon-->
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous">
+      HEAD
+
+      BUTTON = '<button onclick="topFunction()" id="myBtn" '\
+        'title="Go to top">Top</button>'.freeze
+
+
+      def html_main(docxml)
+        d = docxml.at('//div[@class="WordSection3"]')
+        s = d.replace("<main></main>")
+        s.first.children = d
+        s.first.children.first.previous = BUTTON
+      end
+
+      def html_preface(docxml)
+        super
+        docxml.at("//head").add_child(HEAD)
+        html_main(docxml)
+        docxml
+      end
+
+      def make_body(xml, docxml)
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
+        xml.body **body_attr do |body|
+          make_body1(body, docxml)
+          make_body2(body, docxml)
+          make_body3(body, docxml)
+        end
+      end
+
+      def html_toc(docxml)
+         docxml
+      end
+    end
+  end
+end
+