Skip to content

Commit

Permalink
Few writing updates
Browse files Browse the repository at this point in the history
  • Loading branch information
manuelfuenmayor authored and ronaldtse committed Nov 11, 2023
1 parent b990a37 commit a66544e
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions _posts/2022-11-17-xmlsts-to-metanorma.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ https://www.niso-sts.org/TagLibrary/niso-sts-TL-1-2-html/index.html[NISO STS doc

== What is _mnconvert_?

link:https://github.com/metanorma/mnconvert[_mnconvert_] is a conversion
link:https://github.com/metanorma/mnconvert[_mnconvert_] is a
tool that transfers the content of an XML
document compliant with ISO/NISO STS to Metanorma AsciiDoc. It was
developed with the intent of speeding up the conversion process.
Expand Down Expand Up @@ -202,13 +202,16 @@ using `{{...}}` or `term:[...]` syntax.
+
--
Source code blocks mainly contain the code without any line breaks. Insert
the line breaks and indentations where needed and check whether all the
the line breaks and indentations where needed (or, if there are too many lines,
just copy and paste the whole code from the XML source) and check whether all the
blocks are encoded properly with the `[source]` attribute. It is preferable
to specify which programming language is used in the code block.

Sometimes, there is a need to introduce markup into the source code. If any
term is boldfaced, italicized, or underlined, it should be surrounded by
delimiters `{{{...}}}` for enabling markup.
delimiters `{{{...}}}` for enabling markup; you also have the option of
https://docs.asciidoctor.org/asciidoc/latest/subs/apply-subs-to-blocks/#the-subs-attribute[the subs attribute]
configured as `subs="verbatim,quotes"`, to enable rich text inside code.
--

* Check the references in Bibliography and Normative references sections.
Expand All @@ -218,7 +221,8 @@ It can happen that some reference is listed in both sections. If that is
the case, remove the reference from the Bibliography and make sure that all the
cross-references are then made with the anchor given in the Normative references
section.
Also, make sure that there are no cross-references to the converted document itself

Also, make sure that there are no cross-references pointing to the document itself
and that correct identifiers are given for auto-fetching the references.
--

Expand All @@ -236,7 +240,7 @@ specify some reference. In the AsciiDoc files generated by _mnconvert_, it is
possible that an anchor will include unnecessary whitespace before or after
an underscore, or two underscores instead of one. It is recommended to
confirm that the same anchor is used for the same reference throughout the
document and to remove the needless whitespaces to avoid broken cross-references.
document and remove any needless whitespace to avoid broken cross-references.
--

* Make a quick validation of the document's encoding in general.
Expand All @@ -253,7 +257,7 @@ finds unnoticeable non-ASCII whitespaces.

NOTE: Source XML files can also be generated with the help of OCR. Therefore,
it is possible that some characters will be wrongly written in the source file,
e.g. number `1` can be replaced by the letter `l` and vice versa. It is advised
e.g. number `1` written as `l` and vice versa. It is advised
to check whether there are such typos in the converted AsciiDoc and to correct
them.
--

0 comments on commit a66544e

Please sign in to comment.