Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure English Appendix 1 to utilize cgpm-resolutions #17

Open
ronaldtse opened this issue Sep 16, 2020 · 5 comments
Open

Restructure English Appendix 1 to utilize cgpm-resolutions #17

ronaldtse opened this issue Sep 16, 2020 · 5 comments

Comments

@ronaldtse
Copy link
Contributor

No description provided.

@manuelfuenmayor
Copy link
Contributor

manuelfuenmayor commented Sep 23, 2020

@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.)

@ronaldtse
Copy link
Contributor Author

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.

@anermina
Copy link
Contributor

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?

@ronaldtse
Copy link
Contributor Author

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}"?

@anermina
Copy link
Contributor

anermina commented Oct 7, 2020

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants