Skip to content

Commit

Permalink
feat: update requirements sample rendering
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Aug 24, 2024
1 parent 9c95c1b commit 9a7c60f
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
14 changes: 9 additions & 5 deletions author/topics/blocks/requirements-modspec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -344,9 +344,12 @@ requirement class that is being tested.
// * `model` (optional when using Metanorma OGC). Type of model. The value of `ogc`
// means using OGC ModSpec models.

`class`:: Used to add a new category of provisions, which is labelled and numbered separately to
requirements, recommendations and permissions [added in https://github.com/metanorma/mn-requirements/releases/tag/v0.4.1].
`class`::
Declares a custom category of provisions labelled and numbered separately to
"requirements", "recommendations" and
"permissions" [added in https://github.com/metanorma/mn-requirements/releases/tag/v0.4.1].
+
.Rendering of a custom category called "Provision"
[example]
====
[source,adoc]
Expand All @@ -371,14 +374,15 @@ class:: Provision
Rendered as:
____
*Requirement 1*
*Provision 1*
*Requirement 2*
*Requirement 1*
*Provision 2*
____
====


`id`::
+
--
Expand Down
13 changes: 8 additions & 5 deletions author/topics/blocks/requirements-mrr.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,12 @@ inherit:[<<ref1>>]
----
====

`class`:: Used to add a new category of provisions, which is labelled and numbered separately to
requirements, recommendations and permissions [added in https://github.com/metanorma/mn-requirements/releases/tag/v0.4.1].
`class`::
Declares a custom category of provisions labelled and numbered separately to
"requirements", "recommendations" and
"permissions" [added in https://github.com/metanorma/mn-requirements/releases/tag/v0.4.1].
+
.Rendering of a custom category called "Provision"
[example]
====
[source,adoc]
Expand All @@ -191,11 +194,11 @@ class:: Provision
Rendered as:
____
*Requirement 1*
*Provision 1*
*Requirement 2*
*Requirement 1*
*Provision 2*
____
====

Expand Down

0 comments on commit 9a7c60f

Please sign in to comment.