Skip to content

Commit

Permalink
chore: cleaning up quotation marks
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Mar 2, 2024
1 parent 6c810c5 commit f3e3cf0
Show file tree
Hide file tree
Showing 28 changed files with 155 additions and 139 deletions.
6 changes: 3 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ IMPORTANT: Try to reduce such changes with careful planning, and never delete or
. **Settle on flavor and markup abbreviations.**
+
- _Flavor abbreviation_ is _not_ typically the same as organization abbreviation;
usually it ends with “D”—e.g., M3AAWG is M3AAWG's flavor abbreviation.
usually it ends with "D"—e.g., M3AAWG is M3AAWG's flavor abbreviation.
+
IMPORTANT: The `--type` flag given to Metanorma-CLI is expected to reference the same flavor abbreviation in lowercase.
- _Markup abbreviation_ usually takes the form of `Ascii<uppercase flavor abbreviation>`.
Expand All @@ -60,7 +60,7 @@ IMPORTANT: The `--type` flag given to Metanorma-CLI is expected to reference the
how sections are formatted, how references are formatted,
any specifics about build, etc.
- One or more pages offering _reference guides_: a complete list of custom document attributes
(either new attributes or attributes which behave differently compared to base Metanorma),
(either new attributes or attributes which behave differently compared to "base" Metanorma),
a list of unsupported AsciiDoc features, etc.
+
[TIP]
Expand Down Expand Up @@ -196,7 +196,7 @@ title: Write <organization abbreviation> <documents|standards> with Metanorma
data_models: <specs entry>
# (optional)
# Use for experimental flavors not ready for production.
# Use for "experimental" flavors not ready for production.
experimental: yes
----
Expand Down
8 changes: 4 additions & 4 deletions _pages/author.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:
== Why Metanorma?

[.feature-list]
* Easy +++<abbr title="What you see is what you mean'">WYSIWYM</abbr>+++ semantic authoring
* Easy +++<abbr title="What you see is what you mean">WYSIWYM</abbr>+++ semantic authoring
with syntax based on AsciiDoc.

* Validation of document contents against a set of style rules,
Expand All @@ -28,10 +28,10 @@ redirect_from:
+++
<div class="cta"><a class="button" href="/author/getting-started">Get started</a></div>
+++
The Metanorma documentation covers all features you need to create your next standard document effortlessly.
The Metanorma documentation covers all features you need to create your next standard document effortlessly.

The documentation structure follows the Metanorma workflow, depicted below.
The documentation structure follows the Metanorma workflow, depicted below.
You'll find background information and best practice articles in the concepts section. If you need to quickly look up an attribute, head to the references section.

.The Metanorma Workflow from start to finish
.The Metanorma Workflow from start to finish
image::../assets/author/concepts/Metanorma_Workflow.png[The Metanorma workflow]
2 changes: 1 addition & 1 deletion _pages/builder.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Here're some of the features that make Metanorma a good match
for document publishing workflows of a standards defining organization:

[.feature-list]
* +++<abbr title="What you see is what you mean'">WYSIWYM</abbr>+++ semantic authoring
* +++<abbr title="What you see is what you mean">WYSIWYM</abbr>+++ semantic authoring
with syntax based on AsciiDoc.

* Versionable document sources.
Expand Down
4 changes: 2 additions & 2 deletions _pages/tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
#hero_include: index-page-hero.html
---
<p>
If you are completely unfamiliar with Metanorma, youve come to the right place. In this tutorial, you will learn how to create Metanorma documents, create outputs, and even learn the basics of troubleshooting.
If you are completely unfamiliar with Metanorma, you've come to the right place. In this tutorial, you will learn how to create Metanorma documents, create outputs, and even learn the basics of troubleshooting.
</p>


<h2>Curriculum</h2>
<!--Include good-looking navigation of the headings. -->
<!--Include good-looking navigation of the headings. -->
2 changes: 1 addition & 1 deletion _posts/2021-06-30-halfway-into-gsod.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Since we now know what our users expect to find, we looked at selected content s
* Shortness
* Stimulating additions

We've clarified the deficits in the Further remarks section and gave recommendations on how to improve the content. We have also looked at the https://readable.com/blog/the-flesch-reading-ease-and-flesch-kincaid-grade-level/[Flesch-Kincaid] readability index to check if there's very complicated-to-read content. Luckily most pages were understandable by 9th-10th graders, which means that also people with English as their second language will understand the information easily.
We've clarified the deficits in the "Further remarks" section and gave recommendations on how to improve the content. We have also looked at the https://readable.com/blog/the-flesch-reading-ease-and-flesch-kincaid-grade-level/[Flesch-Kincaid] readability index to check if there's very complicated-to-read content. Luckily most pages were understandable by 9th-10th graders, which means that also people with English as their second language will understand the information easily.

.A short peek into our analysis.
image::/assets/blog/2021-06-30-quality.png[A short peek into our analysis.]
Expand Down
16 changes: 8 additions & 8 deletions _posts/2022-03-13-iso-house-style.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ https://www.iso.org/ISO-house-style.html#iso-hs-s-formatting-r-vocabulary[Vocabu
____
A vocabulary is the only ISO document that can have terminological entries in
clauses other than Clause 3. If terminological entries are given in other
clauses, use a clause title starting Terms related to. Terminological entries
clauses, use a clause title starting "Terms related to". Terminological entries
are never included in annexes.
____

Expand All @@ -204,8 +204,8 @@ Metanorma supports the designed behavior:

[quote,ISO House Style]
____
Do not include the first line of the fixed text for Clause 3, i.e. For the
purposes of this document, the following terms and definitions apply. This is
Do not include the first line of the fixed text for Clause 3, i.e. "For the
purposes of this document, the following terms and definitions apply." This is
not needed in a vocabulary document because the terminological entries apply to
all the documents of the committee.
____
Expand Down Expand Up @@ -239,12 +239,12 @@ https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-and[And/Or]:

[quote,ISO House Style]
____
The phrase and/or is often used in English to express either or both of two
The phrase "and/or" is often used in English to express "either or both" of two
options. The meaning can be ambiguous, especially in translation to other
languages where the “/” is not a recognized punctuation mark.
languages where the "/" is not a recognized punctuation mark.
Avoid using and/or in a document to avoid confusion and misapplication. Use
the construction either x or y, or both instead.
Avoid using "and/or" in a document to avoid confusion and misapplication. Use
the construction "either x or y, or both" instead.
____

The conjunction phrase _and/or_ is to be avoided. Metanorma issues a warning if
Expand All @@ -254,7 +254,7 @@ https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-andor[And or &]:

[quote,ISO House Style]
____
ISO documents do not use the ampersand (&) in ordinary text. Use the word and instead.
ISO documents do not use the ampersand (&) in ordinary text. Use the word "and" instead.
____

The ampersand is to be avoided in ordinary text. Metanorma warns on encountering
Expand Down
2 changes: 1 addition & 1 deletion author/cc/authoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ other committees are added as `_3`, `_4`...
=== Terms and Definitions

[[note_general_doc_ref_terms_defs_calconnect]]
NOTE: This section supplements link:/author/topics/document-format/section-terms[The Terms and Definitions section] in general Metanorma documentation.
NOTE: This section supplements link:/author/topics/document-format/section-terms[The "Terms and Definitions" section] in general Metanorma documentation.

This must be Clause 3.

Expand Down
14 changes: 7 additions & 7 deletions author/concepts/metanorma_workflow.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Metanorma workflow consists of six phases:
. Publication


.The Metanorma Workflow from start to finish
.The Metanorma Workflow from start to finish
image::/assets/author/concepts/Metanorma_Workflow.png[The Metanorma workflow]

== Document creation
Expand All @@ -26,11 +26,11 @@ You can create a new standard document either by:

*New file*

The easiest way is to create a document from scratch, by creating an empty AsciiDoc file (`.adoc`) in the desired folder.
The easiest way is to create a document from scratch, by creating an empty AsciiDoc file (`.adoc`) in the desired folder.

*Templates*

Templates get you started faster, as they provide the structure of a standard document already. If your organization provides templates, you can create a new document based on a template using the command line.
Templates get you started faster, as they provide the structure of a standard document already. If your organization provides templates, you can create a new document based on a template using the command line.

*Import from Word*

Expand All @@ -48,7 +48,7 @@ end::editing[]

== Validation

Before you can generate any outputs, the AsciiDoc document needs to be checked against the document model to ensure it follows the rules of your SDO. Since the document model is defined in an XML schema, the compiler converts the AsciiDoc document into an XML file. The XML file is then checked against the SDOs XML schema. Metanorma will log all deviations from the SDO's structure or formatting on the terminal and into an error file.
Before you can generate any outputs, the AsciiDoc document needs to be checked against the document model to ensure it follows the rules of your SDO. Since the document model is defined in an XML schema, the compiler converts the AsciiDoc document into an XML file. The XML file is then checked against the SDO's XML schema. Metanorma will log all deviations from the SDO's structure or formatting on the terminal and into an error file.

* ❌ Invalid XML: The XML file does not comply with the XML schema, or with the formatting rules defined by the SDO.
All errors are logged to the terminal and are saved to an Error file (.`err`). Often the document will render successful despite errors, but the error messages point out potential issues with the document structure.
Expand All @@ -57,7 +57,7 @@ All errors are logged to the terminal and are saved to an Error file (.`err`). O

== Output generation

The Metanorma toolchain compiles documents in the following formats:
The Metanorma toolchain compiles documents in the following formats:

* Metanorma XML
* HTML
Expand All @@ -74,7 +74,7 @@ The HTML output is in HTML 5. All HTML output has a sidebar with a Javascript-ge

*PDF*

Metanorma generates PDF output from XML. The styling comes from an https://www.xml.com/articles/2017/01/01/what-is-xsl-fo/[XSL-FO] stylesheet. A processing engine (Apache FOP) interprets the stylesheet and generates the PDF.
Metanorma generates PDF output from XML. The styling comes from an https://www.xml.com/articles/2017/01/01/what-is-xsl-fo/[XSL-FO] stylesheet. A processing engine (Apache FOP) interprets the stylesheet and generates the PDF.

*Microsoft Word*

Expand All @@ -85,7 +85,7 @@ Metanorma can also generate a `.doc` Word output. Metanorma does not output `.do
Standards documents require collaboration and every SDO has its own process for reviews. Metanorma does support authors and reviewers by providing metadata that indicate in which phase the document is in and who reviewed it. You can add your remarks to a document with comments or create a to-do if you want someone to act.

== Publication
Once you and your reviewers agree that the standard is ready for publishing, you send it to your standard developing organization (SDO). The SDO will publish your document in their preferred channels, such as online or print.
Once you and your reviewers agree that the standard is ready for publishing, you send it to your standard developing organization (SDO). The SDO will publish your document in their preferred channels, such as online or print.

end::tutorial[]

Expand Down
2 changes: 1 addition & 1 deletion author/concepts/what_is_metanorma.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Metanorma is actually not one thing, but three:

Metanorma consists of several layers of complexity, see the figure below.
The basis for each metanorma document is AsciiDoc. Since AsciiDoc itself has limited functionalities for authoring standards, Metanorma extends AsciiDoc as one part of the Metanorma toolchain (1). Metanorma AsciiDoc provides advanced features, such as automatically linking the correct standard in a bibliography section.
The final layer of complexity are flavour-specific document rules and best practices based on the document metamodels (2). For example, ISO documents must include a Scope section, whereas NIST requires an Acknowledgements'' section.
The final layer of complexity are flavour-specific document rules and best practices based on the document metamodels (2). For example, ISO documents must include a "Scope" section, whereas NIST requires an "Acknowledgements'' section.

.Metanorma extends AsciiDoc provide a powerful tool for standard organizations
image::/assets/author/concepts/complexity_pyramid.png[Three layers of complexity: AsciiDoc - Metanorma AsciiDoc - Flavour specific document rules]
Expand Down
6 changes: 3 additions & 3 deletions author/concepts/wysiwyg_vs_wysiwym.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: author-docs
= Is what you see what you get?

tag::tutorial[]
Word is probably your go-to application for casual writing, such as letters, invitations - and with good reason, because Word has many benefits, such as:
Word is probably your go-to application for casual writing, such as letters, invitations - and with good reason, because Word has many benefits, such as:

* Creating Documents quickly
* An intuitive interface
Expand All @@ -15,9 +15,9 @@ image::/assets/author/concepts/Word_WSYIWYG.png[Word is a WYSIWYG application]

However, have you ever written a longer text, with many references, like a scientific text? Then you might have experienced some pain with Word: It tends to mess up the formatting, even if you use templates. Reference management in Word is also no fun, but the worst: Word tends to crash for very long documents, like standards.

Because of these issues, another approach to creating documents is popular: What you see is what you mean (WYSIWYM). This concept differs from WYSIWYG because you separate the content and the layout into separate files. To tell the compiler how the text should look or behave, you use markup language. You may have heard about Markdown or LaTeX, which are popular markup languages, but Metanorma uses AsciiDoc.
Because of these issues, another approach to creating documents is popular: "What you see is what you mean" (WYSIWYM). This concept differs from WYSIWYG because you separate the content and the layout into separate files. To tell the compiler how the text should look or behave, you use markup language. You may have heard about Markdown or LaTeX, which are popular markup languages, but Metanorma uses AsciiDoc.

The benefit is that you can publish different outputs from one source, for example into PDF or HTML. Since the layout is stored in a separate file, each output can even be styled differently.
The benefit is that you can publish different outputs from one source, for example into PDF or HTML. Since the layout is stored in a separate file, each output can even be styled differently.

.Metanorma uses AsciiDoc text as an input and can deliver different outputs, such as PDF and HTML. A stylesheet determines how the outcome looks like.
image::/assets/author/concepts/Metanorma_WSYIWYM.png[What you see is what you mean]
Expand Down
4 changes: 2 additions & 2 deletions author/ieee/authoring-guide/block-syntax.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Tables are a useful tool to collect and display measured data. As AsciiDoc is al
|=== <6>
----

<1> Attribute that specifies the table. `cols=x,x` tells the compiler that there are two columns. `[cols="1,1"]` The numbers specify the amount of spacing. For example, `[cols="4,2,4"]` would define three columns. The first and last column's width would be four times the relative width and the middle column would be half as broad. This attribute is optional.
<1> Attribute that specifies the table. `cols="x,x"` tells the compiler that there are two columns. `[cols="1,1"]` The numbers specify the amount of spacing. For example, `[cols="4,2,4"]` would define three columns. The first and last column's width would be four times the relative width and the middle column would be half as broad. This attribute is optional.

<2> You can add a table title by beginning the line with a dot `.`. Make sure that there is no space between the dot and the first word of the heading.

Expand Down Expand Up @@ -191,7 +191,7 @@ P:: point of the curve corresponding to a cooking time of stem:[t_90]

== Admonitions

Admonitions are signal words used to catch the reader's attention, such as TIP”, “NOTE, or WARNING. There are two ways to declare an admonition: in a single paragraph and as a block.
Admonitions are signal words used to catch the reader's attention, such as "TIP", "NOTE", or "WARNING". There are two ways to declare an admonition: in a single paragraph and as a block.

== Single-paragraph admonitions

Expand Down
4 changes: 2 additions & 2 deletions author/ieee/authoring-guide/terms-definitions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ terminology entries to be made available in the definitions clause.
[quote,IEEE SA Style Manual 2021, 12.4.2 General terminology usage]
____
English words should be used in accordance with their definitions in the latest
edition of Merriam-Websters New Collegiate Dictionary. Electrical and
electronics terms not defined in Merriam-Websters New Collegiate Dictionary
edition of Merriam-Webster's New Collegiate Dictionary. Electrical and
electronics terms not defined in Merriam-Webster's New Collegiate Dictionary
should be used in accordance with their definitions in the Dictionary Online.
The Dictionary is a continually-updated electronic version of the former IEEE
100, The Authoritative Dictionary of IEEE Standards Terms.
Expand Down
2 changes: 1 addition & 1 deletion author/ieee/authoring-guide/terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,4 @@ suggested but no clear-cut recommendations are made

SOURCE: https://standards.ieee.org/wp-content/uploads/import/documents/other/ieee_sa_toolkit.pdf[IEEE SA Quick Reference Guide: Standards Development Process]

These levels of requirements are often shown by the use of particular standards verbs, i.e., shall for requirements, should for recommendations, and may for guidelines. (more information can be found in the IEEE SA Standards Board Operations Manual and the IEEE SA Standards Style Manual) Figuring out what level of requirement is needed helps determine what kind of document should be developed.
These levels of requirements are often shown by the use of particular "standards verbs," i.e., "shall" for requirements, "should" for recommendations, and "may" for guidelines. (more information can be found in the IEEE SA Standards Board Operations Manual and the IEEE SA Standards Style Manual) Figuring out what level of requirement is needed helps determine what kind of document should be developed.
4 changes: 2 additions & 2 deletions author/iho/authoring-guide/block-syntax.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Tables are a useful tool to collect and display measured data. As AsciiDoc is al
|=== <6>
----

<1> Attribute that specifies the table. `cols=x,x` tells the compiler that there are two columns. `[cols="1,1"]` The numbers specify the amount of spacing. For example, `[cols="4,2,4"]` would define three columns. The first and last column's width would be four times the relative width and the middle column would be half as broad. This attribute is optional.
<1> Attribute that specifies the table. `cols="x,x"` tells the compiler that there are two columns. `[cols="1,1"]` The numbers specify the amount of spacing. For example, `[cols="4,2,4"]` would define three columns. The first and last column's width would be four times the relative width and the middle column would be half as broad. This attribute is optional.

<2> You can add a table title by beginning the line with a dot `.`. Make sure that there is no space between the dot and the first word of the heading.

Expand Down Expand Up @@ -191,7 +191,7 @@ P:: point of the curve corresponding to a cooking time of stem:[t_90]

== Admonitions

Admonitions are signal words used to catch the reader's attention, such as TIP”, “NOTE, or WARNING. There are two ways to declare an admonition: in a single paragraph and as a block.
Admonitions are signal words used to catch the reader's attention, such as "TIP", "NOTE", or "WARNING". There are two ways to declare an admonition: in a single paragraph and as a block.

== Single-paragraph admonitions

Expand Down
Loading

0 comments on commit f3e3cf0

Please sign in to comment.