metanorma-plateau 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f8e1f42a81f5dd4e4bd6d068002e4499e15c467d1961331ff42555588b1c776
+  data.tar.gz: e760543b322da439d2115e7600482c4b942896d428be685cbed845444a7c61c0
+SHA512:
+  metadata.gz: 574d4e9c2e8c9160a7ef8244d04faff7f8c2ea9d6280fc4ca3fdadc326ad859954361c7f21fdaf87e365fef58c4496d089b39650a78c1cb488a4288d672dace7
+  data.tar.gz: b15a8dca0976d5a6360b15da39d33934eeca5dedcba5b36e19c224cd4b885b65eb96358fb346a39c40e46f3d0a0370fe03365da1e629b49675f6c55292312a08

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: 3.4

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
+
+gem "gem-release"
+
+eval_gemfile("Gemfile.devel") rescue nil

data/LICENSE

@@ -0,0 +1,2 @@
+Copyright (c) 2024, Ribose
+All rights reserved.

data/README.adoc

@@ -0,0 +1,82 @@
+= metanorma-plateau: Metanorma processor for Plateau project, Japanese Ministry of Land, Infrastructure, Transport and Tourism
+
+image:https://img.shields.io/gem/v/metanorma-plateau.svg["Gem Version", link="https://rubygems.org/gems/metanorma-plateau"]
+image:https://github.com/metanorma/metanorma-plateau/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-plateau/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/metanorma-plateau/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-plateau"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-plateau.svg["Pull Requests", link="https://github.com/metanorma/metanorma-plateau/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-plateau/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-plateau/releases"]
+
+== Functionality
+
+This gem processes https://www.metanorma.com[Metanorma documents] following
+the Metanorma model for generating MLIT Project PLATEAU documents.
+
+Project PLATEAU documents are found at:
+
+* https://www.mlit.go.jp/plateau/libraries
+
+The gem is built on top of
+https://github.com/metanorma/metanorma-jis[metanorma-jis] with customized
+rendering to meet requirements of MLIT's Project PLATEAU.
+
+It provides the following functions:
+
+. Compiles Metanorma input into the Metanorma-PLATEAU XML format
+. Validates XML output against the Metanorma-Plateau 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.
+. Metanorma-Plateau XML is then converted into desired output formats.
+
+The following outputs are supported:
+
+* Primary: the canonical Metanorma-PLATEAU XML representation (`.xml`).
+* Secondary: the Metanorma-PLATEAU XML representation is processed to generate the following outputs
+as end deliverable PLATEAU documents.
+** HTML (`.html`)
+** PDF (`.pdf`)
+
+== Structure
+
+This gem inherits from the
+https://github.com/metanorma/metanorma-jis[metanorma-jis] gem, and aligns
+closely to it.
+
+
+=== Quickstart
+
+Please see https://www.metanorma.org for instructions to get started.
+
+You will need to setup your Git credentials for bundler or for HTTPS in order
+to fetch the software. Please refer to the following articles for details:
+
+* https://depfu.com/blog/2017/08/02/bundler-and-private-dependencies[Setting up bundler for private dependencies]
+* https://bundler.io/v1.16/bundle_config.html#CREDENTIALS-FOR-GEM-SOURCES[Bundler credentials for gem sources]
+* https://help.github.com/articles/caching-your-github-password-in-git[GitHub - Caching your GitHub credentials in Git]
+
+
+== Usage
+
+Using the `metanorma` CLI:
+
+[source,console]
+----
+$ metanorma --type plateau a.adoc                   # output HTML
+$ metanorma --type plateau --extensions html a.adoc # output just HTML
+$ metanorma --type plateau --extensions xml a.adoc  # output Metanorma XML
+----
+
+
+== Authoring
+
+Please refer to Metanorma for ISO documentation for general information.
+
+== Documentation
+
+See https://www.metanorma.com/author/iso/[Write ISO documents with Metanorma]
+
+== Examples
+
+* Example documents: https://github.com/metanorma/mn-samples-plateau[mn-samples-plateau].
+* Document templates: https://github.com/metanorma/mn-templates-plateau[mn-templates-plateau].
+

data/lib/isodoc/plateau/base_convert.rb

@@ -0,0 +1,23 @@
+require "isodoc"
+require "metanorma-jis"
+require_relative "init"
+
+module IsoDoc
+  module Plateau
+    module BaseConvert
+
+      def para_parse(node, out)
+        out.p **attr_code(para_attrs(node)) do |p|
+          unless @termdomain.empty?
+            p << "&lt;#{@termdomain}&gt; "
+            @termdomain = ""
+          end
+          @lang == "ja" and p << "&#x3000;"
+          node.children.each { |n| parse(n, p) }
+        end
+      end
+
+      include Init
+    end
+  end
+end

data/lib/isodoc/plateau/html_convert.rb

@@ -0,0 +1,15 @@
+require_relative "base_convert"
+
+module IsoDoc
+  module Plateau
+    class HtmlConvert < IsoDoc::JIS::HtmlConvert
+      def initialize(options)
+        super
+        @libdir = File.dirname(__FILE__)
+      end
+
+      include BaseConvert
+      include Init
+    end
+  end
+end

data/lib/isodoc/plateau/i18n-en.yaml

@@ -0,0 +1,4 @@
+doctype_dict:
+  guide: Guide
+  annex: Annex
+  technical-report: Technical Report

data/lib/isodoc/plateau/i18n-ja.yaml

@@ -0,0 +1,4 @@
+doctype_dict:
+  handbook: ガイドブック
+  annex: 別冊
+  technical-report: 技術資料

data/lib/isodoc/plateau/i18n.rb

@@ -0,0 +1,19 @@
+require "japanese_calendar"
+require "twitter_cldr"
+
+module IsoDoc
+  module Plateau
+    class I18n < IsoDoc::JIS::I18n
+      def load_file(fname)
+        f = File.join(File.dirname(__FILE__), fname)
+        File.exist?(f) ? YAML.load_file(f) : {}
+      end
+
+      def load_yaml1(lang, script)
+        y = load_file("i18n-#{yaml_lang(lang, script)}.yaml")
+        y.empty? ? load_file("i18n-en.yaml").merge(super) : super.deep_merge(y)
+      end
+    end
+  end
+end
+

data/lib/isodoc/plateau/init.rb

@@ -0,0 +1,25 @@
+require "isodoc"
+require_relative "metadata"
+require_relative "i18n"
+require_relative "xref"
+
+module IsoDoc
+  module Plateau
+    module Init
+      def metadata_init(lang, script, locale, labels)
+        @meta = Metadata.new(lang, script, locale, labels)
+      end
+
+      def xref_init(lang, script, _klass, labels, options)
+        @xrefs = Xref.new(lang, script,
+                          HtmlConvert.new(language: lang, script: script),
+                          labels, options)
+      end
+
+      def i18n_init(lang, script, locale, i18nyaml = nil)
+        @i18n = I18n.new(lang, script, locale: locale,
+                                       i18nyaml: i18nyaml || @i18nyaml)
+      end
+    end
+  end
+end

data/lib/isodoc/plateau/metadata.rb

@@ -0,0 +1,12 @@
+module IsoDoc
+  module Plateau
+    class Metadata < IsoDoc::JIS::Metadata
+      def docid(xml, _out)
+        id = xml.at(ns("//bibdata/docidentifier[@type = 'PLATEAU']"))&.text or
+          return
+        set(:docnumber, id)
+        set(:docnumber_undated, id.sub(/:\d{4}$/, ""))
+      end
+    end
+  end
+end

data/lib/isodoc/plateau/pdf_convert.rb

@@ -0,0 +1,17 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Plateau
+    class PdfConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def pdf_stylesheet(_docxml)
+        "plateau.international-standard.xsl"
+      end
+    end
+  end
+end