xml: draft all but 3 most complex subcommands

pages/common/xml-canonic.md

@@ -1,8 +1,20 @@
 # xml-canonic
 
-> XMLStarlet toolkit: Make XML documents canonical.
+> Make XML documents canonical.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- Make an XML document canonical, including comments (default):
+
+`xml canonic --with-comments {{path/to/input.xml|URI}} >{{path/to/output.xml}}`
+
+- Make an XML document canonical, without comments:
+
+`xml canonic --without-comments {{path/to/input.xml|URI}} >{{path/to/output.xml}}`
+
+- Exclusive XML canonicalization, using an XPATH from a file:
+
+`xml canonic --exc-with-comments {{path/to/input.xml|URI}} {{path/to/c14n.xpath}}`
+
 - Display help for `canonic` subcommand:
 
 `xml canonic --help`

pages/common/xml-depyx.md

@@ -1,8 +1,16 @@
 # xml-depyx
 
-> XMLStarlet toolkit: Convert a PYX document to XML format. (ESIS - ISO 8879).
+> Convert a PYX (ESIS - ISO 8879) document to XML format.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- Convert a PYX (ESIS - ISO 8879) document to XML format:
+
+`xml depyx {{path/to/input.pyx|URI}} >{{path/to/output.xml}}`
+
+- Convert a PYX document from standard input to XML format:
+
+`cat {{path/to/input.pyx}} | xml depyx >{{path/to/output.xml}}`
+
 - Display help for `depyx` subcommand:
 
 `xml depyx --help`

pages/common/xml-edit.md

@@ -1,8 +1,28 @@
 # xml-edit
 
-> XMLStarlet toolkit: Edit an XML document.
+> Edit an XML document.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- TBD:
+
+`xml edit`
+
+- TBD:
+
+`xml edit`
+
+- TBD:
+
+`xml edit`
+
+- TBD:
+
+`xml edit`
+
+- TBD:
+
+`xml edit`
+
 - Display help for `edit` subcommand:
 
 `xml edit --help`

pages/common/xml-elements.md

@@ -1,8 +1,28 @@
 # xml-elements
 
-> XMLStarlet toolkit: Diaplay element structure of an XML document.
+> Extract elements and structure of an XML document.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- Extract elements of an XML document (as XPATH expressions):
+
+`xml elements {{path/to/input.xml|URI}} >{{path/to/elements}}`
+
+- Extract elements and attributes of an XML document:
+
+`xml elements -a {{path/to/input.xml|URI}} >{{path/to/elements}}`
+
+- Extract elements, attributes, and their values:
+
+`xml elements -v {{path/to/input.xml|URI}} >{{path/to/elements}}`
+
+- Print sorted unique elements of an XML document (to see structure):
+
+`xml elements -u {{path/to/input.xml|URI}}`
+
+- Print sorted unique elements up to a depth of 3:
+
+`xml elements -d{{3}} {{path/to/input.xml|URI}}`
+
 - Display help for `elements` subcommand:
 
 `xml elements --help`

pages/common/xml-escape.md

@@ -1,6 +1,6 @@
 # xml-escape
 
-> XMLStarlet toolkit: Escape special XML characters.
+> Escape special XML characters.
 > More information: <http://xmlstar.sourceforge.net/doc/xmlstarlet.pdf>.
 
 - Escape special XML characters in a string:

pages/common/xml-format.md

@@ -1,8 +1,28 @@
 # xml-format
 
-> XMLStarlet toolkit: Format an XML document.
+> Format an XML document.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- Format an XML document, indenting with tabs:
+
+`xml format --indent-tab {{path/to/input.xml|URI}} >{{path/to/output.xml}}`
+
+- Format an HTML document, indenting with 4 spaces:
+
+`xml format --html --indent-spaces {{4}} {{path/to/input.html|URI}} >{{path/to/output.html}}`
+
+- Recover parsable parts of a malformed XML document, without indenting:
+
+`xml format --recover --noindent {{path/to/malformed.xml|URI}} >{{path/to/recovered.xml}}`
+
+- Format an XML document from standard input, removing the DOCTYPE declaration:
+
+`cat {{path\to\input.xml}} | xml format --dropdtd >{{path/to/output.xml}}`
+
+- Format an XML document, omitting the XML declaration:
+
+`xml format --omit-decl {{path\to\input.xml|URI}} >{{path/to/output.xml}}`
+
 - Display help for `format` subcommand:
 
 `xml format --help`

pages/common/xml-list.md

@@ -1,8 +1,16 @@
 # xml-list
 
-> XMLStarlet toolkit: List a directory as XML.
+> List a directory as XML.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- List the current directory to an XML file:
+
+`xml list >{{path/to/dir_list.xml}}`
+
+- List the specified directory to an XML file:
+
+`xml list {{path/to/directory}} >{{path/to/dir_list.xml}}`
+
 - Display help for `list` subcommand:
 
 `xml list --help`

pages/common/xml-pyx.md

@@ -1,8 +1,16 @@
 # xml-pyx
 
-> XMLStarlet toolkit: Convert XML documents to PYX format. (ESIS - ISO 8879).
+> Convert an XML document to PYX (ESIS - ISO 8879) format.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- Convert an XML document to PYX format:
+
+`xml pyx {{path/to/input.xml|URI}} >{{path/to/output.pyx}}`
+
+- Convert an XML document from standard input to PYX format:
+
+`cat {{path/to/input.xml}} | xml pyx >{{path/to/output.pyx}}`
+
 - Display help for `pyx` subcommand:
 
 `xml pyx --help`

pages/common/xml-select.md

@@ -1,8 +1,28 @@
 # xml-select
 
-> XMLStarlet toolkit: Select from XML documents.
+> Select from XML documents using XPATH.
 > More information: <http://xmlstar.sourceforge.net/doc/xmlstarlet.pdft>.
 
+- TBD:
+
+`xml select`
+
+- TBD:
+
+`xml select`
+
+- TBD:
+
+`xml select`
+
+- TBD:
+
+`xml select`
+
+- TBD:
+
+`xml select`
+
 - Display help for `select` subcommand:
 
 `xml select --help`

pages/common/xml-transform.md

@@ -1,8 +1,28 @@
 # xml-transform
 
-> XMLStarlet toolkit: Transform XML documents using XSLT.
+> Transform XML documents using XSLT.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
+- TBD:
+
+`xml transform`
+
+- TBD:
+
+`xml transform`
+
+- TBD:
+
+`xml transform`
+
+- TBD:
+
+`xml transform`
+
+- TBD:
+
+`xml transform`
+
 - Display help for `transform` subcommand:
 
 `xml transform --help`

pages/common/xml-unescape.md

@@ -1,6 +1,6 @@
-# xml-edit
+# xml-unescape
 
-> XMLStarlet toolkit: Un-escape special XML characters.
+> Un-escape special XML characters.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
 - Unescape special XML characters from a string:

pages/common/xml-validate.md

@@ -1,6 +1,6 @@
 # xml-validate
 
-> XMLStarlet toolkit: Validate XML documents.
+> Validate XML documents.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
 - Validate XML document for well-formedness only (default):

pages/common/xml.md

@@ -1,7 +1,7 @@
 # xml
 
-> XMLStarlet toolkit: Query, edit, check, and transform XML documents.
-> Subcommands: `canonic`, `edit`, `elements`, `escape`, `format`, `list`, `pyx`, `p2x`, `select`, `transform`, `unescape`, or `validate`.
+> XMLStarlet Toolkit: Query, edit, check, convert and transform XML documents.
+> Subcommands: `canonic`, `edit`, `elements`, `escape`, `unescape`, `format`, `list`, `pyx`, `depyx`, `select`, `transform`, or `validate`.
 > More information: <http://xmlstar.sourceforge.net/docs.php>.
 
 - Execute a subcommand with input from a file or URI and using standard output: