csd-html 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a846e0952a555b012a7c54e017cecade57c8043
+  data.tar.gz: 8019730bf22cf175dd364c318a1bd5c038fd0fa1
+SHA512:
+  metadata.gz: a924050b279bfbca9bf8cdc886d80d5d958b52d8afeb4bc9b143e4d993e9f3f7ab56af04c4d47117c065e3aba606e41049c5e3cf69254040297f2a6a34224069
+  data.tar.gz: a32f984d358797cbefb1c782cb5daa2ab92489939bbf65f2ddabf4ea9ad4bc3c044c466f8391d4f064d95330631731c1d342e640bd463b381edabde91f9d6493

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in csd-html.gemspec
+gemspec

data/README.adoc

@@ -0,0 +1 @@
+= CSD-HTML

data/README.md

@@ -0,0 +1,39 @@
+# Csd::Html
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/csd/html`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csd-html'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csd-html
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/csd-html. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Csd::Html project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/csd-html/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csd/html"
+
+# 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/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/csd-html.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "csd/html/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "csd-html"
+  spec.version       = Csd::Html::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "csd-html lets you convert CSD XML into HTML."
+  spec.description   = <<~DESCRIPTION
+    csd-html lets you convert CSD XML into HTML.
+
+    This gem is in active development.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/riboseinc/csd-html"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/csd.make.sh

@@ -0,0 +1,8 @@
+if [[ ! -d jing-trang ]]; then
+  git clone https://github.com/relaxng/jing-trang.git
+fi
+cd jing-trang
+./ant
+cd ..
+java -jar jing-trang/build/trang.jar -I rnc -O rng csd.rnc csd.rng
+

data/csd.rnc

@@ -0,0 +1,609 @@
+default namespace = "http://riboseinc.com/isoxml"
+
+grammar {
+
+start = iso-standard
+
+iso-standard = 
+  element iso-standard {
+    title+,
+    documentstatus,
+    creator,
+    language,
+    script,
+    documenttype,
+    id,
+    version?,
+    copyright,
+    sections
+  }
+
+language =
+  element language { ( "en" | "fr" ) }
+
+script =
+  element script { "latn" }
+
+version =
+  element version {
+    edition?,
+    revdate?
+  }
+
+copyright = 
+  element copyright {
+    from, owner
+}
+
+from = element from { xsd:gYear }
+
+owner = 
+  element owner {
+    owner-affiliation  
+}
+
+owner-affiliation = element affiliation { "ISO" }
+
+id =
+  element id {
+    documentnumber,
+    tc-documentnumber?
+  }
+
+creator =
+  element creator { 
+    attribute role { text },
+    technical-committee,
+    subcommittee?,
+    workgroup?,
+    secretariat?
+  }
+
+documenttype =
+  element type {
+     ( "international-standard" | "technical-specification" | 
+       "technical-report" | "publicly-available-specification" | 
+        "international-workshop-agreement" | "guide" )
+  }
+
+documentstatus =
+  element status {
+     stage,
+     substage?
+  }
+
+stage = 
+  element stage {
+    ("00" | "10" | "20" | "30" | "40" | "50" | "60" | "90" | "95" )
+  }
+
+substage = 
+  element substage {
+    ("00" | "20" | "60" | "90" | "92" | "93" | "98" | "99" )
+  }
+
+documentnumber = 
+  element projectnumber { 
+    attribute part { xsd:int }?,
+    xsd:int 
+   }
+
+tc-documentnumber = 
+  element tc-documentnumber { 
+    xsd:int 
+   }
+
+technical-committee =
+  element technical-committee {
+    attribute number { xsd:int }?,
+    text
+  }
+
+subcommittee =
+  element subcommittee {
+    attribute number { xsd:int }?,
+    text
+  }
+
+workgroup =
+  element workgroup {
+    attribute number { xsd:int }?,
+    text
+  }
+
+secretariat =
+  element secretariat { text }
+
+revdate =
+  element revision-date { xsd:date }
+
+edition =
+  element edition { xsd:int }
+
+title = 
+  element title { 
+    attribute language { text }, 
+    title-intro?, title-main, title-part? 
+}
+
+title-intro =
+  element title-intro { text }
+
+title-main =
+  element title-main { text }
+
+title-part =
+  element title-part { text }
+
+sections =
+  element sections {
+    content, content?, 
+    clause, references, terms, clause+, 
+    annex*, references?
+  }
+
+content =
+  element content { Content-Section }
+
+content-subsection =
+  element subsection { Content-Section }
+
+Content-Section = 
+    attribute id { xsd:ID }?,
+    section-title?,
+    ( BasicBlock+ |
+      content-subsection+ )
+
+clause =
+  element clause { Clause-Section }
+
+Clause-Section =
+    attribute id { xsd:ID }?,
+    section-title?,
+    (
+      BasicBlock+ |
+       clause-subsection+
+    )
+
+clause-subsection =
+  element subsection { Clause-Section }
+
+references =
+  element references {
+    attribute id { xsd:ID }?,
+    section-title?,
+    bibitem*,
+    references*
+}
+
+terms = 
+  element terms { 
+    attribute id { xsd:ID }?,
+    section-title?,
+    # boilerplate
+    para*, ul?,
+    (term+ | terms? )
+  }
+
+term = 
+  element term { 
+    attribute id { xsd:ID }?,
+    preferred, admitted*, deprecates*,
+    termdomain?, definition?, termnote*, termexample*, termsource* 
+  }
+
+preferred = 
+  element preferred { TextElement+ }
+
+admitted = 
+  element admitted { TextElement+ }
+
+deprecates = 
+  element deprecates { TextElement+ }
+
+termdomain = 
+  element domain { TextElement+ }
+
+definition =
+  element definition {
+    ( para-no-fn | figure | formula )+
+  }
+
+termnote = 
+  element termnote { 
+    attribute id { xsd:ID },
+    (text | xref | eref | link)* 
+}
+
+termexample = 
+  element termexample { 
+    attribute id { xsd:ID },
+    BasicBlock 
+  }
+
+termsource = 
+  element termsource { 
+    attribute status { ( "identical" | "modified" ) },
+    origin, modification?
+}
+
+origin =
+  element origin { 
+    attribute citeas { text },
+    CitationType 
+}
+
+modification =
+  element modification { para-no-fn }
+
+BasicBlock = 
+( para | table | note | formula | admonition | ol | ul | dl | figure | 
+  quote | sourcecode | example )
+
+clause-hanging-para =
+  element subsection {
+    attribute id { xsd:ID }?,
+    section-title?,
+    # allow hanging paragraphs in annexes: they introduce lists
+    BasicBlock*,
+    clause-hanging-para*
+  }
+
+quote =
+  element quote {
+    attribute id { xsd:ID },
+    attribute align { Alignments }?,
+    quote-source?,
+    quote-author?,
+    BasicBlock*
+  }
+
+quote-source =
+  element source { CitationType }
+
+quote-author =
+  element author { CreatorInfo }
+
+
+annex =
+  element annex { 
+    attribute id { xsd:ID }?,
+    attribute subtype { "normative" | "informative" }?,
+    section-title?,
+    # allow hanging paragraphs in annexes: they introduce lists
+    #( para | table | note | formula | admonition | ol | ul | dl | figure | quote | sourcecode | review | example )*,
+    BasicBlock*,
+    clause-hanging-para*
+  }
+
+TextElement = 
+  text | em | eref | link | strong | stem | sub | sup | tt | strike |
+  smallcap | xref | br | hr | pagebreak
+
+Alignments = ( "left" | "center" | "right" | "justified" )
+
+para =
+     element p {
+       attribute id { xsd:ID },
+       attribute align { Alignments }?,
+       ( TextElement | fn )*,
+       review*
+     }
+
+para-no-fn =
+     element p {
+       attribute id { xsd:ID },
+       attribute align { Alignments }?,
+       ( TextElement )*,
+       review*
+     }
+
+figure = 
+  element figure {
+    attribute id { xsd:ID },
+    tname?,
+    ( image | figure+ ),
+    fn*,
+    dl?,
+    note*
+  }
+
+image =
+  element image {
+    attribute src { text }?,
+    attribute id { xsd:ID },
+    attribute imagetype { text },
+    attribute width {xsd:int}?,
+    attribute height {xsd:int}?
+}
+
+sourcecode =
+  element sourcecode {
+    attribute id { xsd:ID },
+    tname?,
+    ( text | callout )*,
+    annotation*
+  }
+
+review =
+  element review {
+    attribute reviewer { text },
+    attribute date { text },
+    text
+  }
+
+callout =
+  element callout {
+    attribute target { xsd:IDREF },
+    text
+  }
+
+annotation =
+  element annotation {
+    attribute id { xsd:ID },
+    text
+  }
+
+fn =
+  element fn { 
+    attribute reference { text },
+       para-no-fn+
+     }
+
+ol =
+  element ol { 
+    attribute id { xsd:ID },
+    attribute type { 
+      ( "roman" | "alphabet" | "arabic" | "roman_upper" | "alphabet_upper" ) },
+    li+ 
+  }
+
+ul = 
+  element ul { 
+    attribute id { xsd:ID },
+    li+ 
+}
+
+li =
+  element li {
+    #( para | table | note | formula | admonition | ol | ul | dl | quote | sourcecode | review | example )+
+    BasicBlock+
+    # exclude figures?
+  }
+
+dl =
+  element dl {
+    attribute id { xsd:ID },
+    (dt, dd)+
+  }
+
+dt =
+  element dt {
+    ( TextElement )
+  }
+
+dd =
+  element dd {
+    #( para | table | note | formula | admonition | ol | ul | dl | quote | sourcecode | review | example )*
+    # exclude figures?
+    BasicBlock+
+  }
+
+note =
+  element note { 
+    attribute id { xsd:ID },
+    para+ 
+  }
+
+admonition =
+  element admonition { 
+    attribute id { xsd:ID },
+    attribute type { 
+     ( "danger" | "caution" | "warning" | "important" | "safety precautions" )},
+    para+ 
+  }
+
+formula =
+  element formula { 
+    attribute id { xsd:ID },
+    stem,
+    dl?
+  }
+
+example = 
+  element example {
+    attribute id { xsd:ID },
+    ( para | formula | ol | ul | dl | quote | sourcecode | review )+
+  }
+
+xref =
+  element xref { 
+    attribute target { xsd:IDREF },
+    text
+  }
+
+link =
+  element link {
+    attribute target {xsd:anyURI},
+    text
+}
+
+ReferenceFormat = ( "external" | "inline" | "footnote" | "callout" )
+
+eref =
+  element eref { 
+    attribute type { ReferenceFormat }?,
+    attribute normative { xsd:boolean }?,
+    attribute citeas { text },
+    CitationType,
+    text 
+  }
+
+br = element br { empty }
+hr = element hr { empty }
+pagebreak = element pagebreak { empty }
+
+em =
+  element em { text }
+
+strong =
+  element strong { text }
+
+stem =
+  element stem { 
+    attribute type { "MathML" },
+    text 
+}
+
+sub =
+  element sub { text }
+
+sup =
+  element sup { text }
+
+tt =
+  element tt { text }
+
+strike = element strike { text }
+
+smallcap = element smallcap { text }
+
+table =
+  element table {
+    attribute id { xsd:ID },
+    tname?, thead?, tbody, tfoot?, dl?, note*
+  }
+
+tname =
+  element name { text }
+
+section-title =
+  element title { text }
+
+thead =
+  element thead { tr+ }
+
+tbody =
+  element tbody { tr+ }
+
+tfoot =
+  element tfoot { tr+ }
+
+tr =
+  element tr { (td | th)+ }
+
+th =
+  element th { 
+    attribute colspan { text }?,
+    attribute rowspan { text }?,
+    attribute align { text }?,
+    ( TextElement | fn | para)* 
+  }
+
+td =
+  element td { 
+    attribute colspan { text }?,
+    attribute rowspan { text }?,
+    attribute align { text }?,
+    ( TextElement | fn | para)* 
+  }
+
+CreatorInfo =
+    attribute role { text },
+    fullname?, affiliation?, person-identifier*
+
+publisher = 
+  element publisher { CreatorInfo }
+# a publisher has a subset of the roles of a creator
+
+fullname =
+  element fullname {
+    prefix*, forename*, initial*, surname, addition*
+}
+
+prefix = element prefix { text }
+initial = element initial { text }
+addition = element addition { text }
+surname = element surname { text }
+forename = element forename { text }
+
+affiliation =
+  element affiliation { Organization }
+
+Organization =  
+    orgname, uri?, address?, org-identifier*
+
+orgname =
+  element name { text }
+
+uri =
+  element uri { text }
+
+address =
+  element address {
+    # iso191606 TODO
+    street+, city, state?, country, postcode?
+}
+
+street = element street { text }
+city = element city { text }
+state = element state { text }
+country = element country { text }
+postcode = element postcode { text }
+
+person-identifier =
+  element identifier {
+    attribute type { ("isni" | "uri") },
+    text
+  }
+
+org-identifier =
+  element identifier {
+    attribute type { ("orcid" | "uri") },
+    text
+  }
+
+CitationType = 
+   attribute bibitemid { xsd:IDREF },
+   locality*, date?
+
+date = element date { string }
+
+locality =
+  element locality {
+    attribute type { 
+      ( "section" | "clause" | "part" | "paragraph" | "chapter" | "page" | 
+        "whole" ) },
+    text
+}
+
+bibitem =
+  element bibitem { BibItemType }
+
+BibItemType =
+  attribute id { xsd:ID },
+  attribute type { 
+    ( "article" | "book" | "booklet" | "conference" | "manual" |
+     "proceedings" | "presentation" | "thesis" | "techreport" | "standard" | 
+     "unpublished" ) }?,
+  ( bname | formatted ), 
+  source?, publishdate?, docidentifier*, accesseddate?, creator*, 
+  publisher*, edition?, biblioNote*, partOf*, creationdate?, language*, script*,
+  abstract?
+
+bname = element name { text }
+formatted = element formatted { TextElement+ }
+source = element source { xsd:anyURI }
+publishdate = element publishdate { text }
+docidentifier = element docidentifier { text }
+accesseddate = element accesseddate { text }
+creationdate = element creationdate { text }
+abstract = element abstract { text }
+biblioNote = element note { text }
+
+partOf = element partOf { BibItemType }
+
+
+}
+
+