Giter Club home page Giter Club logo

mn-samples-gb's Introduction

GB standards in Metanorma (Metanorma-GB)

Ubuntu Build Status Docker Build Status

This document is available in its rendered forms here:

Introduction

This repository provides a readily usable Metanorma-GB 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-GB documents.

Fetching the document

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

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 . -o published -c metanorma.yml

Building The Document

metanorma site generate . -o published -c metanorma.yml

Description of source and generated artifacts

The Rice document is given here as a single source document to illustrate management of Metanorma content.

For each language:

  • rice.gb.{type}.{lang}.adoc provides the document header

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

Generated artifacts:

  • rice.gb.{type}.{lang}.xml: Metanorma-GB XML output corresponding to the rice.gb.{type}.{lang}.adoc source

  • rice.gb.{type}.{lang}.html: Metanorma-GB HTML output corresponding to the rice.gb.{type}.{lang}.adoc source

Source files provided in this repo

There are 6 major types of standards in China, namely:

  • National standards

  • Local standards

  • Sector standards

  • Social standards

  • Enterprise standards

  • Professional standards

National standards

National standards are standards authorized and published by SAC (Standards Administration of China).

These are standards with the document identifier prefix of “GB” standing for “guobiao”, the abbreviation of “guoji biaozhun” (“national standard” in Mandarin).

See the GB National Standard Prefixes list for all prefixes.

  • rice.gb.en.adoc markup source document for the Rice document as a China national standard, in English

  • rice.gb.zh.adoc markup source document for the Rice document as a China national standard, in Simplified Chinese

Local standards

Regional standards are standards developed by the regional standardization body, at the provincial or city level.

These are standards with the document identifier prefix of “DBnn” standing for “dibiao”, the abbreviation of “difang biaozhun” (“regional standard” in Mandarin).

The “nn” prefix is the location code of the region, these codes are defined in ISO 3166-2 as subdivision codes of China.

See the GB Local Standard Prefixes list for all prefixes.

  • rice.gb.local.en.adoc markup source document for the Rice document as a China regional standard, in English

  • rice.gb.local.zh.adoc markup source document for the Rice document as a China regional standard, in Simplified Chinese

Sector standards

Sector standards are standards developed by the sector standardization body as authorized by SAC.

These are standards with a two-character document identifier prefix of various sorts. Each of these prefixes, clearly, stand for some abbreviation.

For example, cryptographic standards are prefixed as “GM” for “guo’mi”, the abbreviation of “guojia mima” (“national cryptography” in Mandarin). Agricultural standards are prefixed as “NY” for “nong’ye” (“agricultural sector” in Mandarin).

Consult Metanorma-GB types for the full list.

See the GB Sector Standard Prefixes list for all prefixes.

  • rice.gb.sector.en.adoc markup source document for the Rice document as a China sector standard, in English

  • rice.gb.sector.zh.adoc markup source document for the Rice document as a China sector standard, in Simplified Chinese

Societal standards

Societal standards are standards developed by societal organizations. These organizations are government-affiliated organizations carrying a specific designation.

These are standards with a 4-character document identifier prefix. The prefix starts with “T”, with a 3-character “group code” identifying the societal organization. “T” is an abbreviation of “tuanbiao”, itself an abbreviation of “tuanti biaozhun” (“group standard” in Mandarin).

See the GB Social and Enterprise Standard Prefixes for more information.

  • rice.gb.social.en.adoc markup source document for the Rice document as a China societal standard, in English

  • rice.gb.social.zh.adoc markup source document for the Rice document as a China societal standard, in Simplified Chinese

Enterprise standards

Enterprise standards are standards developed by enterprises. There is no restriction on publication of enterprise standards, but the SAC offers a voluntary website for the registration of them.

These are standards with a document identifier prefix that starts with “Q”, followed by an enterprise identification code. There is no specific scheme for the enterprise identification code, there are digits, letters and even a mix of them. (Technically there is a requirement, but perhaps not enforced).

The prefix “Q” is an abbreviation of “qibiao”, itself an abbreviation of “qiye biaozhun” (“enterprise standard” in Mandarin).

See the GB Social and Enterprise Standard Prefixes for more information.

  • rice.gb.enterprise.en.adoc markup source document for the Rice document as a China enterprise standard, in English

  • rice.gb.enterprise.zh.adoc markup source document for the Rice document as a China enterprise standard, in Simplified Chinese

Professional standards

Professional standards are standards developed by professional organizations. There is no restriction on publication of professional standards.

These standards have a document identifier prefix that starts with “ZB”, followed by a professional sector categorization code.

The prefix “ZB” is an abbreviation of “zhuanbiao”, itself an abbreviation of “zhuanye biaozhun” (“professional standard” in Mandarin).

Examples are not provided in this repository.

mn-samples-gb's People

Contributors

camobap avatar opoudjis avatar ronaldtse avatar metanorma-ci avatar

Watchers

 avatar Ildar Manzhikov avatar James Cloos avatar  avatar Maxim Samsonov avatar  avatar Alexander Dyuzhev avatar Frank Hofmann avatar Mehmet Sabırlı avatar Vasil Buraliev avatar  avatar webdev778 avatar KW Kwan avatar  avatar

mn-samples-gb's Issues

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.