Git Product home page Git Product logo

mn-samples-iso's Introduction

ISO Rice document in Metanorma (Metanorma-ISO)

Build Status Docker Build Status

This document is available in its rendered forms here:

Introduction

This repository provides a readily usable Metanorma-ISO source document based on the “Rice document”, the ISO’s model document of an international standard.

Refer to the Metanorma quickstart for a primer on creating Metanorma-ISO documents.

Fetching the document

git clone https://github.com/metanorma/mn-samples-iso/

Running via Docker or locally

If you have installed the build tools locally, and wish to run the locally-installed compilation tools, there is nothing further to set.

If you don’t want to deal with local dependencies, use the docker:

docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate

Building The Document

metanorma site generate

Source files provided in this repo

  • iso-rice-en.adoc: Metanorma-ISO markup source document for the Rice document, in English

  • sections/*: The Metanorma-ISO markup source document for the Rice document, broken up into separate files for each section

  • iso-rice-en-sections.adoc: Metanorma-ISO markup source document for the Rice document, referencing the individual files in sections/*

  • iso-rice-zh.adoc: Metanorma-ISO markup source document for the Rice document, in Chinese

Description of generated artifacts

  • {filename}-{lang}.xml: Metanorma-ISO XML output corresponding to the {filename}-{lang}.adoc source

  • {filename}-{lang}.html: Metanorma-ISO HTML output corresponding to the {filename}-{lang}.adoc source

  • {filename}-{lang}-alt.html: Metanorma-ISO “readability-optimized” HTML output corresponding to the {filename}-{lang}.adoc source

Managing an IsoDoc

General

The Rice document is given here both as a single source document and broken up into separate files, to illustrate both ways of managing Metanorma content.

Single file

There are two document examples provided here:

  • iso-rice-en.adoc: the Rice document in English

  • iso-rice-zh.adoc: the Rice document as translated to Chinese

For each language:

  • the file iso-rice-{lang}.adoc provides the document header

  • the file body/body-{lang}.adoc provides the content body.

Multiple files

The document iso-rice-en-sections.adoc includes the document header and the following files.

The section files are listed in order of appearance in the document, and each corresponds to a first-level clause of the Rice document:

  • 00-foreword.adoc: Foreword

  • 00-introduction.adoc: Introduction

  • 01-scope.adoc: Scope

  • 02-normref.adoc: Normative references

  • 03-termdef.adoc: Terms and definitions

  • 04-specifications.adoc: Clause 4: Specifications

  • 05-sampling.adoc: Clause 5: Sampling

  • 06-testmethods.adoc: Clause 6: Test Methods

  • 07-testreport.adoc: Clause 7: Test Report

  • 08-packaging.adoc: Clause 8: Packaging

  • 09-marking.adoc: Clause 9: Marking

  • aa-annex-a.adoc: Annex A

  • ab-annex-b.adoc: Annex B

  • ac-annex-c.adoc: Annex C

  • ad-annex-d.adoc: Annex D

  • ae-annex-e.adoc: Annex E (not in original Rice document, included to illustrate further formatting options)

  • b0-bibliography.adoc: Bibliography

mn-samples-iso's People

Contributors

anermina avatar camobap avatar github-actions[bot] avatar intelligent2013 avatar manuelfuenmayor avatar metanorma-ci avatar opoudjis avatar ronaldtse avatar strogonoff avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

alexeymorozov

mn-samples-iso's Issues

Metanorma validation failure on Windows

https://github.com/metanorma/mn-samples-iso/pull/66/checks?check_run_id=2378612873

2021-04-19T07:46:56.0744104Z Document Attributes:  is not a recognised iteration
2021-04-19T07:46:56.5965012Z C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/ruby-jing-0.0.1/lib/jing.rb:127:in `split': invalid byte sequence in UTF-8 (ArgumentError)
2021-04-19T07:46:56.5966813Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/ruby-jing-0.0.1/lib/jing.rb:127:in `parse_output'
2021-04-19T07:46:56.5967964Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/ruby-jing-0.0.1/lib/jing.rb:88:in `validate'
2021-04-19T07:46:56.5969296Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-standoc-1.9.0/lib/asciidoctor/standoc/validate.rb:85:in `block in schema_validate'
2021-04-19T07:46:56.5970546Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/2.4.0/tempfile.rb:295:in `open'
2021-04-19T07:46:56.5971769Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-standoc-1.9.0/lib/asciidoctor/standoc/validate.rb:81:in `schema_validate'
2021-04-19T07:46:56.5973214Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-iso-1.8.0/lib/asciidoctor/iso/validate.rb:268:in `validate'
2021-04-19T07:46:56.5974591Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-standoc-1.9.0/lib/asciidoctor/standoc/base.rb:182:in `makexml'
2021-04-19T07:46:56.5976041Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-standoc-1.9.0/lib/asciidoctor/standoc/base.rb:154:in `document'
2021-04-19T07:46:56.5977454Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-standoc-1.9.0/lib/asciidoctor/standoc/utils.rb:14:in `convert'
2021-04-19T07:46:56.5978914Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/asciidoctor-2.0.13/lib/asciidoctor/document.rb:938:in `convert'
2021-04-19T07:46:56.5980205Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/asciidoctor-2.0.13/lib/asciidoctor/convert.rb:119:in `convert'
2021-04-19T07:46:56.5981480Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-1.3.0/lib/metanorma/input/asciidoc.rb:24:in `process'
2021-04-19T07:46:56.5982741Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-1.3.0/lib/metanorma/processor.rb:24:in `input_to_isodoc'
2021-04-19T07:46:56.5984008Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-1.3.0/lib/metanorma/compile.rb:93:in `process_input'
2021-04-19T07:46:56.5985252Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-1.3.0/lib/metanorma/compile.rb:26:in `compile'
2021-04-19T07:46:56.5986583Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/compiler.rb:45:in `compile_file'
2021-04-19T07:46:56.5987926Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/compiler.rb:30:in `compile'
2021-04-19T07:46:56.5989262Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/compiler.rb:35:in `compile'
2021-04-19T07:46:56.5990622Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/site_generator.rb:81:in `compile'
2021-04-19T07:46:56.5992032Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/site_generator.rb:28:in `block in generate'
2021-04-19T07:46:56.5993435Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/site_generator.rb:28:in `each'
2021-04-19T07:46:56.5994791Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/site_generator.rb:28:in `generate'
2021-04-19T07:46:56.5996197Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/site_generator.rb:23:in `generate'
2021-04-19T07:46:56.5997566Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli/commands/site.rb:25:in `generate'
2021-04-19T07:46:56.5998845Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor/command.rb:27:in `run'
2021-04-19T07:46:56.5999963Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-hollaback-0.2.0/lib/thor/hollaback.rb:62:in `run'
2021-04-19T07:46:56.6001164Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor/invocation.rb:127:in `invoke_command'
2021-04-19T07:46:56.6002252Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor.rb:392:in `dispatch'
2021-04-19T07:46:56.6003461Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor/invocation.rb:116:in `invoke'
2021-04-19T07:46:56.6004549Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor.rb:243:in `block in subcommand'
2021-04-19T07:46:56.6005709Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor/command.rb:27:in `run'
2021-04-19T07:46:56.6006848Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-hollaback-0.2.0/lib/thor/hollaback.rb:62:in `run'
2021-04-19T07:46:56.6008131Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor/invocation.rb:127:in `invoke_command'
2021-04-19T07:46:56.6009212Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor.rb:392:in `dispatch'
2021-04-19T07:46:56.6010238Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/thor-1.0.1/lib/thor/base.rb:485:in `start'
2021-04-19T07:46:56.6011346Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/lib/ruby/gems/2.4.0/gems/metanorma-cli-1.4.7.1/lib/metanorma/cli.rb:67:in `start'
2021-04-19T07:46:56.6012375Z 	from C:/Users/RUNNER~1/AppData/Local/Temp/ocr22CD.tmp/src/metanorma:198:in `<main>'
2021-04-19T07:46:59.7992544Z ##[error]Process completed with exit code 1.

Three Column ISO Document

I am the covenor related to updating ISO 5598 which is a three column document. Do you know if Metanorma can support such a document? How would you recommend managinga three language document with Metanorma?

ISO 5598 on the Online Browsing Platform
image

The working group likes seeing the definitions side by side:
image

gh-pages branch have generated documents

During troubleshooting release issues on mnconvert-ruby https://github.com/metanorma/mnconvert-ruby/actions/runs/3550365759/jobs/5963710053

I have found that gh-pages branch have no documents

Originally docker workflow was responsible for GHPages publishing but now in this repo we have also https://github.com/metanorma/mn-samples-iso/actions/workflows/pages/pages-build-deployment which is missing in https://github.com/metanorma/mn-samples-iso/tree/main/.github/workflows I suppose it comes somewhere from configuration or some third-party service

@ronaldtse maybe you can share some context why was added ?

P.S. I have restarted docker manually to see if it will work

Create ISO Amendment samples

reference-docs/model_amendment-rice_model.pdf has been uploaded, @metanorma/editors can someone help create the sample for amendments?

I believe the template for authoring an amendment and a corrigenda is identical.

Reproduce ISO Directives Part 1, Part 2 and "Consolidated ISO Directives" in Metanorma

Let's consider the value of reproducing ISO Directives Part 1 in IsoDoc.

Here's the value that I can see:

  • Its "Annex SL" is a template document within the document, so basically a document-in-document. This will push IsoDoc's boundaries in terms of the model and .

  • It contains many variants of syntax that fulfills the rules stated in Directives Part 2, so this will make sure our output works.

  • Directives Part 1 is a normative reference for ISO so it would have at least some symbolic meaning.

Thoughts? @opoudjis

Nested assets error

With this set of issues, if you cannot remove the embedded assets, don't, but we will not accept crossreferences to nested assets.

You are looking for errors in the error logs that look like:

Compiling /metanorma/sources/directives/part2/document.adoc

Syntax: (XML Line 000870): There is an instance of example nested within table
Syntax: (XML Line 000876): There is an instance of example nested within table
Syntax: (XML Line 000879): There is an instance of example nested within table
Syntax: (XML Line 000903): There is an instance of example nested within table
Syntax: (XML Line 000929): There is an instance of example nested within table
Syntax: (XML Line 000932): There is an instance of example nested within table
Syntax: (XML Line 000963): There is an instance of example nested within table
Syntax: (XML Line 000966): There is an instance of example nested within table
Syntax: (XML Line 000969): There is an instance of example nested within table
Syntax: (XML Line 000972): There is an instance of example nested within table
Syntax: (XML Line 000996): There is an instance of example nested within table
Syntax: (XML Line 001002): There is an instance of example nested within table
Syntax: (XML Line 001240): There is an instance of figure nested within example
Syntax: (XML Line 001347): There is an instance of table nested within example
Syntax: (XML Line 001386): There is an instance of table nested within example
Syntax: (XML Line 001400): There is an instance of table nested within example
Syntax: (XML Line 001417): There is an instance of table nested within example
Syntax: (XML Line 001993): There is an instance of table nested within example
Syntax: (XML Line 002008): There is an instance of table nested within example
Syntax: (XML Line 002018): There is an instance of table nested within example
Syntax: (XML Line 002029): There is an instance of table nested within example
Syntax: (XML Line 002479): There is an instance of table nested within example
Syntax: (XML Line 002819): There is an instance of table nested within example
Syntax: (XML Line 003008): There is an instance of formula nested within example
Syntax: (XML Line 003028): There is an instance of formula nested within example
Syntax: (XML Line 003046): There is an instance of table nested within example
Syntax: (XML Line 003048): There is an instance of formula nested within example
Syntax: (XML Line 003065): There is an instance of formula nested within example
Syntax: (XML Line 003048): There is an instance of formula nested within table
Syntax: (XML Line 003065): There is an instance of formula nested within table
Syntax: (XML Line 003084): There is an instance of table nested within example
Syntax: (XML Line 003092): There is an instance of table nested within example
Syntax: (XML Line 003094): There is an instance of formula nested within example
Syntax: (XML Line 003111): There is an instance of formula nested within example
Syntax: (XML Line 003115): There is an instance of formula nested within example
Syntax: (XML Line 003094): There is an instance of formula nested within table
Syntax: (XML Line 003111): There is an instance of formula nested within table
Syntax: (XML Line 003115): There is an instance of formula nested within table
Syntax: (XML Line 003167): There is an instance of figure nested within example
Syntax: (XML Line 003284): There is an instance of figure nested within example
Syntax: (XML Line 003314): There is an instance of figure nested within example
Syntax: (XML Line 003444): There is an instance of figure nested within example
Syntax: (XML Line 003448): There is an instance of table nested within example
Syntax: (XML Line 003630): There is an instance of table nested within example
Syntax: (XML Line 003656): There is an instance of table nested within example
Syntax: (XML Line 003671): There is an instance of table nested within example
Syntax: (XML Line 003682): There is an instance of figure nested within example
Syntax: (XML Line 003921): There is an instance of example nested within table
Syntax: (XML Line 003921): There is an instance of table nested within table
Syntax: (XML Line 003930): There is an instance of example nested within table
Syntax: (XML Line 003930): There is an instance of table nested within table
Syntax: (XML Line 003939): There is an instance of example nested within table
Syntax: (XML Line 003939): There is an instance of table nested within table
Syntax: (XML Line 003953): There is an instance of example nested within table
Syntax: (XML Line 003960): There is an instance of example nested within table
Syntax: (XML Line 003960): There is an instance of table nested within table
Syntax: (XML Line 003971): There is an instance of example nested within table
Syntax: (XML Line 003971): There is an instance of table nested within table
Syntax: (XML Line 003992): There is an instance of example nested within table
Syntax: (XML Line 003992): There is an instance of table nested within table
Syntax: (XML Line 004005): There is an instance of example nested within table
Syntax: (XML Line 004005): There is an instance of table nested within table
Syntax: (XML Line 004022): There is an instance of example nested within table
Syntax: (XML Line 004028): There is an instance of example nested within table
Syntax: (XML Line 004033): There is an instance of example nested within table
Syntax: (XML Line 004046): There is an instance of example nested within table
Syntax: (XML Line 004053): There is an instance of example nested within table
Syntax: (XML Line 004053): There is an instance of table nested within table
Syntax: (XML Line 004064): There is an instance of example nested within table
Syntax: (XML Line 004064): There is an instance of table nested within table
Syntax: (XML Line 004083): There is an instance of example nested within table
Syntax: (XML Line 004083): There is an instance of table nested within table
Syntax: (XML Line 004100): There is an instance of example nested within table
Syntax: (XML Line 004100): There is an instance of table nested within table
Syntax: (XML Line 004102): There is an instance of formula nested within table
Syntax: (XML Line 004104): There is an instance of formula nested within table
Syntax: (XML Line 004108): There is an instance of formula nested within table
Syntax: (XML Line 004110): There is an instance of formula nested within table
Syntax: (XML Line 003921): There is an instance of table nested within example
Syntax: (XML Line 003930): There is an instance of table nested within example
Syntax: (XML Line 003939): There is an instance of table nested within example
Syntax: (XML Line 003960): There is an instance of table nested within example
Syntax: (XML Line 003971): There is an instance of table nested within example
Syntax: (XML Line 003992): There is an instance of table nested within example
Syntax: (XML Line 004005): There is an instance of table nested within example
Syntax: (XML Line 004053): There is an instance of table nested within example
Syntax: (XML Line 004064): There is an instance of table nested within example
Syntax: (XML Line 004083): There is an instance of table nested within example
Syntax: (XML Line 004100): There is an instance of table nested within example
Syntax: (XML Line 004102): There is an instance of formula nested within example
Syntax: (XML Line 004104): There is an instance of formula nested within example
Syntax: (XML Line 004108): There is an instance of formula nested within example
Syntax: (XML Line 004110): There is an instance of formula nested within example
Syntax: (XML Line 004102): There is an instance of formula nested within table
Syntax: (XML Line 004104): There is an instance of formula nested within table
Syntax: (XML Line 004108): There is an instance of formula nested within table
Syntax: (XML Line 004110): There is an instance of formula nested within table
Syntax: (XML Line 004274): There is an instance of figure nested within example

Clearly ISO/IEC DIR 2 is impossible to do much with....

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.