Git Product home page Git Product logo

mn-samples-itu's Introduction

Metanorma-ITU sample documents

Build Status Docker Build Status

Purpose

This repository provides Metanorma-ITU documents in sample form.

Access

Documents in this repository are available through the deployed mini-site:

References for authoring Metanorma ITU documents

This repository also contains references relating to authoring ITU documents, including:

Authoring (references/authoring/)

  • ITU-T: Author’s Guide for drafting ITU-T Recommendations

  • ITU-T: Recommendation skeleton

  • ITU-R: Format of ITU-R Recommendations

ITU-T Recommendation samples (references/itu-t/)

  • One document from every ITU-T "Serie" (e.g. A)

  • Within the collection the various types of recommendations are included, such as:

    • “Recommendation”

    • “Amendment”

    • “Corrigendum”

    • “Errata”

Note
These documents are publicly available on ITU-T

ITU-R Recommendation samples (references/itu-t/)

  • One sample document for BO, BR, RA, and S.

Note
These documents are publicly available on ITU-R

mn-samples-itu's People

Contributors

andrew2net avatar anermina avatar camobap avatar github-actions[bot] avatar manuelfuenmayor avatar opoudjis avatar ronaldtse avatar

Stargazers

 avatar

Watchers

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

mn-samples-itu's Issues

How to cite ITU Recommendation Annexes?

Question for @andrew2net . The mn-samples-itu STL-manual.adoc has these references to Annexes, but they are not auto-fetched. What is the correct notation cite an ITU Recommendation Annex? Thanks.

* [[[G726-LinearIO,20]]], ITU Telecommunication Standardization Sector. Extensions of Recommendation ITU-T G.726 for use with uniform quantized input and output. In _Recommendation G.726_, chapter Annex A. ITU, Geneva, Switzerland, November 1994.
* [[[G727-LinearIO,22]]], ITU Telecommunication Standardization Sector. Annex A to Recommendation ITU-T G.727, _Extensions of Recommendation ITU-T G.727 for use with uniform-quantized input and output._ ITU, Geneva, Switzerland, November 1994.
* [[[G.728G,23]]], ITU Telecommunication Standardization Sector. _Recommendation ITU-T G.728 Annex G - 16 kbit/s fixed point specification._ ITU, Geneva, Switzerland, November 1994.
* [[[G.728I,24]]], ITU Telecommunication Standardization Sector. _Recommendation ITU-T G.728 Annex I - Frame or packet loss concealment for the LD-CELP decoder._ ITU, Geneva, Switzerland, July 1999.
* [[[P.50,(14)ITU-T P.50]]], ITU Telecommunication Standardization Sector. _Recommendation ITU-T P.50 Annex I - Artificial voices._ ITU, Geneva, Switzerland, February 1998.

ITU H.782: Differences between the original and generated DOC

Following differences were noticed:

  • "W3C" is duplicated in generated DOC, although there is no duplication in .adoc:
    * [[[xmlschema, W3C XMLSchema]]] W3C Recommendation (2004), _XML Schema Part 2: Datatypes Second Edition_.
    * [[[csstransforms,(b-W3C CSS Transforms)W3C CSS Transforms]]] W3C, _CSS_ _Transforms Module Level 1_. https://www.w3.org/TR/css-transforms-1/[https://www.w3.org/TR/css-transforms-1/] – [Last accessed 02 Oct. 2018].

Moreover, when auto-fetching isn't possible, document identifier is rendered twice - between the brackets and in the short reference description.

Original:
image
image

Generated DOC:
image
image

  • Some of the b-references and cross-references are rendered differently than in the original document. They include more brackets in generated DOC.

Original:
image

Generated DOC:
image

  • In the original document, reference tag/ID and its corresponding description are written like in two separate columns (similar to definitions in Metanorma). In other words, spacing between the tag/ID and its short description differs.

Original:
image

Generated DOC:
image

Convert ITU provided documents under `reference-docs/`

ITU has given three documents to exercise the compiler, I put them under reference-docs/.

The purposes are:

  • Y.3507: contains figures inside a table
  • G.650.1: contains a number of equations, and
  • Z.100 Annex F1: uses different types of fonts.

@opoudjis could you please help convert them? Thanks!

Investigate compilation warnings for G.650

In response to @anermina: need to investigate warnings about crossreferences:

IDREF "a<em>6_4_1Reference_test_method" without matching ID @ 1844:349
IDREF "a<em>6_3_1_3_3Calculations" without matching ID @ 1454:241
IDREF "a<em>I_1Limited_negative_error_method" without matching ID @ 2366:316
IDREF "a<em>6_3_1_3_2Transmission_through_the_reference_sample" without matching ID @ 1338:95
IDREF "a</em>6_4_2First_alternative_test_method" without matching ID @ 1844:437
IDREF "a</em>I_2Least_squares_method" without matching ID @ 2366:373
IDREF "a</em>6_3_1_2_3Launching_conditions" without matching ID @ 1338:677
IDREF "a</em>6_3_1_3_4Determination_of_cut-off_wavelength" without matching ID @ 1454:319
No label has been processed for ID fig1
No label has been processed for ID [fig1]
No label has been processed for ID fig2
No label has been processed for ID [fig2]
No label has been processed for ID fig2

These may or may not be mark up issues. It may be that anchors must not contain underscores (which is a problem, given that reverse_adoc is generating these.)

There is also a profusion of bibitem/relation and other errors in the grammar parse, which need to be looked at.

ITU Y.3507: Differences between the original and generated DOC

  • Figures are numbered differently (they have chapter/section indication in the original document). Since this wasn't noticed in other ITU recommendations, this issue is opened just to double-check whether this is an inconsistency in the original ITU recommendations, which we can ignore (?). For example, original ITU P.1203 uses the same numbering style as generated DOC.

Generated:
image

Original:
image

ITU Z.100: (Un-)numbering pseudocode blocks

In ITU Z.100, pseudocode is written between ==== delimiters marked with [%unnumbered] attribute, but it is still numbered as figure. Is there an option to avoid having a title? Delimiter ---- wouldn't be good in this case because of the text formatting.

Original:
image

Generated:
image

Capital letters in table headings

All words in table headings are automatically written with capital letter, which isn't correct in some cases. Following example with metric units illustrates the issue.

image

Re-enable T-TUT-CCIT-* documents

Both T-TUT-CCIT-* documents have been commented out in metanorma.yml because compilation fails with this message:

Bibliography: (XML Line 000001): Numeric reference in normative references
Bibliography: (XML Line 000001): Numeric reference in normative references
Bibliography: (XML Line 000001): Numeric reference in normative references
Bibliography: (XML Line 000001): Numeric reference in normative references
Bibliography: (XML Line 000001): Numeric reference in normative references
Numeric reference in normative references

Then metanorma crashes at this point with a non-zero return code.

List titles get divided in lines (DOC output)

If a list title is composed by two or more words, it gets divided in lines (one per word). Please, look at the sample below for clarification purposes.

issue-sample.zip

Sample List:

*Word1*:: Duis accumsan convallis lacus vehicula tristique. Integer maximus magna lorem, at 
ullamcorper ligula vestibulum id. Fusce fringilla velit libero, ut consequat ex pretium eget. Quisque
 vehicula convallis nulla, varius ullamcorper libero euismod eget. Donec consectetur id leo in 
tristique. Curabitur efficitur accumsan est, at volutpat risus elementum nec.

*Word1 Word2*:: Integer vitae mi mauris. Mauris dignissim venenatis lorem. Aliquam at arcu in felis 
mattis volutpat non nec felis. Vivamus placerat neque neque, ut tempus magna tristique eget. 
Suspendisse potenti. Curabitur id mollis mauris, ac pellentesque nunc.

*Word1 Word2 Word3*:: Suspendisse mattis mauris vel luctus suscipit. Nam porttitor ornare 
imperdiet. Pellentesque in nunc a sem porttitor tincidunt vitae vitae arcu. Maecenas sit amet ornare
 ligula. Quisque eu leo urna. Etiam pretium enim ullamcorper, consequat diam a, ornare libero. 
Vivamus neque metus, sagittis ac metus in, tincidunt ultricies dui. Ut ullamcorper sit amet libero et 
blandit.

capture1

capture2

Strange math rendering

This is a strange case.

I need to typeset this piece of text:

capture1

For which I use the following markup:

Consider a given vocabulary _V_ containing [smallcap]#_Real_# (but not _currentTime_) and let 
stem:[V^+] be the extension of _V_ with the function symbol _currentTime_. Restrict attention to
stem:[V^+] -states where _currentTime_ evaluates to a real number."

And I get this:

capture2

The problem seems to be exclusive for stem:[V^+]. If I remove one of the two "stem:[V^+]" the problem gets solved. If I change the plus sign for a number, it gets solved as well.

se-issue-sample.zip

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.