From e6bcd5e7e1c136416d1ce6096c550cf75383d213 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Thu, 22 Jun 2023 08:32:44 +0200 Subject: [PATCH] docs: "References" page added --- docs/appendix/references.md | 15 +++++++++++++++ docs/getting_started/faq.md | 9 ++++++--- mkdocs.yml | 1 + 3 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/appendix/references.md diff --git a/docs/appendix/references.md b/docs/appendix/references.md new file mode 100644 index 00000000..11c54f92 --- /dev/null +++ b/docs/appendix/references.md @@ -0,0 +1,15 @@ +# References + +[`ISO80000`](#ISO80000){ #ISO80000 } + +: [ISO 80000-1:2009(E) "Quantities and units — Part 1: General"](https://www.iso.org/standard/30669.html), + International Organization for Standardization. + +[`SIBrochure`](#SIBrochure){ #SIBrochure } + +: [The International System of Units (SI)](https://www.bipm.org/documents/20126/41483022/SI-Brochure-9-EN.pdf), + International Bureau of Weights and Measures (20 May 2019), ISBN 978-92-822-2272-0. + +[`Quincey`](#Quincey){ #Quincey } +: ["Angles in the SI: a detailed proposal for solving the problem](https://arxiv.org/pdf/2108.05704.pdf), + Quincey, Paul (1 October 2021). diff --git a/docs/getting_started/faq.md b/docs/getting_started/faq.md index 18fd1018..b01f8844 100644 --- a/docs/getting_started/faq.md +++ b/docs/getting_started/faq.md @@ -2,7 +2,8 @@ ## Why do we spell `metre` instead of `meter`? -This is how ISO 80000 defines it (British English spelling by default). +This is how the BIPM defines it in the [SI Brochure](../../appendix/references/#SIBrochure) +(British English spelling by default). ## Why don't we use UDLs to create quantities? @@ -126,8 +127,10 @@ all the properties of scaled units and is consistent with the rest of the librar ## Why Unicode quantity symbols are used by default instead of ASCII-only characters? -Both C++ and ISO 80000 are standardized by the ISO. ISO 80000 and the SI standards specify Unicode symbols -as the official unit names for some quantities (i.e. `Ω` symbol for the resistance quantity). +Both C++ and [ISO 80000](../../appendix/references/#ISO80000) are standardized by the ISO. +[ISO 80000](../../appendix/references/#ISO80000) and the [SI](../../appendix/references/#SIBrochure) +standards specify Unicode symbols as the official unit names for some quantities +(i.e. `Ω` symbol for the resistance quantity). As **mp-units** library will be proposed for standardization as a part of the C++ Standard Library we have to obey the rules and be consistent with ISO specifications. diff --git a/mkdocs.yml b/mkdocs.yml index 47ca408d..5aa1fbf6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -109,3 +109,4 @@ nav: - Appendix: - Glossary: appendix/glossary.md - Release Notes: appendix/release_notes.md + - References: appendix/references.md