Git Product home page Git Product logo

mn-samples-un's Introduction

UN document samples in Metanorma (Metanorma-UN)

Build Status Docker Build Status

This document is available in its rendered forms here:

Introduction

This repository provides examples of UN documents encoded in the Metanorma-UN format.

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

Specific syntax document for Metanorma-UN can be found at: Syntax for writing UN documents using Metanorma.

Fetching the document

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

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

Example documents provided in this repo

UNECE Plenary document

  • ECE_TRADE_C_CEFACT_2018_6E.adoc: Metanorma-UN markup source for a UNECE Plenary document.

UNECE Recommendation

  • ECE_TRADE_437E_Rec42.adoc: Metanorma-UN markup source for UNECE Recommendation No. 42.

Description of generated artifacts

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

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

mn-samples-un's People

Contributors

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

Stargazers

 avatar

Watchers

 avatar Sebastian Skałacki avatar Ildar Manzhikov avatar James Cloos avatar Mikhail T avatar  avatar Maxim Samsonov avatar  avatar  avatar Frank Hofmann avatar Mehmet Sabırlı avatar Vasil Buraliev avatar webdev778 avatar KW Kwan avatar  avatar

mn-samples-un's Issues

Deal with issues in ECE_TRADE_C_CEFACT_2018_1E (provisional agenda)

This is from #10 "ECE_TRADE_C_CEFACT_2018_1E.docx".

This is a special kind of document because the numbering of it is from the Agenda, but the structure is a Plenary Document. It's kind of an embedding of a different data structure to the Plenary Document.

From @manuel489 :

  1. The source document does not contain numbered paragraphs, nonetheless, the paragraphs in the output are numbered.
  2. There are cases where the sections get numbered as if they were paragraphs. This happens when there is no paragraph or subsection at the beginning of the section. I have openned a ticket about it here: #8
  3. This document in particular, contains two footnotes directly referenced in the main title. But these don't show up in the output. I have openned a ticket about it here: #9

UN document conversion batch 2

Here is a new batch of documents provided by @TomasUN (Thank you!!)

  • 11 ECE_TRACE_C_CEFACT_2019_27 Brief Semantics+TF.docx (Briefing Note)
  • 11 ECE_TRADE_C_CEFACT_2020_18E AGAT PoW.docx (Program of Work)
  • 11 ECE_TRADE_C_CEFACT_2020_19E AGAT 1st meeting Report.docx (Meeting report)
  • 11E ECE_TRADE_C_CEFACT_2019_22 ToR AG Technologies_Rev1.doc.docx (Terms of Reference)
  • FINAL Provisional agenda - ECE_AGAT_2020_INF1.docx (Annotated provisional agenda)

The PDF files are all in reference-docs, Word files in https://github.com/metanorma/mn-samples-un-private .

There are few types of documents:

  • Briefing Note
  • Agenda
  • Vision and Mission
  • Term of Reference
  • Program of Work
  • Meeting Report

As described by @TomasUN ,

Vision and Mission statement is exactly same as PoW just different name, so sometime it’s incorporated into one, as I understand its just shorter “Elevator pitch” of PoW

@metanorma/editors can you help assign yourselves to documents and convert them? Thanks!

Remaining issue on AGAT 1st meeting Report

From @manuel489

Comments on AGAT 1st meeting Report:

  • I set meeting-report as doctype.
  • This doc doesn't have a summary, yet the title "Summary" is still shown in the front page of the generated file.

Screenshot (generated front page):
generated-title

Originally posted #31

Numbered introduction in ECE_TRACE_C_CEFACT_2019_26

Originally from #11 @manuel489 :

ECE_TRACE_C_CEFACT_2019_26 has an "Introduction" section that is numbered (along with its paragraphs). However, in the output doc, the numbering is disabled for this particular section. For example:

Capture1

I think this means that the "Introduction" here is not considered a preliminary element. Maybe all preliminary elements should be declared instead of detected?

Issues with ECE_TRADE_C_CEFACT_2019_09

Originally from #12 @anermina :

  1. Front pages have some differences and the position of the text in header/footer should be adjusted. Currently, docnumber is written in the header of the generated doc, while agenda-id is written in the header of the original document.
  2. In one of the other ECE documents converted earlier, I've noticed that paragraphs weren't numbered (although they were in the original document), so I'm not sure if this should also be applied in this document. [class=steps] doesn't produce numbers in ECE flavour, so currently paragraphs are denoted with a), b), c), etc.
  3. Is there a way to restart numbering for the subsections ([start=1] doesn't make any difference)? In the "Blockchain: how it works" section, subsection numbering starts from 4 instead of 1, because the previous section has subsections numbered with 1-3.
  4. I'm not sure if it is possible to add line breaks in the items list included in tables. Currently, they are missing in the table in Annex. The word "Annex" is missing before the table, as well.
  5. Strikethrough with notation [del]# # is not working in ECE.
  6. Numbering of sections on the 3rd level changes from 1., 2., etc. to A., B., etc.
  7. There is an extra word "Key" before the footnote text below the image (and it is positioned right after the image, not at the bottom of the page.)

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.