Permalink
Browse files

Updated documentation for 0.5

  • Loading branch information...
1 parent 70e3ac2 commit 8f6b0745d5c2aa71391d7c702a74abdf618a4c87 @rvolz committed Oct 19, 2011
Showing with 41 additions and 19 deletions.
  1. +10 −0 History.txt
  2. +30 −18 README.md
  3. +1 −1 version.txt
View
@@ -1,3 +1,13 @@
+== 0.5.0 / 2011-10-19
+
+* A file can now manage multiple inclusions and/or references.
+* The YAML and JSON output contains now two sections, hierarchy and details, just like the terminal output.
+* The details contain new fields for multiple references: includes, included_by and references, referenced_by
+
+* Minor changes
+** Removed JSON dependency. It is used when available.
+** Color support is now optional on Windows
+
== 0.4.0 / 2011-10-14
* Added JSON and YAML output formats
View
@@ -29,29 +29,41 @@ If you don't like the screen output or want to integrate docbook_file into a cer
docbook_files --outputformat=yaml myproject.xml
-The result is printed to STDOUT. The structure returned is equivalent to the normal terminal output, except that you always get the details. The structure returned is an array, where each entry contains the following key-value pairs:
-
- * type - file type (main, inc-luded, or ref-erenced)
- * name - file name
- * full_name - path relative to the main file
- * level - the level in the file hierarchy, starting with 0
- * parent - parent file that included or referenced this file
- * status - error status: 0 = ok, 1 = file not found, 2 = processing error (see error_string)
- * error_string - contains an error message, if status > 0
- * namespace - XML namespace, if applicable
- * version - XML version attribute, of applicable
- * docbook - true for DocBook 5 files, else false
- * tag - start tag for XML files (chapter, book, article ...)
- * ts - file modification time
- * size - fiel size in byte
- * checksum - SHA1 checksum
- * mime - MIME type
-
+The result is printed to STDOUT. The structure returned is equivalent to the normal terminal output, except that you always get the details.
+
+ * hierarchy - an array of entries for each step in the file hierarchy
+ ** type - file type (main, inc-luded, or ref-erenced)
+ ** name - file name
+ ** path - path relative to the main file
+ ** status - error status: 0 = ok, 1 = file not found, 2 = processing error (see error_string)
+ ** size - file size in bytes
+ ** level - the level in the file hierarchy, starting with 0
+
+ * details - an array of entries for each file used in the hierarchy
+ ** name - file name
+ ** path - path relative to the main file
+ ** status - error status: 0 = ok, 1 = file not found, 2 = processing error (see error_string)
+ ** error_string - contains an error message, if status > 0
+ ** namespace - XML namespace, if applicable
+ ** version - XML version attribute, if applicable
+ ** docbook - true for DocBook 5 files, else false
+ ** tag - start tag for XML files (chapter, book, article ...)
+ ** ts - file modification time
+ ** size - file size in byte
+ ** checksum - SHA1 checksum
+ ** mime - MIME type
+ ** includes - files that are included by this file, an array of file names
+ ** included_by - files that include this file, an array of file names
+ ** references - files that are referenced by this file, an array of file names
+ ** referenced_by - files that reference this file, an array of file names
+
Requirements
------------
* libxml2
+* json (optional, if you want JSON output on Ruby 1.8)
+* win32console (optional, if you want color support on MS Windows)
Install
-------
View
@@ -1 +1 @@
-0.4.0
+0.5.0

0 comments on commit 8f6b074

Please sign in to comment.