documentation

Author: Robert Righter

README.md

@@ -33,85 +33,75 @@ Node-xml provides a SAX2 parser interface that can take a string, file.
 
 	parser.parseString(string)
 
-* Parse an in memory string
+Parse an in memory string
 * return: boolean. true if no errors, false otherwise
 * Arguments
-+ string - a string representing the document to parse
-
+	* string - a string representing the document to parse
 
 	parser.parseFile(filename)
 
-*Parse a file
-*return: boolean. true if no errors, false otherwise
-*Arguments
-+filename - a string representing the file to be parsed
-
-Callbacks
-
-parser.onStartDocument(function() {})
-
-    Called at the start of a document
-
-parse.onEndDocument(function() {})
-
-    Called at the end of the document parse
-
-parser.onStartElementNS(function(elem, attrs, prefix, uri, namespaces) {})
-
-    Called on an open element tag
-    Arguments
-
-        * elem - a string representing the element name
-        * attrs - an array of arrays: [[key, value], [key, value]]
-        * prefix - a string representing the namespace prefix of the element
-        * uri - the namespace URI of the element
-        * namespaces - an array of arrays: [[prefix, uri], [prefix, uri]]
-
-parser.onEndElementNS(function(elem, prefix, uri) {})
+Parse a file
+* return: boolean. true if no errors, false otherwise
+* Arguments
+	* filename - a string representing the file to be parsed
 
-    Called at the close of an element
-    Arguments
+#Callbacks#
 
-        * elem - a string representing the element name
-        * prefix - a string representing the namespace prefix of the element
-        * uri - the namespace URI of the element
+	parser.onStartDocument(function() {})
 
-parser.onCharacters(function(chars) {})
+Called at the start of a document
 
-    Called when a set of content characters is encountered
-    Arguments
+	parse.onEndDocument(function() {})
 
-        * chars - a string of characters
+ Called at the end of the document parse
 
-parser.onCdata(function(cdata) {})
+	parser.onStartElementNS(function(elem, attrs, prefix, uri, namespaces) {})
 
-    Called when a CDATA is encountered
-    Arguments
+Called on an open element tag
+* Arguments
+	* elem - a string representing the element name
+	* attrs - an array of arrays: [[key, value], [key, value]]
+	* prefix - a string representing the namespace prefix of the element
+	* uri - the namespace URI of the element
+	* namespaces - an array of arrays: [[prefix, uri], [prefix, uri]]
 
-        * cdata - a string representing the CDATA
+	parser.onEndElementNS(function(elem, prefix, uri) {})
 
-parser.onComment(function(msg) {})
+Called at the close of an element
+* Arguments
+	* elem - a string representing the element name
+    * prefix - a string representing the namespace prefix of the element
+    * uri - the namespace URI of the element
 
-    Called when a comment is encountered
-    Arguments
+	parser.onCharacters(function(chars) {})
 
-        * msg - a string representing the comment
+Called when a set of content characters is encountered
+* Arguments
+	* chars - a string of characters
 
-parser.onWarning(function(msg) {})
+	parser.onCdata(function(cdata) {})
 
-    Called when a warning is encountered
-    Arguments
+Called when a CDATA is encountered
+* Arguments
+	* cdata - a string representing the CDATA
 
-        * msg - a string representing the warning message
+	parser.onComment(function(msg) {})
 
-parser.onError(function(msg) {})
+Called when a comment is encountered
+	* Arguments
+		* msg - a string representing the comment
 
-    Called when an error is encountered
-    Arguments
+		parser.onWarning(function(msg) {})
 
-        * msg - a string representing the error message
+Called when a warning is encountered
+   * Arguments
+		* msg - a string representing the warning message
 
+		parser.onError(function(msg) {})
 
+Called when an error is encountered
+   * Arguments
+		* msg - a string representing the error message
 
 
 EXAMPLE USAGE