README.adoc in metanorma-nist-0.2.6 vs README.adoc in metanorma-nist-0.2.7
- old
+ new
@@ -1,14 +1,14 @@
= metanorma-nist: Metanorma processor for the NIST SP 800 document classes
image:https://img.shields.io/gem/v/metanorma-nist.svg["Gem Version", link="https://rubygems.org/gems/metanorma-nist"]
-image:https://img.shields.io/travis/metanorma/metanorma-nist/master.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-nist"]
-image:https://ci.appveyor.com/api/projects/status/c5e8e3qtn689a5h0?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/metanorma-nist"]
+image:https://travis-ci.com/metanorma/metanorma-nist.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-nist"]
+image:https://ci.appveyor.com/api/projects/status/vflfr333319tofbi?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma-nist"]
image:https://codeclimate.com/github/metanorma/metanorma-nist/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-nist"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-nist.svg["Pull Requests", link="https://github.com/metanorma/metanorma-nist/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-nist/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-nist/releases"]
-WARNING: This gem is still under development.
-
== Functionality
This gem processes Metanorma documents into the NIST document class.
It provides the following functions:
@@ -549,15 +549,16 @@
Metanorma. They are appendices in NIST, and any appendix in NIST Metanorma with the
title "Glossary" or "Terminology" is treated as a Terms & Definitions section.
=== Pseudocode
-Pseudocode shall be marked up as an example, with role attribute `[.pseudocode]`:
+Pseudocode shall be marked up as an example, with style attribute `[pseudocode]`
+(implemented as a macro):
[source,asciidoctor]
----
-[.pseudocode]
+[pseudocode]
====
_Input: S=(s1,...,sL)_
_Output:_ Shuffled _S=(s1,...,sL)_
@@ -565,10 +566,23 @@
.. Generate a random integer _j_ such that 1<=_j_<=_i_
.. Swap _s~j~_ and _s~i~_
====
----
-They will be rendered as figures, and included in the count of figures of the document.
+Pseudocode will respect initial indentation in paragraph lines, with line breaks:
+
+[source,asciidoctor]
+----
+[pseudocode]
+====
+ *def* __increment__(x) +
+ x = x + 1 +
+ *enddef*
+====
+----
+
+They will be rendered as figures, but are not included in the count of figures of the document.
+(If they must be included, embed them within another figure.)
=== Recommendations, requirements, and permissions
Recommendations, requirements, and permissions shall be marked up as examples,
with style attribute "recommendation", "requirement", "permission":