Skip to content

Commit

Permalink
not just vocabulary documents for systematic term ordering in ISO: me…
Browse files Browse the repository at this point in the history
  • Loading branch information
opoudjis authored and ronaldtse committed Mar 6, 2024
1 parent 90c64ad commit b78f453
Showing 1 changed file with 47 additions and 35 deletions.
82 changes: 47 additions & 35 deletions author/iso/topics/markup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ one of:

==== Systematic order

===== General

// TODO remove: From NN: Systematic order is only permitted in vocabulary documents.

In systematic order, the entry numbers are "serial numbers reflecting
Expand Down Expand Up @@ -278,6 +280,8 @@ Definition 2.1, a sub-concept of Term 2
--
====

===== Encoding parent terms without definitions

If a parent term clause (a term clause that contains terms below) is not
given a definition, the `[.term]` attribute needs to be applied to indicate
that the parent term is a "term" instead of a "mixed-order grouping".
Expand Down Expand Up @@ -310,6 +314,8 @@ Definition 3, a sub-concept of Term 2

==== Mixed order

===== General

In mixed order,

* entry numbers of divisions are "serial numbers reflecting the structure of
Expand All @@ -329,9 +335,8 @@ In mixed order,
3.2.1.1 Terminological entry in the order of preference.
====

This arrangement counts only terminal subclauses within a
"`Terms and definitions`" clause as terms, and
all other clauses as groupings.
This arrangement counts terminal subclauses within a "`Terms and definitions`"
clause as terms, and all other intermediate clauses as term groupings.

[example]
.Encoding terms in mixed order with groupings
Expand All @@ -356,17 +361,52 @@ Definition C
====

NOTE: If there is any text in a term grouping, Metanorma is going to assume that
you intended for a systematic term.
the grouping was intended as a systematic term.


===== Declared term groupings

// TODO: NN REMOVE
// In vocabulary documents, if a clause has a definition (a normal paragraph that
// follows the heading definition), it is treated as a term grouping instead of a
// term (i.e. as mixed order) if it is tagged with the `[.grouping]`...

The role `[.grouping]` explicitly declares a clause as a term grouping. [added in https://github.com/metanorma/metanorma-iso/releases/tag/v2.3.4].

[source,asciidoc]
.Encoding terms in mixed order with declared groupings
--
== Terms and definitions

[.grouping]
=== Term grouping 1
Paragraph 1

==== Term A
Definition A

==== Term B
Definition B

[.grouping]
=== Term grouping 2
Paragraph 2

To introduce discursive text in a term grouping,
such text has to be flagged with a `[.boilerplate]` clause as described in
==== Term C
Definition C
--

===== Replacing boilerplate text in a term grouping

Discursive text in a term grouping are encoded with a `[.boilerplate]` clause
as described in
link:/author/topics/document-format/section-terms#overriding-predefined-text[Overriding predefined text].

NOTE: This is the same method as overriding boilerplate text in a
"Terms and definitions" section.

[example]
.Encoding terms in mixed order with groupings with grouping description
.Encoding terms in mixed order with groupings and replaced boilerplate
====
[source,asciidoc]
--
Expand Down Expand Up @@ -399,34 +439,6 @@ are ..." text will be assumed to be the definition of the respective term
grouping, and the subsequent terms will be assumed to be subterms.
====

In vocabulary documents, if a clause has a definition (a normal paragraph that
follows the heading definition), it is only treated as a subclause instead of a
term (i.e. as mixed order) if it is tagged with the role attribute
`[.grouping]`. [added in https://github.com/metanorma/metanorma-iso/releases/tag/v2.3.4].

[source,asciidoc]
.Encoding subclause groupings in a terminology clause in mixed order, with groupings providing content
--
== Terms and definitions

[.grouping]
=== Term grouping 1 (subclause 1)
Paragraph 1

==== Term 1
Definition 1

==== Term 2
Definition 2

[.grouping]
=== Term grouping 2 (subclause 2)
Paragraph 2

==== Term 3
Definition 3
--


=== Combined terms and definitions

Expand Down

0 comments on commit b78f453

Please sign in to comment.