Document w/ documentary

README.md

@@ -5,6 +5,28 @@ Ever had the urge to parse XML? And wanted to access the data in some sane,
 easy way? Don't want to compile a C parser, for whatever reason? Then xml2js is
 what you're looking for!
 
+Table of Contents
+=================
+
+- [node-xml2js](#node-xml2js)
+- [Table of Contents](#table-of-contents)
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+ * [Shoot-and-forget usage](#shoot-and-forget-usage)
+ * [Simple as pie usage](#simple-as-pie-usage)
+ * [Parsing multiple files](#parsing-multiple-files)
+ * [So you wanna some JSON?](#so-you-wanna-some-json)
+ * [Displaying results](#displaying-results)
+ * [XML builder usage](#xml-builder-usage)
+ * [Adding xmlns attributes](#adding-xmlns-attributes)
+ * [Processing attribute, tag names and values](#processing-attribute-tag-names-and-values)
+- [Options](#options)
+ * [Options for the `Builder` class](#options-for-the-builder-class)
+- [Updating to new version](#updating-to-new-version)
+- [Running tests, development](#running-tests-development)
+- [Getting support](#getting-support)
+
 Description
 ===========
 
@@ -44,6 +66,10 @@ parseString(xml, function (err, result) {
 });
 ```
 
+```js
+{ root: 'Hello xml2js!' }
+```
+
 Can't get easier than this, right? This works starting with `xml2js` 0.2.3.
 With CoffeeScript it looks like this:
 
@@ -81,6 +107,11 @@ fs.readFile(__dirname + '/foo.xml', function(err, data) {
 });
 ```
 
+```js
+{ root: 'Hello xml2js!' }
+Done
+```
+
 Look ma, no event listeners!
 
 You can also use `xml2js` from
@@ -176,16 +207,17 @@ You can generate XML that declares XML namespace prefix / URI pairs with xmlns a
 Example declaring a default namespace on the root element:
 
 ```javascript
-let obj = { 
+let obj = {
  Foo: {
  $: {
  "xmlns": "http://foo.com"
- } 
+ }
  }
-}; 
+};
 ```
 Result of `buildObject(obj)`:
 ```xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Foo xmlns="http://foo.com"/>
 ```
 Example declaring non-default namespaces on non-root elements:
@@ -205,12 +237,12 @@ let obj = {
 ```
 Result of `buildObject(obj)`:
 ```xml
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <foo:Foo xmlns:foo="http://foo.com">
  <bar:Bar xmlns:bar="http://bar.com"/>
 </foo:Foo>
 ```
 
-
 Processing attribute, tag names and values
 ------------------------------------------
 

documentary/1-description.md

@@ -0,0 +1,10 @@
+
+Description
+===========
+
+Simple XML to JavaScript object converter. It supports bi-directional conversion.
+Uses [sax-js](https://github.com/isaacs/sax-js/) and
+[xmlbuilder-js](https://github.com/oozcitak/xmlbuilder-js/).
+
+Note: If you're looking for a full DOM parser, you probably want
+[JSDom](https://github.com/tmpvar/jsdom).

documentary/2-installation.md

@@ -0,0 +1,9 @@
+
+Installation
+============
+
+Simplest way to install `xml2js` is to use [npm](http://npmjs.org), just `npm
+install xml2js` which will download xml2js and all dependencies.
+
+xml2js is also available via [Bower](http://bower.io/), just `bower install
+xml2js` which will download xml2js and all dependencies.

documentary/3-usage/1-shoot-and-forget.md

@@ -0,0 +1,23 @@
+
+Shoot-and-forget usage
+----------------------
+
+You want to parse XML as simple and easy as possible? It's dangerous to go
+alone, take this:
+
+%EXAMPLE: example/index.js, .. => xml2js, javascript%
+
+%FORK-js example%
+
+Can't get easier than this, right? This works starting with `xml2js` 0.2.3.
+With CoffeeScript it looks like this:
+
+%EXAMPLE: example/index.coffee, .. => xml2js, coffeescript%
+
+If you need some special options, fear not, `xml2js` supports a number of
+options (see below), you can specify these as second argument:
+
+```javascript
+parseString(xml, {trim: true}, function (err, result) {
+});
+```

documentary/3-usage/2-simple-as-pie.md

@@ -0,0 +1,24 @@
+
+Simple as pie usage
+-------------------
+
+That's right, if you have been using xml-simple or a home-grown
+wrapper, this was added in 0.1.11 just for you:
+
+%EXAMPLE: example/simple.js, .. => xml2js, javascript%
+
+%FORK-js example/simple%
+
+Look ma, no event listeners!
+
+You can also use `xml2js` from
+[CoffeeScript](https://github.com/jashkenas/coffeescript), further reducing
+the clutter:
+
+%EXAMPLE: example/simple.coffee, coffeescript%
+
+But what happens if you forget the `new` keyword to create a new `Parser`? In
+the middle of a nightly coding session, it might get lost, after all. Worry
+not, we got you covered! Starting with 0.2.8 you can also leave it out, in
+which case `xml2js` will helpfully add it for you, no bad surprises and
+inexplicable bugs!

documentary/3-usage/3-multiple.md

@@ -0,0 +1,11 @@
+
+Parsing multiple files
+----------------------
+
+If you want to parse multiple files, you have multiple possibilities:
+
+ * You can create one `xml2js.Parser` per file. That's the recommended one
+ and is promised to always *just work*.
+ * You can call `reset()` on your parser object.
+ * You can hope everything goes well anyway. This behaviour is not
+ guaranteed work always, if ever. Use option #1 if possible. Thanks!

documentary/3-usage/4-json.md

@@ -0,0 +1,7 @@
+
+So you wanna some JSON?
+-----------------------
+
+Just wrap the `result` object in a call to `JSON.stringify` like this
+`JSON.stringify(result)`. You get a string containing the JSON representation
+of the parsed object that you can feed to JSON-hungry consumers.

documentary/3-usage/5-displaying.md

@@ -0,0 +1,18 @@
+
+Displaying results
+------------------
+
+You might wonder why, using `console.dir` or `console.log` the output at some
+level is only `[Object]`. Don't worry, this is not because `xml2js` got lazy.
+That's because Node uses `util.inspect` to convert the object into strings and
+that function stops after `depth=2` which is a bit low for most XML.
+
+To display the whole deal, you can use `console.log(util.inspect(result, false,
+null))`, which displays the whole result.
+
+So much for that, but what if you use
+[eyes](https://github.com/cloudhead/eyes.js) for nice colored output and it
+truncates the output with `…`? Don't fear, there's also a solution for that,
+you just need to increase the `maxLength` limit by creating a custom inspector
+`var inspect = require('eyes').inspector({maxLength: false})` and then you can
+easily `inspect(result)`.

documentary/3-usage/6-xml.md

@@ -0,0 +1,29 @@
+
+XML builder usage
+-----------------
+
+Since 0.4.0, objects can be also be used to build XML:
+
+%EXAMPLE: example/xml.js, .. => xml2js, javascript%
+
+At the moment, a one to one bi-directional conversion is guaranteed only for
+default configuration, except for `attrkey`, `charkey` and `explicitArray` options
+you can redefine to your taste. Writing CDATA is supported via setting the `cdata`
+option to `true`.
+
+To specify attributes:
+%EXAMPLE: example/xml-attributes.js, .. => xml2js, javascript%
+
+### Adding xmlns attributes
+
+You can generate XML that declares XML namespace prefix / URI pairs with xmlns attributes.
+
+Example declaring a default namespace on the root element:
+
+%EXAMPLE: example/xml-namespace.js, .. => xml2js, javascript%
+Result of `buildObject(obj)`:
+%FORK-xml example/xml-namespace%
+Example declaring non-default namespaces on non-root elements:
+%EXAMPLE: example/xml-nondefault.js, .. => xml2js, javascript%
+Result of `buildObject(obj)`:
+%FORK-xml example/xml-nondefault%

documentary/3-usage/7-processing.md

@@ -0,0 +1,60 @@
+
+Processing attribute, tag names and values
+------------------------------------------
+
+Since 0.4.1 you can optionally provide the parser with attribute name and tag name processors as well as element value processors (Since 0.4.14, you can also optionally provide the parser with attribute value processors):
+
+```javascript
+
+function nameToUpperCase(name){
+ return name.toUpperCase();
+}
+
+//transform all attribute and tag names and values to uppercase
+parseString(xml, {
+ tagNameProcessors: [nameToUpperCase],
+ attrNameProcessors: [nameToUpperCase],
+ valueProcessors: [nameToUpperCase],
+ attrValueProcessors: [nameToUpperCase]},
+ function (err, result) {
+ // processed data
+});
+```
+
+The `tagNameProcessors` and `attrNameProcessors` options
+accept an `Array` of functions with the following signature:
+
+```javascript
+function (name){
+ //do something with `name`
+ return name
+}
+```
+
+The `attrValueProcessors` and `valueProcessors` options
+accept an `Array` of functions with the following signature:
+
+```javascript
+function (value, name) {
+ //`name` will be the node name or attribute name
+ //do something with `value`, (optionally) dependent on the node/attr name
+ return value
+}
+```
+
+Some processors are provided out-of-the-box and can be found in `lib/processors.js`:
+
+- `normalize`: transforms the name to lowercase.
+(Automatically used when `options.normalize` is set to `true`)
+
+- `firstCharLowerCase`: transforms the first character to lower case.
+E.g. 'MyTagName' becomes 'myTagName'
+
+- `stripPrefix`: strips the xml namespace prefix. E.g `<foo:Bar/>` will become 'Bar'.
+(N.B.: the `xmlns` prefix is NOT stripped.)
+
+- `parseNumbers`: parses integer-like strings as integers and float-like strings as floats
+E.g. "0" becomes 0 and "15.56" becomes 15.56
+
+- `parseBooleans`: parses boolean-like strings to booleans
+E.g. "true" becomes true and "False" becomes false

documentary/3-usage/index.md

@@ -0,0 +1,6 @@
+
+Usage
+=====
+
+No extensive tutorials required because you are a smart developer! The task of
+parsing XML should be an easy one, so let's make it so! Here's some examples.

documentary/4-options/1-builder.md

@@ -0,0 +1,32 @@
+
+Options for the `Builder` class
+-------------------------------
+These options are specified by ``new Builder({optionName: value})``.
+Possible options are:
+
+ * `attrkey` (default: `$`): Prefix that is used to access the attributes.
+ Version 0.1 default was `@`.
+ * `charkey` (default: `_`): Prefix that is used to access the character
+ content. Version 0.1 default was `#`.
+ * `rootName` (default `root` or the root key name): root element name to be used in case
+ `explicitRoot` is `false` or to override the root element name.
+ * `renderOpts` (default `{ 'pretty': true, 'indent': ' ', 'newline': '\n' }`):
+ Rendering options for xmlbuilder-js.
+ * pretty: prettify generated XML
+ * indent: whitespace for indentation (only when pretty)
+ * newline: newline char (only when pretty)
+ * `xmldec` (default `{ 'version': '1.0', 'encoding': 'UTF-8', 'standalone': true }`:
+ XML declaration attributes.
+ * `xmldec.version` A version number string, e.g. 1.0
+ * `xmldec.encoding` Encoding declaration, e.g. UTF-8
+ * `xmldec.standalone` standalone document declaration: true or false
+ * `doctype` (default `null`): optional DTD. Eg. `{'ext': 'hello.dtd'}`
+ * `headless` (default: `false`): omit the XML header. Added in 0.4.3.
+ * `allowSurrogateChars` (default: `false`): allows using characters from the Unicode
+ surrogate blocks.
+ * `cdata` (default: `false`): wrap text nodes in `<![CDATA[ ... ]]>` instead of
+ escaping when necessary. Does not add `<![CDATA[ ... ]]>` if it is not required.
+ Added in 0.4.5.
+
+`renderOpts`, `xmldec`,`doctype` and `headless` pass through to
+[xmlbuilder-js](https://github.com/oozcitak/xmlbuilder-js).