Git Product home page Git Product logo

bipm-si-brochure's Introduction

Metanorma: the standard for standards

Gem Version Build Status Code Climate Pull Requests Commits since latest

Metanorma is dedicated to harmonizing standard documents produced by different standard-setting bodies in a manner that maintains correct semantics while allowing each standard publisher to define appropriate semantic extensions.

Simply put, it allows standards bodies or any other organization to create their own standard or specification document in a best practices manner.

Metanorma is composed of a number of specifications and software implementations. The Metanorma document model is based on the SecureDoc document model.

For more on Metanorma and who uses it, refer to https://www.metanorma.org

Installation on supported platforms

Installing individual components

The Metanorma workflow can be utilized via the metanorma-cli Ruby gem.

gem install metanorma-cli

Usage

Threaded execution

Metanorma has threaded execution, to generate output documents from the same Presentation XML input more quickly. Similar to relaton, the METANORMA_PARALLEL environment variable can be used to override the default number of parallel fetches used.

Origin of name

Meta- is a prefix of Greek origin ("μετα") for “with” “after”. In English, it has ended up meaning "about (its own category)"; e.g. meta-discussion (a discussion about discussion). (For the roundabout way it ended up with that meaning, see https://en.wikipedia.org/wiki/Meta#Etymology.)

Norma is Latin for “rule” and “standard”; hence English norm, but also German Norm "standard".

The Metanorma project is for setting a standard for standard documents created by standards-setting organizations (which is a meta thing to do); hence this name.

Metanorma seeks to embrace all standards documents standards, but not possess any: it can give rise to many "standard" standards, but not limit the extension of any of those standards.

The motto of the project is Aequitate verum, "Truth through equity". Dealing with all standards fairly (aequitate), we seek not an abstract virtue (veritas), but a practical reality on the ground (verum), that can be used by stakeholders of multiple standards.

bipm-si-brochure's People

Contributors

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

Stargazers

 avatar  avatar  avatar

Watchers

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

bipm-si-brochure's Issues

French SI Brochure feedback from BIPM (pages 21-40)

page comment
21 first equation: wrong grouping of decimals after the comma: 6,022 140 76.
21 second paragraph after 1. equation: "M" needs always to be initalics
21 2. equation: the 12 in 12C needs to be a superscript, not a subscript; C not in italics
21 below 3. equation: an opening parenthesis is missing in M(12C)
22 definition of candela: 2nd last line it should read m-2,not m2; Negative and positive exponents are not at the same height
22 2. equation: replace decimal point by comma; insert a space between h and Kcd (2 x)
23 3. paragraph: replace "Article 5.4.7" with "section 5.4.7" and analogous at several other places
24 first paragraph of 2.3.4: isolated » on new line
24 Table 4: angle solide: m2 not in italics
24 Table 4: 3re column vertically not well aligned with 1st and 2nd column
24 Table 4, footnote b: pi not in italics
27 Table 6: energie volumique: last column: kg m-1 s-2; there is a misprint in the SI brochure
27 Table 6: increase width of first two columns so that there are less linebreaks
28 4. paragraph: pi not in italics
28 4. paragraph : isolated » on new line
28 5. paragraph : isolated » on new line
30 side note: accents missing on four prefix names: mébi, tébi, zébi,pébi
30 μ not in italics
31 last line : μ not in italics
32 Table 8: pi not in italics
32 Table 8 footnot b: μ not in italics
33 1. paragraph: 3rd line from bottom: m in italics
34 3. paragraph: split in two paragraphs before "Les symboles…"
35 section 5.4.1, 2. paragraph: "livre rouge" not in italics ;  isolated » on new line
36 Figure: insert ticks for the axis labels
36 sectio 5.4.2, last side note: spaces not correct, compare with original
37 2. line: reference to page number 149 wrong, should be 140
37 5.4.4: isolated » on new line
38 5.4.7, 2. paragraph: μ not in italics
38 5.4.7, 3. paragraph: isolate « at end of line
38 last side note,last line: space missing between" confusion" and "supplémentaire"
39 5.4.8: pi not in italics
39 4. paragraph: rayon r, r in italics; omega in italics
40 Full name of CIPM and CGPM instead of acronym
40 1. paragraph: "procès verbaux" in italics

BIPM feedback on MEP Mole

Location Issue
5 first paragraph: replace reference to SI brochure by number, also throught the text
  text of the definition not clearly distinguished from surrounding text: use bold font
  definition: replace comma in numerical value by dot
  definition: group decimals of numerical value by three
  replace "Clause" by "Section", throughout the document
6 Equation 3: 28Si
  2nd line following equation 3: a(28Si)
  2nd paragraph: replace reference to SI brochure by number
  Equation 4: a(28Si)
7 paragraph above equation 5: X not in italics
  paragraph below equation 5: replace decimal comma by dot, group decimals by three
  pargraph below equation 5: numerical value is wrong: 1.660 539 067 (1) x 10-27
  the second term of equation 6 is wrong, the (X) at the right belongs to ma below the horizontal line
11 1st paragraph: M(12C)
  paragraph following equation 11: u not in italics (2 x)
  equation 12: m(12C)
  paragraph following equaiton 13: Ar€, A in italics
  last paragraph: reaplace decimal comma by dot
12 reference 5: space missing in Bartl G and Borys  M
  the numbering of the references should be in the form of [n], in the first column, not at the end

@metanorma/editors if there are non-content issues, please ping @Intelligent2013 or @opoudjis . Thanks!

Original comments file:
Observations mep mole.xlsx

French SI Brochure feedback from BIPM (pages 61-80)

page comment
61 side note: "IAU Trans." in italics
61 last side note: wrong reference, should be Page 61 (the same page)
63 Resolutions 8 and 9: replace "remarque" par "note"
63 Resolutio 10: change "remarque" to a side note
63 Resolution 3: no text in bold
63 Resolution 3: side notes (1)and (2) no line break between value and unit.
67 2nd line: isolated » at beginning of line
70 change "remarque" following table into side note
71 Resolution 12, second bullet point: μ not in italics
72 bullet point (a): l in italics
73 list following "recommade":  μ not in italics
73 1st side note: Metrologia in italics
73 2nd side note: J. Radiol. Prot. In italics
73 last bullet point: isolated » at beginning of line
74 3rd line below equation: "decide" in bold
74 CIPM 2003: Metrologia in italics
74 CIPM 2003: 2nd bullet point from end: μ not in italics
75 CIPM 2005: list needs to be split in two, following "considérand" and "décide"
75 CIPM 2005: group numbes following the decimal separator in groups of three
76 1st bullet point : group numbes following the decimal separator in groups of three
76 REcommandation3: μ not in italics
77 2nd bullet point following "recommande":   change to 5s  2S1/2–  4d 2D5/2
77 3rd bullet point: change to 5d10 6s  2S1/2(F  =  0)  –  5d9 6s2 2D5/2(F  = 2)
77 3rd bullet point: Hg not in italics
77 4th bullet point: change to 6s 2S1/2(F = 0) – 5d 2D3/2(F = 2)
77 4rd bullet point: Yb not in italics
77 5th bullet point: change to 5s2 1S0 –  5s  5p 3P0
77 Recommandation 1: μ not in italics
78 Resolutio 10:group numbes following the decimal separator in groups of three
80 CIPM 2009: isolated » at beginning of line
80 1st bullet point following "recommande": change to 5s2  1S0 –   5s   5p  3P0
80 2nd bullet point: change to 5s2  1S0 –   5s   5p 3P0
80 3rd bullet point: 4s 2S1/2–  3d 2D5/2
80 4th bullet point: 2S1/2 (F = 0)  – 2F7/2(F = 3, mF = 0)
80 5th bullet point: 6s2  1S0 (F  = 1/2) – 6s 6p 3P0 (F = 1/2)

(TBD) Encode BIPM SI brochure in Metanorma format

This is the full PDF version: https://www.bipm.org/utils/common/pdf/si-brochure/SI-Brochure-9.pdf

Confirmed with BIPM we need to convert the whole source:

  • French
  • English
  • Appendix 1-4 (only 1 and 4 are in the PDF, 2 and 3 are on the BIPM site separately, we need to convert all)

(The previously posted one was only English: https://www.bipm.org/utils/common/pdf/si-brochure/SI-Brochure-9-EN.pdf)

Will post the Word version when we get it. Not yet actionable until we have the Word source. Except for French and English portions, the Appendices are actionable.

Content for Appendix 1 and 4 can be found online at their site.

  • Appendix 1: #2
  • Appendix 2: #5
  • Appendix 3: #4
  • Appendix 4: #3

BIPM: Remaining issues

MEP-3 (guide-ccl-GD-MeP-3-en.adoc)

  1. I added nosee% in the meanwhile, but there is no need for adding page number in this cross-reference, since the figure is right below the text, on the same page. The same applies to several other figures in this document and the table below.

image

image

MEP candela rapport (mep-candela-rapport.adoc)

  1. In case section is marked with [heading=terms and definitions] attribute, default intro text is used. However, here we have some non-generic intro in the original document. It can also be seen that the subsections for terms are not generated as usually (they don't differentiate from the rest of the text).
    Should we just remove this attribute?

Original:
image

Generated:
image

  1. Colon and blank space are missing after "Note x to entry".

image

BIPM brochure (FR)

  1. There is an extra page with "Références" title in header. @Intelligent2013 could you please check?

BIPM and Manuel: Odd display of math font in Acrobat Reader

A general comment is that the font chosen for the main text is not pleasant to read on a screen. It appears to be too bold and is not sharp.

The fonts are identical to the fonts in the source PDF.

@opoudjis I partially agree with your statement. But I think I understand the why BIPM made that comment. Maybe the problem comes form the PDF viewer software. I'm using Acrobat Reader and this is how it looks in some parts:

issueFont2
(left: original , right: generated)

In the red square areas, notice how "Kcd" and "540x10^12 Hz" look more bold compared to original version.
Here's another sample:

issueFont3
(left: original , right: generated)

Apparently, this only happens in math expressions. However, if I zoom into the bold text, it looks almost the same:

issuefont4
(left: original , right: generated)

Originally posted by @manuel489 in https://github.com/metanorma/bipm-si-brochure/issue_comments/708076317

French SI Brochure feedback from BIPM (pages 41-60)

page comment
41 Wrong title. Replace "Le Système international d’unités Table des matières" by "Table des matières de l’annexe 1"
41 Entry for CIPM 1969: bad linebreak in second line
41 Entry for 23rd CGPM 2007:bad line break
42 Wrong title, remove
43 Wrong title, remove
43 Entry for CIPM 1946 : bad line break
43 Entry for CIPM 1988 : bad line break
43 9th CGPM 1948: bad line break
44 10th CGPM 1954: bad line break
44 Wrong title, remove
44 13th CGPM "K" not in italics
44 CIPM 1946: bad line break
45 Wrong title, remove
45 CIPM 1984: bad line break
45 Replace title "Unités supplémentaires page" by "Unités supplémentaires"
45 22nd CGPM 2003: bad line break
46 Wrong title, remove
46 12th CGPM 1964: bad line break
48 last side note: isolated « at end of line
49 Would be good if the first line could be on the previous page
50 paragraph below bullet point 3: replace "remarque" by "note"
51 side note:  isolated « at end of line
51 Table: μ not in italics
51 Table: dots before unit names little bit larger
51 Table, remarque 2: isolated « at end of line
54 last line : μ not in italics
54 table at bottom: larger space between first two columns
54 possible to have footnotes (4) nad (5) on page 55 ?
55 entry for volume: "mètre" belongs to the second column, not the first
55 table, last line: "cd/m2" too low
57 Curie (CR 94): the asterisk should be on Curie (CR94) not ont Resolution 7
58 side note of 13th CGPM 1967/68: attach this side note tothe definiton of the second in bullet point 1.
58 last side note: possible to have side note (1) on same page as corresponding text?
59 Resolution 5: isolated » at beginning of line
59 Resolution 5: last paragraph: no line break within numbers (2 x)
60 Resolution 6: μ not in italics
60 CIPM 1969, side note: isolated » at the beginning of line
60 Recommandation 1: replace "remarque" by "note"

BIPM: French text formatting issues

From BIPM on the French text:

  • there should always be an unbreakable space in front of “double” punctation marks, i.e : ; ! and ?
  • there are a few places where there is a space in front of a comma, which should not be there

Review from BIPM to be addressed

BIPM performed a review of the document and indicated the following issues to be fixed:

Page 3 : “SI“ is missing at the end of the title

Page 4: ISBN number is missing

Page 5: wrong title “Résumé” instead of “Le BIPM et la Convention du Mètre »
The list of member states in the margin begins too low and extends over two pages
The dots are missing in the list following the third paragraph
Much too large vertical space before the second list of bullet points
Dots are missing in the second list

Page 6: the numbers are missing in the list of Consultative Committees at the bottom of the page

Page 7: dots are missing in the list of bullet points in the middle of the page

Page 8: blue-red percent symbols between section numbers and titles

Page 9: All decisions of Annex 1 are listed separately
Annex 5 does not exist

Page 12: The four paragraphs on the annexes 1 to 4 should be moved to the left.
In the original, the note has two paragraphs, the space has disappeared

Page 13: The lines of the first paragraph are unequally spaced as a consequence of the superscripts

Page 15: The notes in the margin should be vertically aligned with the top of the corresponding paragraph
In the second note in the margin the subscripts “-1” are too big
In the same note, the minus sign in the parentheses should be a superscript (-)

Page 16: Table 1: the values of the Boltzmann and Avogadro constants are wrong.

Page 17: the note in the margin is at the wrong place. It should be aligned with table 2 on the following page
The second part of this note, starting with “La commission…” is completely out of place. It belongs to page 29 (of the original)
The note following table 2 should not be there, it is a duplication of the note in the margin.

A general comment is that the font chosen for the main text is not pleasant to read on a screen. It appears to be too bold and is not sharp.

CC @metanorma/editors @opoudjis @Intelligent2013

The document under review was this:
20201006-si-brochure.zip


We need to come up with fixes or explanations for those that can't/shouldn't be fixed.

BIPM SI brochure (English): review

  1. Frontpage: Capital letters are used in the original EN document.
    Original French document uses the same format as generated (EN and FR), so this is probably an inconsistency in BIPM, but "Bureau International des Poids et Mesures" seems right to me for both versions. @ronaldtse ?

Original:
image

Generated:
image

  1. Cross-reference to table is written with capital T in the original EN document.
    French uses small letters.

Original:
image

Generated:
image

  1. Decimal dots should be used in EN version instead of decimal commas which are used in FR version.

  2. We need the word "page" at the beginning of each new page for ToC of Appendix 1. (Reported in #47 as well.)

Original:
image

Generated:
image

  1. Both levels of items list are numbered with Greek letters in the generated PDF. (Similar reported in #47.)

Original:
image

Generated:
image

  1. Zeros are truncated when they shouldn't be.

Original:
image

Generated:
image

  1. Second note in 24th CGPM is appearing at the beginning of the text, and it should be lower.

Original:
image

Generated:
image

  1. The same comments regarding ToC as in #47 apply here as well.

Should we have the first line in the generated ToC?
Do we need to show subsections for annexes in ToC? Do we need to add a dot after annex number? -> (Appendices instead of Annexes in this case.)

  1. The same comments regarding cross-referencing sections with/without corresponding page numbers as in #47 apply here as well.

In which cases should the page number be added as a part of the cross-reference?
Should the word see before the cross-reference be added automatically, or via markup?
In case page number is added, we currently have repetition of the word see, as in the following example: see 2.3.6, see p. 30.

BIPM feedback on MEP Kilogram

We need to update the MEP Kilogram to the latest 2020-08-04 version.

From BIPM:

The XML file has been produced from a previous verison of the mise en pratique.
The current version on the web site dates from 4 August 2020.
I will not comment on these changes in the following list.

Location  Issue
Title page replace "9 édition 2020" by "9 édition 2019"
Title page change date from 20 May 2020 to 04 August 2020
3 replace "9th edition 2020" by "9th edition 2019"
3 change date at bottom from 20 May 2020 to 04 August 2020
5 first line:  link to reference should be [1]
5 definition of kilogram: the numerical value is wrong, should be 6.626 070 15 x 10-34
  replace comma in numerical value with dot
  "c" in last line of definition should be invitalics
  paragraph following definition: numerical value is wrong, should be 6.626 070 15 x 10-34
  replace comma in numerical value with dot
  end of second paragraph:replace "Clause 5" by "section 5"
6 Second paragraph is not a part of the title of Figure 1. It should be vertically separated.
  the link to reference should be [1]
7 second paragraph of 3.1: g in italics
  paragraph followin eq. 2: v in italics
  equation 2: v in italics
  equation 3: v in italics
  last paragraph: v in italics
8 equation 4: v in  italics
  first pargraph of 3.2: lattice parameter a in italics
  equation 5:  28Si (superscript)
  line after equation 5: a(28Si)3
  2nd line after equation 5: a(28Si)3
  4th line after equation 5: a(28Si)3
  equation 6: 28Si
  equation 7: m(28Si) / h (compare with original)
  line after equation 8: m(28Si)/h
9 3rd line: ms
  the font different from that used before, but much better to read on my screen Can it be used everywhere
10 first paragraph: replace "clause " by "section", also throughout the document
  first paragraph: linebreak between 1 kg to be avoided.
12 3rd paragraph of 5.1: lines 4 and 6: h in italics
  linebreak between 1 kg to be avoided.
  replace comme in 1.0 with dot
13, 14 wrong title in header
13 reference [1]: replace with original text
  reference [7]: replace h/mu with h/mu
  Why is the number of the reference repeated at the end of each reference?
  The usual way to number references in the bibliography is [n]
14 Referece 24 is wrong, it should be for the 8th (!) edition of the SI brochure of 2006, see original mep
15 Replace "Appendix" with "annex" throughout the document. All of these annexes are part of a document which is in Appendix 2 of hte SI brochure.
  appendix 1: replace references with numbers
  Table 1.1: p and q in title not in italics
  last paragraph: first line: both letters of Cs are subscripts
  last paragraph, second line: k in italics
16 Note at beginning of section on atomic … units is missing. (I am not sure if this note has been added in the latest version of the mep, of 4 August 2020)
  third line of section on atomic units: u not in  italics
  1.st paragraph: the reference to Appendix 1.4.1 is not working because you have removed the numbering of the sections of Annex 1.
  Equations of physics, 3rd line: replace mu with mu
  Equation 1.1: m(12C)
  paragraph after equation 1.1: u not in italics
  Equation 1.2: m(12C)
  line above equation 1.3: replace second M(X) with m(X)
  Equation 1.4: m(12C)
17 paragraph following equation 1.7: replace comma in 4.5 with dot
  second paragraph following equation 1.7: M(12C), M in italics
  Item 3 of the list shall be item 3.a, item 3.b hase become item 1 of the next list
  paragraph following list item 3: replace Mu with Mu
  paragraph following list item 3: replace mol-1 with mol-1
  paragraph following list item 3: replace comma in 4.5 with dot
  list item 1 of second list shall be item 3.b of first list
18 2nd line: replace comma in 0.001 with dot
  Equation 1.8: replace comma in 0.001 with dot
  Equation 1.10: replace comma in number with dot
19 2nd last paragraph: a(Si)
20 3rd paragraph: second line: mi
21 different font than page before, but looks much better.

@metanorma/editors if there are non-content issues, please ping @Intelligent2013 or @opoudjis . Thanks!

Original comment file if the math units are unclear here:
Observations mep kilogram.xlsx

Specializing BIPM copyright statement per-document

4 Instead of "La Brochure sur le SI", the text starts with "Ce document" adoc

From @opoudjis in #40 (comment)_:

That is deliberate by me, and I strongly urge us not to fix this. The boilerplate we are including in our generated documents is not intended just for the single document of the SI Brochure, but for all documents produced by BIPM. We cannot just insert the title of the document, because in French we don't know what the gender of the document title is (La brochure, but le rapport). And frankly, I do not believe that inserting the document title in the boilerplate is worth us adding a document title gender attribute.

This is not the desired behavior for the SI Brochure as requested by the BIPM.

There are potentially 3 solutions:

  • The current version, which uses the generic "the document"
  • Be doc-type specific, i.e. "the brochure"
  • Be document title specific, just like for the SI Brochure.

Current:
Screen Shot 2021-01-01 at 10 32 59 PM

Original:
Screen Shot 2021-01-01 at 10 33 15 PM

BIPM: Remaining issues (continues #62)

MEP Candela Rapport (mep-candela-rapport.adoc)

  1. bar is barely noticeable, especially when it is used on some capital letter in the stem expression, at least in Acrobat Reader in Widows OS.

Generated (200%):
image
image

Original (200%):
image

  1. Too small space reserved for the terms in definition lists causes overlapping with definition.

image

  1. Following note is not generated in chapter 5.1:

NOTE: The descriptor "photopic" is used only when quantities other than photopic are reported or discussed in the same document and there is a possibility of confusion.

Recommended values (https://github.com/metanorma/bipm-si-brochure/tree/bipm_corrections/sources/rec-values repo)

  1. Too many blank pages are generated at the beginning of the documents.

BIPM brochure: break in list

In https://github.com/metanorma/bipm-si-brochure/blob/master/sources/sections-a1-en/04-cipm-1946.adoc (and in fr part also) [upperalpha] list breaks into two:

[upperalpha]
.. Definitions of the mechanical units which enter the definitions of electric units:
...
[upperalpha]
.. Definitions of electric units. The Comité International des Poids et Mesures (CIPM) accepts the following propositions which define the theoretical value of the electric units:

In the resulted PDF it renders as:
изображение

But second should be B as in source PDF:

изображение

BIPM SI brochure (French): review


Issues:

  1. Stem expressions are not generated at all. The first example is shown in the following captures, where alpha and gamma are missing.

Original:
image

Generated:
image

Source ADOC:
(Rayons x et stem:[gamma], électrons), Section II (Mesure des radionucléides), Section III (Mesures neutroniques), Section IV (Étalons d’énergie stem:[alpha])

  1. Cross-referencing should be fixed. I recall BIPM asked for adding the corresponding pages in cross-references, which is probably the reason why we have them in some places where they are not included in the original document.

However, I can see the word voir is showing in more than one place, due to markup + automatic addition of page numbers. Moreover, BIPM used keyword section in some places, chapitre in the others, while sometimes they didn't use any keyword. So my question is whether we should keep voir and/or section/ chapitre in the markup, or we agreed with BIPM on some standard which will be applied in all cases.

Original:
image

Generated:
image

From ADOC source:
_obligatoires_ (voir <<chapter5>>).

Original:
image

Generated:
image

From ADOC source:
(voir <<cls-236>>)

When the same ADOC syntax was used in the Introduction, page number was not included. I have already changed markup here because I thought it was wrong before seeing the other cross-references. Please let me know if I should revert the changes.

Original:
image

Generated:
image

I changed markup here to:
dans le texte «&nbsp;<<le_bipm_et_la_cdm>>&nbsp;» (page <<le_bipm_et_la_cdm,pagenumber%>>).

Another example where page number is not included in neither original nor generated PDF is shown below.

Original:
image

Generated:
image

From source ADOC:
(voir <<scls541>> pour une explication de la notation utilisée ici).

Moreover, should "voir" be italicized or not? Example from Appendix 1 of the original document is below. As far as I could see, "voir" was always italicized in Appendix 1, while that was not the rule in the rest of the brochure.

Original:
image

Generated:
image

  1. Heading row of the ToC table in Appendix 1 is repeating at each page, probably because there was a blank line between it and the next table row. I removed that blank row. However, we still need word "page" to appear at the beginning of each new page.

Original:
image

Generated:
image

Note: I've already changed capital P to small p in "page" and made it boldfaced.


Questions/possible issues

  1. Should we have the first line in the generated ToC?

Original:
image

Generated:
image

  1. Do we need to show subsections for annexes in ToC? Do we need to add a dot after annex number?

Original:
image

Generated:
image

  1. This was probably agreed with BIPM, but in order to double-check: should this example be a part of the main text, or it should be shown on the right margin, as in the original (ignore the fact that math expressions are not shown in generated PDF):

Original:
image

Generated:
image

  1. Is there some reason why yellow-highlighted part was excluded?

Original:
image

Generated:
image

  1. Titles are always boldfaced in our case. However, BIPM uses some kind of referencing in the titles, which applies the style which is generally used for papers of that type. I'm just noticing this as a difference, but don't know if that is a problem for BIPM team.

Original:
image

Generated:
image

  1. Are we supposed to be using Greek letters for second level of items list?

Original:
image

Generated:
image

Note: Markup fixes are applied in #48.

Formatting of values (as italics) vs units (as upright)

From BIPM:

The largest number of comments is related to the use if italic or upright font. (in #50 #51 #52 #53)
In general, symbols for quantities are printed in italics, whereas symbols for units are in upright font.

Is it possible to textually encode some text in stem:[_v_ "ms"^{-2}] blocks so that the _v_ bit becomes italic?

BIPM feedback on MEP Kelvin

Location Issue
Titlepage wrong date at bottom: 20 May 2019
3 wrong date at bottom: 20 May 2019
4 the words with hyperlinks are not identified, throughout whole document
5 definition of the kelvin is not easily distinguishing from surrounding text: bold font
  definition of the kelvin: wrong numerical value: 1.380 649 x 10-23
  replace decimal comma by dot
  group decimals by three
  paragraph below definition: wrong numerical value, replace comma by dot, group by three, see above
  paragraph below definition: T in italics
  3rd paragraph below definition: replace comma with dot in 273.15
  4th paragraph below definition: replace comma with dot in 273.16 and in 3.7 and 0.1
  5th paragraph below definition: µ not in italics
  6th paragraph: replace clause by section, throughout the document
6 1st paragraph: could we have 1 and 2 instead of a and b, as in the list just below
  list item 3: replace comma by dot in 0.9
10 1st line: replace comma by dot in  0.1
  2nd paragraph below list: wrong name of the document "Relative primary radiometric thermometry"
11 2nd line:  replace comma by dot in  0.1
  equation 4: p missing in equation
  3rd paragraph: replace comma by dot in 0.52
  wrong numerical value for Aµ: -0.000 0079
  error in equation 5: p is a parameter of C: C(p)
  paragraph below equation 5: replace A# by Aε
12 1st paragraph of 4.3.3: replace fm(p) by fm(p)
  1. paragraphh of 4.3.3, 3rd line: m in italics
  1st paragraph of 4.3.3: replace fm(0) by fm(0)
15 3rd paragraph: replace comma by dot in 0.65 and 0.9
  1st paragraph of 5.1: replace comma in 0.5 and 0.65 by dot
  last paragraph: T in italics (2 x)
  last paragraph: reference to "Estimates of the differences T-T90" not correct
16 1st paragraph: replace comma by dot in 0.65 (2 x) and in 0.9
18 Bibliography, reference 2: h, e, k and NA in italics

@metanorma/editors if there are non-content issues, please ping @Intelligent2013 or @opoudjis . Thanks!

Original comment file if the math units are unclear here:
Observations mep kelvin.xlsx

BIPM feedback on MEP Metre

Location Issue
Titlepage wrong date: should be 20 May 2019
3 wrong date: should be 20 May 2019
5 reference to SI brochure shall be a number
5 text of definition not easily distinguisable from surrounding text: bold font
6 duplication of page 5, delete
7 paragraph below equation 1: l in italics
  replace "clause" by "section" throughout the document
  Note: µ not in italics (2 x)
8 legend of Figure 1 not clearly separated from rest of text
9 equatio 4: insert a space between A and cos
9 paragraph below equaiton 4: replace ω by φ , replace k by ω
  paragraph below equation 5: replace appendix by annex, throughout the document
  legend of Figure 2 not clearly separated from rest of text
10 2nd line: replace comma by dot in 0.001
  error in equation 7: Pi shall be below the horizontal line
  error in equation 8: t missing
  last paragraph: replace references to "BIPM standard-frequencies" by numbers
11 2nd paragraph: replace comma by dot in 101.325 and 0.27
  Review layout of table 1: columns are at wrong places, replace decimal commas by dots, exponents need to be superscripts
12 3rd paragraph: replace all decimal commas by dots
  3rd paragraph: wrong numerical value in 5th line: 0.000 003 2
  Review layout of table 2;: columns are at wrong places, replace decimal commas by dots, wrong titles
13 1st paragraph: cm not in italics
  Table 3: replace all decimal commas by dots, increase column widts so that no overlap between numbers. The right margin of the document seems to be too large and limits the available space
14 2nd paragraph from bottom: replace decimal comma by dot
  last paragraph:  µ not in italics
16 reference 1 not correct
18 equation 1.2, second line: replace 'I2 + I2' with  'I1 + I2'
  paragraph below equaiton 1.2: symbol for phi should be the same as in the equation
20 Table 2.1; entry for Abbe error: insert space between d and tan Ѳ
  Table 2.1, entry for cosine error: repalce decimal comma by dot in 1.2
  Table 2.1: replace all decimal commas by dots
  Table 2.1, entry for non planar wavefronts: 'one or two nm' in bold font
  Table 2.1, entry for polarization crosstalk: 'few nm' in bold font
  Table 2.1, entry for referenc epath stability: '10.7μm' in bold font
  Table 2.1, entry for secondary modes in lasers: '1.1 %' in bold font
  Table 2.1: entry for air refractive index: text of column 1 printed in column 2
  Table 2.1: entry for air refractive index: '0.00027' and 3 x 10-5 in bold font
  Table 2.1, entry for light frequency: '1.5 x 10-6', '1011' and '10-9' in bold font
22-23 Numbers of references in first column in square brackets, need not be repeated at end of reference
  Names of Journals in italics, as in [3], [9]
24 2nd paragraph, 5th line: replace references [3, 13] with [5, 6]
25 1st paragraph:  replace 10-8 by 10-8
  Figure 3.1: insert vertical space between figure caption and text
26 2nd paragraph: replace decimal comma by dot in 2.57
26-27 see comments in lines 45 and 46
29-30 seec ommnets in lines 45 and 46
31 1st paragraph: Si not in italics (2 x)
31 3rd paragraph: replace decimal comma with dot
  3rd paragraph: group decimals in groups of three
  3rd paragraph: several zeros missing in 0.000 003 2
  paragraph following equation: replace comma with dot, zero missing in 543.102 0504
32 3rd paragraph of "Measurement range and conditions": R, S, x, y in italics
  4th paragraph: x,y,z in italics
33 Reference 2 completely wrong

@metanorma/editors if there are non-content issues, please ping @Intelligent2013 or @opoudjis . Thanks!

Original comments file:
observations mep metre.xlsx

French SI Brochure feedback from BIPM (pages 82-104-Index)

page comment
82 2nd bullet point in first list: replace "mètre" by "mètres"
82 use comma as decimal separator for all  numbers
83 3rd bullet point from bottom: pi not in italics
83 last bullet point from bottom : M in M(12C) in italics
82 CIPM 2013: isolated » at beginning of line
85 1st bullet point following "recommande": change to 6s2  1S0  –  6s  6p  3P0
85 2nd bullet point: 4s   2S1/2   –   3d 2D5/2
85 3rd bullet point: 6s 2S1/2 – 4f 13  6s2  2F7/2
85 3rd bullet point : 6s2  1S0 – 6s 6p 3P0
85 3rd bullet point: use comma as decimal separator for all numbers
85 last bullet point: 3s2 1S0  – 3s 3p 3P0
85 last bullet point: use comma as decimal separator
86 1st bullet point:  5d10 6s 2S1/2  –  5d9 6s2 2D5/2
86 1st bullet point: use comma as decimal separator for all numbers
86 2nd bullet point: 6s 2S1/2 (F = 0, mF = 0) – 5d  2D3/2 (F = 2, mF = 0)
86 3rd bullet point: 5s  2S1/2 – 4d 2D5/2
86 4th bullet point: 5s2 1S0  –  5s 5p 3P0
86 Resolution 1: 1st paragraph, e in italics
87 Recommendation 2 : also here, all identification of the optical transitions have errors with the subscripts and superscripts. Please refer to the SI brochure.
87 Recommendation 2: use the comma as decimal separator for all numbers
87 last bullet point: accent missing on "octopôle".
88 first bullt point: addent missing on "quadrupôle"
88 two bullet points following "recommande": "Les valeurs" too far on the left
89 Resolution 1, list of constants: use comma as decimal separator for the value of the Avogadro constant
90 "Annexe 1" missing in first title
90 "Annex 2" missing in second title
90 4th bullet point from bottom: h in italics
90 3rd bullet point from botton: pi not in italics
90 2nd bullet point from bottom: replace TTPW by TTPW
90 last bullet point: M italics
91 "Annex 3" missing in title
91 group decimals after decimal separator  by three, for all numbers
94 Can we keep "Partie 1" in the title, without creating a separate entry in the Table of Contents? Analogous for "Partie 2" and "Partie 3".
95 4th paragraph: isolated » at beginning of line
99 first paragraph: Metrologia in italics
99 second paragraph: Metrologia in italics
100 3rd paragraph: isolated » at beginning of line
100 last paragraph: isolated « at end of line
100 last paragraph, 5th line: wrong symbol for °K
101 first paragraph:  isolated « at end of line
101 2nd paragraph: N in italics
101 3rd paragraph: isolated « at end of line
101 last paragraph: isolated « at end of line
104 entry for SUNAMCO: text wrongly distributed over columns
INDEX The index is missing

BIPM Feedback: French page 37, 2. line: reference to page number missing (inter-doc xrefs)

This was originally reported here: #41

Original:

Screen Shot 2021-01-01 at 11 44 08 PM

Generated:
Screen Shot 2021-01-02 at 1 16 08 AM

We're missing the page reference. This is a in-collection inter-document cross reference, pointing to the English version of the SI Brochure.

The source is:

En anglais, même lorsque la valeur d’une grandeur est utilisée comme adjectif, il convient
de laisser une espace entre la valeur numérique et le symbole de l’unité. Ce n’est que
lorsque l’on écrit le nom de l’unité en toutes lettres que l’on applique les règles
grammaticales ordinaires (voir un exemple en anglais page <<english-doc,anchor=english_example>>).

Semantic XML source:

<p id="_e9277bf0-ef2f-49f3-a909-bc97502c6052_si-brochure-fr">
  En anglais, m&#xEA;me lorsque la valeur d&#x2019;une grandeur est
  utilis&#xE9;e comme adjectif, il convient
  de laisser une espace entre la valeur num&#xE9;rique et le symbole de
  l&#x2019;unit&#xE9;. Ce n&#x2019;est que lorsque l&#x2019;on &#xE9;crit le nom
  de l&#x2019;unit&#xE9; en toutes lettres que l&#x2019;on applique les
  r&#xE8;gles grammaticales ordinaires (voir un exemple en anglais page
  <eref type="inline" bibitemid="english-doc_si-brochure-fr"
  citeas="si-brochure-en">
  <localityStack>
    <locality type="anchor">
      <referenceFrom>english_example</referenceFrom>
    </locality>
  </localityStack>
</eref>
  ).
</p>

I've verified that the generated bilingual XML does not contain this anchor english_example.

In the source where the anchor is used:

==== Quantity symbols and unit symbols

Unit symbols must not be used to provide specific information about the quantity
and should never be the sole source of information on the quantity. Units are never
qualified by further information about the nature of the quantity; any extra information
on the nature of the quantity should be attached to the quantity symbol and not to the unit symbol.

[[english_example]]
[NOTE]
====
For example: The maximum electric potential difference is stem:[ii(U)_("max") = 1000 " "rm(V)] 
but not stem:[ii(U) = 1000 " "rm(ii(V)_(max))]. The mass fraction of copper in the sample of
silicon is stem:[w("Cu") = 1.3 xx 10^(-6)] but not stem:[1.3 xx 10^(-6) " "rm(w)//rm(w)].
====

The generated Semantic XML of this clause is:

<clause id="_quantity_symbols_and_unit_symbols_si-brochure-en" obligation="normative">
  <title>Quantity symbols and unit symbols</title>
  <p id="_83bd03bb-6870-4189-be7b-04fba7b05d6c_si-brochure-en">
    Unit symbols must not be used to provide specific information about the
    quantity and should never be the sole source of information on the quantity.
    Units are never qualified by further information about the nature of the
    quantity; any extra information on the nature of the quantity should be
    attached to the quantity symbol and not to the unit symbol.
  </p>
  <note id="english_example_si-brochure-en">
    <p id="_3d63f17a-7388-401e-ae5b-6b368dac8415_si-brochure-en">
      For example: The maximum electric potential difference is
      <stem type="MathML">
      <math xmlns="http://www.w3.org/1998/Math/MathML">
        <msub>
          <mrow>

The note ID becomes english_example_si-brochure-en here, that's why the anchor is missing.

French: page 83 CIPM, 2009, (PV, 77, 105) Recommandation 2 has stray non-stem formula

I noticed one particular equation looking weird:

Screen Shot 2021-01-02 at 1 44 29 AM

* la transition optique non perturbée ^2^S~1/2~ stem:[(ii(F) = 0) – " "^2 ii(F)_(7//2) (ii(F) = 3," " m_"F" = 0)] de l’ion de ^171^Yb^+^, à la

Apparently it was encoded not as stem, probably due to the starting ^2^.

I noticed that in other places in the document we already have a solution, so will try if this works:

* la transition optique non perturbée stem:[text()^2"S"_(1//2) (ii(F) = 0) – " "^2 ii(F)_(7//2) (ii(F) = 3," " m_"F" = 0)] de l’ion de ^171^Yb^+^, à la

PDF: Table header cell underlining issue in 2 MEP files

The table header cells seem to be have both a top line and also a bottom line, but we only want the top line if it's the first row.

  1. https://www.bipm.org/utils/common/pdf/mep/M-e-P_I2_532.pdf

https://github.com/metanorma/bipm-si-brochure/blob/master/sources/rec-values/mep-wgfs-nm532-I2.adoc

Original:
(a)
Screen Shot 2021-01-07 at 2 23 29 PM

Output:
<img width="575" alt="Screen Shot 2021-01-07 at 3 02 15 PM" src="https://user-images.githubusercontent.com/11865/103862050-58185300-50f9-11eb-9772-e8a16e67bbc9.png">

[%unnumbered]
|===
| line no | transition h| comp. 2+h| stem:[f_(xy) = [ f(y , x) – f(a_(10), R(56) 32-0) \] // rm(kHz)]
| h| stem:[x] h| stem:[y] h| stem:[f_(xy)] h| stem:[u_c // rm(kHz)]

(b)
Screen Shot 2021-01-07 at 2 23 45 PM

Output:
Screen Shot 2021-01-07 at 3 02 32 PM

[%unnumbered]
|===
| transition | comp. 2+h| stem:[f_(xy) = [ f(y , x) – f(a_(10), "R(56) 32-0") \] // " "rm(kHz)] h| Ref.
h| stem:[x] h| stem:[y] h| stem:[f_(xy)] h| stem:[u_c // rm(kHz)] h|

(c)
Screen Shot 2021-01-07 at 2 23 57 PM

Output:
Screen Shot 2021-01-07 at 3 02 52 PM

[%unnumbered]
|===
| line no | transition | comp. 6+h| stem:[[ f(y , x) – f(a_(10)," R(56) 32-0)"\] // " "rm(kHz)]
h| h| stem:[x] h| stem:[y] h| <<ye1999>> h| <<zhang>> h| <<holzwarth>> h| <<nevsky>> h| unw. mean h| stem:[u // rm(kHz)]
  1. https://www.bipm.org/utils/common/pdf/mep/M-e-P_OsO4_10.3.pdf

Original:
Screen Shot 2021-01-07 at 2 23 07 PM

Output:
Screen Shot 2021-01-07 at 3 03 39 PM

[%unnumbered]
.stem:[ii(lambda) ~~ 10.3" "mu rm(m)" OsO"_4]
|===
| h| stem:[""^12 "C"^{16} "O"_2] 2+h| stem:[rm(OsO)_4] h| | | |
h| stem:[n] h| laser line h| line h| [isotope] h| [stem:[f_n − f {R(10)}] stem:[//rm(kHz)]] h| stem:[u_c] stem:[//rm(kHz)] h| [stem:[ f (rm(OsO)_{4})] stem:[−f (rm(CO)_{2}) //rm(kHz)]] h| stem:[u_c] stem:[//rm(kHz)]

Problem with Relaton-BIPM

I'm getting this error with this:

bundle exec metanorma sources/mep-kelvin-definition-en.adoc

Error:

[relaton-bipm] ("BIPM SI Brochure") fetching...
bundler: failed to load command: metanorma (/Users/me/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/bin/metanorma)
URI::InvalidURIError: bad URI(is not URI?): "https://raw.githubusercontent.com/relaton/relaton-data-bipm/master/data/si brochure.yaml"
  /Users/me/.rbenv/versions/2.6.5/lib/ruby/2.6.0/uri/rfc3986_parser.rb:67:in `split'
  /Users/me/.rbenv/versions/2.6.5/lib/ruby/2.6.0/uri/rfc3986_parser.rb:73:in `parse'
  /Users/me/.rbenv/versions/2.6.5/lib/ruby/2.6.0/uri/common.rb:234:in `parse'
  /Users/me/.rbenv/versions/2.6.5/lib/ruby/2.6.0/uri/common.rb:737:in `URI'
  /Users/me/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/relaton-bipm-1.5.0/lib/relaton_bipm/bipm_bibliography.rb:14:in `search'
  /Users/me/.rbenv/versions/2.6.5/lib/ruby/gems/2.6.0/gems/relaton-bipm-1.5.0/lib/relaton_bipm/bipm_bibliography.rb:39:in `get'

These seem to work:

[relaton-bipm] ("BIPM si-brochure") fetching...
[relaton-bipm] ("BIPM si-brochure") found si-brochure

I believe this is due to the keywords in "BIPM {...}". Maybe Relaton BIPM needs to be more robust.

Ping @andrew2net for help. Thanks!

BIPM xslt: keep-with-next for headers

From opoudjis #24 (comment):

@Intelligent2013 There's a lot of issues with keep-with-next, and they can be addressed in markup, for anything that's not a header; but headers need keep-with-next too, and I don't see that being observed in the Annex.

Example (Resolution X is 4th-level title):
изображение

I hoped that

<fo:table-row keep-with-next.within-page="always"...

solve this issue, but it's not working. Looks like it's not working when right column is row spanned.

Need to find a workaround solution...

French SI Brochure feedback from BIPM (pages 4-20)

page comment
4 Instead of "La Brochure sur le SI", the text starts with "Ce document"
4 the accents of the French words are all at wrong places: too high, too much on the left
4 In the postal address at the bottom "Sèvres Cedex" should be on one line
6 Bullet point 6: gamma and alpha should not be in italics
9 Possible to bring item 5.4.8 to the previous page?
9 Include the index in the table of contents
10 In the title the accents on "à" and "édition" seem to be placed too high
12 At the end of the first paragraph the reference to a page 5 is missing.
14 5. line of 2.2: "unité" should be written with the same font as"valeur numérique".
15 List of constants: It seems that the text is written in bold, but the numbers are not.
15 2nd line above table 1: the negative exponents are not at the same height as the positive ones. Applies to many other places in the text
16 5. paragraph, line 4: an alpha is missing
16 6. paragraph: the isolated « a the end of line is not very nice
16 6. paragraph, the omega should be in italics (2 x)
16 the isolated « a the end of line is not very nice
17 2.3, first phrase:  "unités  de  base" should be in italics (2 x)
17 side note: the word "recommendations" should be in italics
17 side note: replace "Article 5" with "chapitre 5"
18 3. paragraph: replace "Article 2.3.6" with "section 5.3.6"
18 definition of the kilogram: the last two digits '15' of the numberical value should be separated by a small space, so that the digits are grouped by three.
18 definition of the kilogram: the negative exponent is not at the same height as the positive
18 last equation: 9 192 631 770 is missing in the equation
18 last paragraph: the isolated » at the beginning of the line is not nice
19 Definitionof the ampere: the symbol for the elementary charge, e, should be in italics
19 line above first equation: the symbol for the elementary charge, e, should be in italics
19 second paragraph from bottom: the symbol for π should not be in italics
19 second paragraph from bottom: the « at the end of the line is not nice
19 second paragraph from bottom: the symbol for the elementary charge, e, should be in italics
19 last line: the symbol for π should not be in italics
20 Definition of the kelvin: the negative and postitive exponents are not at the same height
20 second equation: the decimals of 6,626 070 15 are wrongly grouped. They should be grouped as in this comments.
20 paragraph below second equation: the unit J should not be separated from the value.
20 last equation:  replace 273.5 with 273.15
20 replace "article 5.4.1" with "section 5.4.1"

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.