README.adoc in metanorma-cli-1.3.7.3 vs README.adoc in metanorma-cli-1.3.8
- old
+ new
@@ -181,9 +181,55 @@
This should compile any valid document, but if there are some issues then it
will also print those out in the terminal. Currently, the supported flavors
are `ietf`, `iso`, `gb`, `csd`, `csand`, `m3d` and `rsd`.
+=== Compile a document collection (`metanorma collection`)
+
+(_This is placeholder for more complete documentation later._)
+
+This functionality compiles collections of Metanorma documents. It compiles
+the individual documents comprising the collection; then it compiles a document
+acting as a container for those collections. See
+https://github.com/metanorma/metanorma/wiki/Metanorma-collections[],
+https://github.com/metanorma/metanorma-cli/blob/master/spec/fixtures/collection1.yml[]
+
+The file argument to the collection command is a Metanorma Collections YAML file,
+which contains:
+
+* Directives on how the collection should be generated
+* Metadata about the collection
+* A manifest listing the documents contained in the collection, in nested hierarchy
+* Content to put at the beginning of the collection container
+* Content to put at the endeginning of the collection container
+
+Documents within a collection
+may cross-reference each other using the syntax
+`* [[[myanchor,repo:(current-metanorma-collection/mydoc)]]]`,
+as proposed in https://github.com/metanorma/metanorma/issues/57, where
+`mydoc` is be the value of docref/identifier corresponding to the target document,
+as set in the YAML manifest.
+
+The output directory will contain:
+
+* The documents referenced in the manifest, with any citations of other documents in the collection
+resolved, in the output formats requested
+* If `xml` or `presentation` are requested as formats, a concatenated `collection.xml` and/or
+`collection.presentation.xml` file, containing all the documents in the collection.
+* If `html` is requested as a format, an `index.html` HTML page, populated from a provided
+Liquid template coverpage, and linking to all the documents in the manifest.
+
+
+[source]
+----
+Usage:
+ metanorma collection FILENAME [..options]
+
+Options:
+ -x, [--extensions=EXTENSIONS] # Type of extension to generate
+ -w, [--output-folder=FOLDER] # Folder to generate collection in
+ -c, [--coverpage=COVERPAGE] # Cover page as Liquid template for collection (currently HTML only)
+----
=== List supported output formats (`metanorma list-extensions`)
Need to know what output formats are supported for a given flavor?
We've got you covered.