Git Product home page Git Product logo

Comments (5)

manuelfuenmayor avatar manuelfuenmayor commented on July 26, 2024

@ronaldtse, question please:

Is it necessary that the format of the restructured appendix match exactly with the original one?

For example, by comparing the first resolution (and obviating the rendering errors, metanorma/metanorma-standoc#346),

Original:

res1-original

Restructured (using a yaml2text block):

res1-yaml

There are some differences in the layout. Do they matter? Is it necessary to include the missing note? What happens with the resolutions that are in the yaml files but not in the original?
(In the case above, I could remove the first "considering " word from the paragraphs if you prefer.)

from bipm-si-brochure.

ronaldtse avatar ronaldtse commented on July 26, 2024

There are some differences in the layout. Do they matter?

Yes.

Is it necessary to include the missing note?

Yes.

What happens with the resolutions that are in the yaml files but not in the original?

Ignore them.

from bipm-si-brochure.

anermina avatar anermina commented on July 26, 2024

Besides from the fact that there are some additional resolutions in YAML (which are not included in Word), some of them are also missing. For example, there is no YAML file for CIPM 2001. YAML file for CIPM 2002 doesn't contain the content of Recommendation 1.

I recall some of the resolutions were missing in HTML (broken URLs). Probably this is the reason why they are also missing in YAML files.

Should we add the missing content based on what we have in Word and PDF versions of BIPM brochure?

from bipm-si-brochure.

ronaldtse avatar ronaldtse commented on July 26, 2024

Should we add the missing content based on what we have in Word and PDF versions of BIPM brochure?

@anermina Yes please!

I'm not sure what we should do with the Notes though, because they don't really belong to the resolution... maybe there could be an additional key for "additional notes added at {date}"?

from bipm-si-brochure.

anermina avatar anermina commented on July 26, 2024

@ronaldtse I added missing resolutions and recommendations, or missing parts of them. Notes aren't added yet.

Most of the notes are written in the following format:
image

However, we also have these:
image

For the latter case, we don't have the information about the date. Maybe we could add separate keywords, i.e. one for the note and the other for the year when the change was made?

At first I thought it would be the best to have these non-asterisk notes as footnotes, but it doesn't seem like a good solution in all cases:
image

And another thing... What we currently don't have in YAML files is yellow highlighted in the first image - reference written in small brackets, asterisk and the corresponding note.

That is actually this part of HTML version of the same resolution:
image

...which brings up the question about references.

We included references in the form of corresponding URLs in YAML files. Value of the key reference: cannot be used as such in order to produce (CR, 34 - 38) in this specific case. Do we need to create another keyword for this short name, in order to be able to reproduce the file correctly using yaml2text?

from bipm-si-brochure.

Related Issues (20)

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.