metanorma-rsd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90dcb826d122d0f60ce92be0c6a577dbfe7117b009d03f8a7eb9886534ddab09
+  data.tar.gz: 5398e6d0764d21e0447b0ba2b75056f1afd982044460674e9673e53f6c910e69
+SHA512:
+  metadata.gz: 17a7fca7cb54517f59cad5081eeb0ccd1e62ee72405a70f0c64c4a010bf369ab65da08526e7eaa49311ede0a7ab65fdc968f5648ad2fa5b44a0df1a9cd84d8fb
+  data.tar.gz: 619a4418280c5f09794f759e85d01ba7e150e29ab90c89f86b5005afbc93f6494981642ddcd63cb525a8a3dfbce8822c68b34cfa1a87cd4f2551d60b1a6be4f4

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/.travis.yml

@@ -0,0 +1,17 @@
+dist: trusty
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+  - ruby-head
+before_install:
+  - gem install bundler -v 1.16.1
+  - npm install -g puppeteer
+  - npm install
+  - unset _JAVA_OPTIONS
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+

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,4 @@
+source "https://rubygems.org"
+git_source(:github) {|repo| "https://github.com/#{repo}" }
+
+gemspec

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,173 @@
+= AsciiRSD: Asciidoctor processor for Ribose Standard Documents (RSD)
+
+image:https://img.shields.io/gem/v/metanorma-rsd.svg["Gem Version", link="https://rubygems.org/gems/metanorma-rsd"]
+image:https://img.shields.io/travis/riboseinc/metanorma-rsd/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma-rsd"]
+image:https://codeclimate.com/github/riboseinc/metanorma-rsd/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma-rsd"]
+
+WARNING: This gem is still under development.
+
+== Functionality
+
+This gem processes http://asciidoctor.org/[Asciidoctor] documents following
+a template for generating RSD documents.
+
+The gem currently inherits from the https://github.com/riboseinc/metanorma-standoc
+gem, and aligns closely to it. Refer to the ISO gem documentation
+for guidance, including https://github.com/riboseinc/metanorma-iso/wiki/Guidance-for-authoring
+
+The following outputs are generated.
+
+* (Optional) An HTML preview generated directly from the Asciidoctor document,
+using native Asciidoctor formatting.
+** 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.
+* an XML representation of the document, intended as a document model for RSD
+International Standards.
+* The XML representation is processed in turn to generate the following outputs
+as end deliverable RSD standard drafts.
+** DOC
+** HTML
+
+This AsciiDoc syntax for writing RSD standards is hereby named "AsciiRSD".
+
+== Usage
+
+The preferred way to invoke this gem is via the `metanorma` script:
+
+[source,console]
+----
+$ metanorma --type rsd a.adoc                   # output HTML and DOC
+$ metanorma --type rsd --extensions html a.adoc # output just HTML
+$ metanorma --type rsd --extensions doc a.adoc  # output just DOC
+$ metanorma --type rsd --extensions xml a.adoc  # output RSD XML
+----
+
+The gem translates the document into RSD XML format, and then
+validates its output against the RSD 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 and PDF.
+
+The gem can also be invoked directly within asciidoctor, though this is deprecated:
+
+[source,console]
+----
+$ asciidoctor -b rsd -r 'metanorma-rsd' a.adoc  
+----
+
+=== Installation
+
+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:
+
+[source,console]
+----
+$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ gem install metanorma-rsd
+----
+
+
+== Approach
+
+=== Document model
+
+The Ribose Standard Document model is an instance of the
+https://github.com/riboseinc/isodoc-models[StandardDocument model].
+
+The RSD format ("RSD XML") intends to introduce rigor into the RSD
+standards authoring process, and is prescribed in a separate document.
+
+RSD XML is still under development, but it already contains all the markup
+needed to render a RSD document into HTML.
+
+WARNING: The current RNG model of RSD XML is out of sync with the UML.
+
+=== Asciidoctor
+
+Asciidoctor has been selected as the authoring tool to generate the document
+model representation of RSD standards. It is a document formatting tool like
+Markdown and DocBook, which combines the relative ease of use of the former
+(using relatively lightweight markup), and the rigor and expressively of the
+latter (it has a well-defined syntax, and was in fact initially developed as a
+DocBook document authoring tool). Asciidoctor has built-in capability to output
+Text, DocBook and HTML; so it can be used to preview the file as it is being
+authored.
+
+Note that in order to generate HTML preview output close to what is intended
+in the RSD standard, the Asciidoc
+document includes a fair amount of formatting instructions (e.g. disabling
+section numbering where appropriate, the titling of Appendixes as Annexes), as
+well as RSD boilerplate text, and predefined section headers (sections are
+recognised by fixed titles such as `Normative References`). Authoring RSD
+standards in this fashion assumes that users will be populating an Asciidoc
+template, and not removing needed formatting instructions.
+
+== Document Attributes
+
+The gem relies on Asciidoctor document attributes to provide necessary
+metadata about the document. These include:
+
+`:edition:`:: The document edition
+
+`:revdate:`:: The date the document was last updated
+
+`:copyright-year:`:: The year which will be claimed as when the copyright for
+the document was issued
+
+`:title:`:: The main component of the English title of the document
+(mandatory). (The first line of the AsciiDoc document, which contains the title
+introduced with `=`, is ignored)
+
+`:doctype:`:: The document type (see RSD deliverables: The different types of
+RSD publications) (mandatory). The permitted types are:
++
+--
+* policy-and-procedures
+* best-practices
+* supporting-document
+* report
+* legal
+* directives
+* proposal
+* standard
+--
+
+`:status:``:: The document status. The permitted types are: `proposal`,
+`working-draft`, `committee-draft`, `draft-standard`, `final-draft`,
+`published`, `withdrawn`.
+
+`:committee:`:: The name of the relevant RSD committee (mandatory)
+`:committee-type:`:: The type of the relevant RSD committee (mandatory): `technical`
+or `provisional`.
+
+`:language:` :: The language of the document (only `en` for now)  (mandatory)
+
+`:security:` :: Security level classification, e.g., "confidential", "client confidential"
+
+The attribute `:draft:`, if present, includes review notes in the XML output;
+these are otherwise suppressed.
+
+== AsciiRSD features not also present in AsciiISO
+
+* `+[keyword]#...#+`: encodes keywords, such as "MUST", "MUST NOT". (Encoded as
+`<span class="keyword">...</span>`.
+
+== Data Models
+
+The RSD Standard Document format is an instance of the
+https://github.com/riboseinc/isodoc-models[StandardDocument model]. Details of
+this general model can be found on its page. Details of the RSD modifications
+to this general model can be found on the https://github.com/riboseinc/rsd[RSD model]
+repository.
+
+== Examples
+
+* link:spec/examples/rfc6350.adoc[] is an AsciiRSD version of https://tools.ietf.org/html/rfc6350[RFC 6350].
+* link:spec/examples/rfc6350.html[] is an HTML file generated from the AsciiRSD.
+* link:spec/examples/rfc6350.doc[] is a Word document generated from the AsciiRSD.

data/Rakefile

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

data/asciidoctor-rsd.gemspec.old

@@ -0,0 +1,46 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "asciidoctor/rsd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-rsd"
+  spec.version       = Asciidoctor::Rsd::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "asciidoctor-rsd lets you write RSD in AsciiDoc."
+  spec.description   = <<~DESCRIPTION
+    asciidoctor-rsd lets you write RSD in AsciiDoc syntax.
+
+    This gem is in active development.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/riboseinc/asciidoctor-rsd"
+  spec.license       = "BSD-2-Clause"
+  spec.post_install_message = "The asciidoctor-rsd gem has been deprecated and has been replaced by metanorma-rsd"
+
+  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_dependency "asciidoctor", "~> 1.5.7"
+  spec.add_dependency "htmlentities", "~> 4.3.4"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "asciidoctor-iso", "~> 0.10.1"
+  spec.add_dependency "isodoc", "~> 0.8.8"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  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", "~> 0.2.6"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asciidoctor/rsd"
+
+# 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,18 @@
+#!/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/asciidoctor-rsd.rb

@@ -0,0 +1,11 @@
+require "asciidoctor" unless defined? Asciidoctor::Converter
+require_relative "asciidoctor/rsd/converter"
+require_relative "isodoc/rsd/html_convert"
+require_relative "isodoc/rsd/word_convert"
+require_relative "isodoc/rsd/pdf_convert"
+require_relative "asciidoctor/rsd/version"
+
+if defined? Metanorma
+  require_relative "metanorma/rsd"
+  Metanorma::Registry.instance.register(Metanorma::Rsd::Processor)
+end

data/lib/asciidoctor/rsd.rb

@@ -0,0 +1,9 @@
+require "asciidoctor/rsd/version"
+
+module Asciidoctor
+  module Rsd
+
+    RSD_NAMESPACE = "https://open.ribose.com/standards/rsd"
+
+  end
+end

data/lib/asciidoctor/rsd/biblio.rng

@@ -0,0 +1,836 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  instantiations of this grammar may replace leaf strings
+  with more elaborated types; e.g. title (text) replaced with
+  title-main, title-intro, title-part; type replaced with
+  enum.
+  
+  some renaming at leaf nodes is permissible
+  
+  obligations can change both from optional to mandatory,
+  and from mandatory to optional; optional elements may
+  be omitted; freely positioned alternatives may be replaced
+  with strict ordering
+  
+  DO NOT introduce a namespace here. We do not want a distinct namespace
+  for these elements, and a distinct namespace for any grammar inheriting
+  these elements; we just want one namespace for any child grammars
+  of this.
+-->
+<grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <define name="status">
+    <element name="status">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="language">
+    <element name="language">
+      <text/>
+    </element>
+  </define>
+  <define name="script">
+    <a:documentation>ISO-639</a:documentation>
+    <element name="script">
+      <text/>
+    </element>
+  </define>
+  <define name="edition">
+    <a:documentation>ISO-15924: Latn</a:documentation>
+    <element name="edition">
+      <text/>
+    </element>
+  </define>
+  <define name="LocalizedString">
+    <optional>
+      <!-- multiple languages and scripts possible: comma delimit them if so -->
+      <attribute name="language"/>
+    </optional>
+    <optional>
+      <attribute name="script"/>
+    </optional>
+    <text/>
+  </define>
+  <!--
+    Unlike UML, change type to format: type is overloaded
+    Would be need if plain were default value and could omit the attribute
+    Added LocalizedStringOrXsAny
+  -->
+  <define name="FormattedString">
+    <optional>
+      <!-- attribute format { ( "plain" | "html" | "docbook" | "tei" | "asciidoc" | "markdown" ) }?, -->
+      <attribute name="format">
+        <choice>
+          <value>text/plain</value>
+          <value>text/html</value>
+          <value>application/docbook+xml</value>
+          <value>application/tei+xml</value>
+          <value>text/x-asciidoc</value>
+          <value>text/markdown</value>
+          <value>application/x-isodoc+xml</value>
+          <text/>
+        </choice>
+      </attribute>
+    </optional>
+    <ref name="LocalizedStringOrXsAny"/>
+  </define>
+  <define name="LocalizedStringOrXsAny">
+    <optional>
+      <!-- multiple languages and scripts possible: comma delimit them if so -->
+      <attribute name="language"/>
+    </optional>
+    <optional>
+      <attribute name="script"/>
+    </optional>
+    <oneOrMore>
+      <choice>
+        <text/>
+        <ref name="AnyElement"/>
+      </choice>
+    </oneOrMore>
+  </define>
+  <define name="contributor">
+    <element name="contributor">
+      <zeroOrMore>
+        <ref name="role"/>
+      </zeroOrMore>
+      <ref name="ContributorInfo"/>
+    </element>
+  </define>
+  <define name="role">
+    <element name="role">
+      <optional>
+        <attribute name="type">
+          <choice>
+            <value>author</value>
+            <value>performer</value>
+            <value>publisher</value>
+            <value>editor</value>
+            <value>adapter</value>
+            <value>translator</value>
+            <value>distributor</value>
+          </choice>
+        </attribute>
+      </optional>
+      <zeroOrMore>
+        <ref name="roledescription"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="ContributorInfo">
+    <choice>
+      <ref name="person"/>
+      <ref name="organization"/>
+    </choice>
+  </define>
+  <define name="roledescription">
+    <element name="description">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="person">
+    <element name="person">
+      <optional>
+        <ref name="fullname"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="affiliation"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="person-identifier"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="contact"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="uri"/>
+      </optional>
+    </element>
+  </define>
+  <define name="fullname">
+    <element name="name">
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="prefix"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="forename"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="initial"/>
+          </zeroOrMore>
+          <ref name="surname"/>
+          <zeroOrMore>
+            <ref name="addition"/>
+          </zeroOrMore>
+        </group>
+        <ref name="completeName"/>
+      </choice>
+      <zeroOrMore>
+        <ref name="biblionote"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="prefix">
+    <element name="prefix">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="initial">
+    <element name="initial">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="addition">
+    <element name="addition">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="surname">
+    <element name="surname">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="forename">
+    <element name="forename">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="completeName">
+    <element name="completename">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="affiliation">
+    <element name="affiliation">
+      <optional>
+        <ref name="affiliationname"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="affiliationdescription"/>
+      </zeroOrMore>
+      <ref name="organization"/>
+    </element>
+  </define>
+  <define name="affiliationname">
+    <element name="name">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="affiliationdescription">
+    <element name="description">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="organization">
+    <element name="organization">
+      <ref name="orgname"/>
+      <optional>
+        <ref name="subdivision"/>
+      </optional>
+      <optional>
+        <ref name="abbreviation"/>
+      </optional>
+      <optional>
+        <ref name="uri"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="org-identifier"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="contact"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="orgname">
+    <element name="name">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="subdivision">
+    <element name="subdivision">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
+  <define name="uri">
+    <element name="uri">
+      <data type="anyURI"/>
+    </element>
+  </define>
+  <!-- TODO may change -->
+  <define name="contact">
+    <choice>
+      <ref name="address"/>
+      <ref name="phone"/>
+      <ref name="email"/>
+      <ref name="uri"/>
+    </choice>
+  </define>
+  <define name="phone">
+    <element name="phone">
+      <text/>
+    </element>
+  </define>
+  <define name="email">
+    <element name="email">
+      <text/>
+    </element>
+  </define>
+  <define name="address">
+    <element name="address">
+      <oneOrMore>
+        <!-- iso191606 TODO -->
+        <ref name="street"/>
+      </oneOrMore>
+      <ref name="city"/>
+      <optional>
+        <ref name="state"/>
+      </optional>
+      <ref name="country"/>
+      <optional>
+        <ref name="postcode"/>
+      </optional>
+    </element>
+  </define>
+  <define name="street">
+    <element name="street">
+      <text/>
+    </element>
+  </define>
+  <define name="city">
+    <element name="city">
+      <text/>
+    </element>
+  </define>
+  <define name="state">
+    <element name="state">
+      <text/>
+    </element>
+  </define>
+  <define name="country">
+    <element name="country">
+      <text/>
+    </element>
+  </define>
+  <define name="postcode">
+    <element name="postcode">
+      <text/>
+    </element>
+  </define>
+  <define name="person-identifier">
+    <element name="identifier">
+      <attribute name="type">
+        <choice>
+          <value>isni</value>
+          <value>uri</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
+  <define name="org-identifier">
+    <element name="identifier">
+      <attribute name="type">
+        <choice>
+          <value>orcid</value>
+          <value>uri</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
+  <define name="citation">
+    <element name="citation">
+      <ref name="CitationType"/>
+    </element>
+  </define>
+  <define name="CitationType">
+    <attribute name="bibitemid">
+      <data type="IDREF"/>
+    </attribute>
+    <zeroOrMore>
+      <ref name="locality"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="date"/>
+    </optional>
+  </define>
+  <define name="date">
+    <element name="date">
+      <choice>
+        <data type="gYear"/>
+        <data type="date"/>
+      </choice>
+    </element>
+  </define>
+  <define name="locality">
+    <element name="locality">
+      <ref name="BibItemLocality"/>
+    </element>
+  </define>
+  <define name="BibItemLocality">
+    <attribute name="type">
+      <ref name="LocalityType"/>
+    </attribute>
+    <ref name="referenceFrom"/>
+    <optional>
+      <ref name="referenceTo"/>
+    </optional>
+  </define>
+  <define name="LocalityType">
+    <data type="string">
+      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|example|volume|issue|locality:[a-zA-Z0-9_]+</param>
+    </data>
+  </define>
+  <define name="referenceFrom">
+    <element name="referenceFrom">
+      <text/>
+    </element>
+  </define>
+  <define name="referenceTo">
+    <element name="referenceTo">
+      <text/>
+    </element>
+  </define>
+  <!-- unlike UML, has id attribute; that results from including bibitem in a docmodel -->
+  <define name="bibitem">
+    <element name="bibitem">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <ref name="BibliographicItem"/>
+    </element>
+  </define>
+  <define name="bibitem_no_id">
+    <element name="bibitem">
+      <ref name="BibliographicItem"/>
+    </element>
+  </define>
+  <define name="BibItemType" combine="choice">
+    <choice>
+      <value>article</value>
+      <value>book</value>
+      <value>booklet</value>
+      <value>conference</value>
+      <value>manual</value>
+      <value>proceedings</value>
+      <value>presentation</value>
+      <value>thesis</value>
+      <value>techreport</value>
+      <value>standard</value>
+      <value>unpublished</value>
+      <value>map</value>
+      <value>electronic resource</value>
+      <value>audiovisual</value>
+      <value>film</value>
+      <value>video</value>
+      <value>broadcast</value>
+      <value>graphic work</value>
+      <value>music</value>
+      <value>patent</value>
+      <value>inbook</value>
+      <value>incollection</value>
+      <value>inproceedings</value>
+    </choice>
+  </define>
+  <define name="BibliographicItem">
+    <optional>
+      <attribute name="type">
+        <ref name="BibItemType"/>
+      </attribute>
+    </optional>
+    <choice>
+      <oneOrMore>
+        <ref name="btitle"/>
+      </oneOrMore>
+      <ref name="formattedref"/>
+    </choice>
+    <zeroOrMore>
+      <ref name="bsource"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="docidentifier"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bdate"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="edition"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="biblionote"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="language"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="script"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="abstract"/>
+    </optional>
+    <optional>
+      <ref name="status"/>
+    </optional>
+    <optional>
+      <ref name="copyright"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="docrelation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="series"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="medium"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bplace"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="extent"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="accesslocation"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="bclassification"/>
+    </optional>
+    <optional>
+      <ref name="validity"/>
+    </optional>
+  </define>
+  <define name="btitle">
+    <element name="title">
+      <ref name="TypedTitleString"/>
+    </element>
+  </define>
+  <define name="bsource">
+    <element name="uri">
+      <ref name="TypedUri"/>
+    </element>
+  </define>
+  <define name="formattedref">
+    <element name="formattedref">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="validity">
+    <element name="validity">
+      <optional>
+        <ref name="validityBegins"/>
+      </optional>
+      <optional>
+        <ref name="validityEnds"/>
+      </optional>
+      <optional>
+        <ref name="validityRevision"/>
+      </optional>
+    </element>
+  </define>
+  <define name="validityBegins">
+    <element name="validityBegins">
+      <data type="dateTime"/>
+    </element>
+  </define>
+  <define name="validityEnds">
+    <element name="validityEnds">
+      <data type="dateTime"/>
+    </element>
+  </define>
+  <define name="validityRevision">
+    <element name="revision">
+      <data type="dateTime"/>
+    </element>
+  </define>
+  <define name="TypedTitleString">
+    <optional>
+      <attribute name="type">
+        <ref name="TitleType"/>
+      </attribute>
+    </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>
+  <define name="TypedUri">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <data type="anyURI"/>
+  </define>
+  <define name="DateType">
+    <optional>
+      <attribute name="text"/>
+    </optional>
+    <optional>
+      <choice>
+        <data type="gYear"/>
+        <data type="date"/>
+      </choice>
+    </optional>
+  </define>
+  <define name="bdate">
+    <element name="date">
+      <attribute name="type">
+        <choice>
+          <value>published</value>
+          <value>accessed</value>
+          <value>created</value>
+          <value>implemented</value>
+          <value>obsoleted</value>
+          <value>confirmed</value>
+          <value>updated</value>
+          <value>issued</value>
+          <value>transmitted</value>
+          <value>copied</value>
+        </choice>
+      </attribute>
+      <choice>
+        <group>
+          <element name="from">
+            <choice>
+              <data type="gYear"/>
+              <data type="date"/>
+            </choice>
+          </element>
+          <optional>
+            <element name="to">
+              <choice>
+                <data type="gYear"/>
+                <data type="date"/>
+              </choice>
+            </element>
+          </optional>
+        </group>
+        <element name="on">
+          <choice>
+            <data type="gYear"/>
+            <data type="date"/>
+          </choice>
+        </element>
+      </choice>
+    </element>
+  </define>
+  <define name="docidentifier">
+    <element name="docidentifier">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
+  <define name="bclassification">
+    <element name="classification">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
+  <define name="bplace">
+    <element name="place">
+      <text/>
+    </element>
+  </define>
+  <define name="medium">
+    <element name="medium">
+      <optional>
+        <ref name="form"/>
+      </optional>
+      <optional>
+        <ref name="size"/>
+      </optional>
+      <optional>
+        <ref name="scale"/>
+      </optional>
+    </element>
+  </define>
+  <define name="form">
+    <element name="form">
+      <text/>
+    </element>
+  </define>
+  <define name="size">
+    <element name="size">
+      <text/>
+    </element>
+  </define>
+  <define name="scale">
+    <element name="scale">
+      <text/>
+    </element>
+  </define>
+  <define name="accesslocation">
+    <element name="accesslocation">
+      <text/>
+    </element>
+  </define>
+  <define name="extent">
+    <element name="extent">
+      <ref name="BibItemLocality"/>
+    </element>
+  </define>
+  <define name="series">
+    <element name="series">
+      <optional>
+        <attribute name="type">
+          <choice>
+            <value>main</value>
+            <value>alt</value>
+          </choice>
+        </attribute>
+      </optional>
+      <choice>
+        <ref name="btitle"/>
+        <ref name="formattedref"/>
+      </choice>
+      <ref name="bplace"/>
+      <ref name="seriesorganization"/>
+      <optional>
+        <ref name="abbreviation"/>
+      </optional>
+      <optional>
+        <ref name="seriesfrom"/>
+      </optional>
+      <optional>
+        <ref name="seriesto"/>
+      </optional>
+      <optional>
+        <ref name="seriesnumber"/>
+      </optional>
+      <optional>
+        <ref name="seriespartnumber"/>
+      </optional>
+    </element>
+  </define>
+  <define name="seriesorganization">
+    <element name="organization">
+      <text/>
+    </element>
+  </define>
+  <define name="seriesfrom">
+    <element name="from">
+      <choice>
+        <data type="dateTime"/>
+        <data type="gYear"/>
+      </choice>
+    </element>
+  </define>
+  <define name="seriesto">
+    <element name="to">
+      <choice>
+        <data type="dateTime"/>
+        <data type="gYear"/>
+      </choice>
+    </element>
+  </define>
+  <define name="seriesnumber">
+    <element name="number">
+      <text/>
+    </element>
+  </define>
+  <define name="seriespartnumber">
+    <element name="partnumber">
+      <text/>
+    </element>
+  </define>
+  <define name="biblionote">
+    <element name="note">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="abstract">
+    <element name="abstract">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="copyright">
+    <element name="copyright">
+      <ref name="from"/>
+      <optional>
+        <ref name="to"/>
+      </optional>
+      <ref name="owner"/>
+    </element>
+  </define>
+  <define name="from">
+    <element name="from">
+      <data type="gYear"/>
+    </element>
+  </define>
+  <define name="to">
+    <element name="to">
+      <data type="gYear"/>
+    </element>
+  </define>
+  <define name="owner">
+    <element name="owner">
+      <ref name="ContributorInfo"/>
+    </element>
+  </define>
+  <define name="docrelation">
+    <element name="relation">
+      <attribute name="type">
+        <choice>
+          <value>obsoletes</value>
+          <value>updates</value>
+          <value>updatedBy</value>
+          <value>complements</value>
+          <value>derivedFrom</value>
+          <value>translatedFrom</value>
+          <value>adoptedFrom</value>
+          <value>equivalent</value>
+          <value>identical</value>
+          <value>nonequivalent</value>
+          <value>includedIn</value>
+          <value>includes</value>
+          <value>instance</value>
+          <value>partOf</value>
+        </choice>
+      </attribute>
+      <element name="bibitem">
+        <ref name="BibliographicItem"/>
+      </element>
+      <zeroOrMore>
+        <ref name="locality"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <!--
+    Anycontents = mixed {
+    https://github.com/relaxng/jing-trang/issues/211
+    https://lists.oasis-open.org/archives/office/200808/msg00024.html
+    https://lists.oasis-open.org/archives/office/200808/msg00099.html
+    For this to work, we will actually strip any attributes in the Anycontents before
+    passing it for validation. Horrible I know, but there are no good alternatives
+    that also allow us to do grammar inheritance
+    (attribute * { text } | Any)*
+           Any*
+    }
+  -->
+  <define name="AnyElement">
+    <element>
+      <anyName/>
+      <choice>
+        <text/>
+        <ref name="AnyElement"/>
+      </choice>
+    </element>
+  </define>
+</grammar>