[daisy-pipeline.wiki] push by - Edited wiki page DTBookValidator through web user interface. on 2013-07-25 19:04 GMT

[daisy-p...@googlecode.com]

Revision: f10f708d2fb8
Branch: default
Author: marisa....@gmail.com
Date: Thu Jul 25 12:04:26 2013
Log: Edited wiki page DTBookValidator through web user interface.
http://code.google.com/p/daisy-pipeline/source/detail?r=f10f708d2fb8&repo=wiki

Modified:
/DTBookValidator.wiki

=======================================
--- /DTBookValidator.wiki Fri Apr 19 14:33:51 2013
+++ /DTBookValidator.wiki Thu Jul 25 12:04:26 2013
@@ -13,10 +13,11 @@

= Input =

- * `source` DTBook file
+There is no input port. See the `input-dtbook` option.

= Options =

+ * `input-dtbook` Required path to the input DTBook file. Formatted as
file:/folder/dtbook.xml.
* `mathml-version` Options are '2.0' or '3.0' (default).
* `check-images` Whether or not to check that referenced images exist on
disk. Options are 'true' or 'false' (default).
* `output-dir` If set, the reports are saved in this directory as
`dtbook-validation-report.xml` and `dtbook-validation-report.xhtml`
@@ -26,13 +27,47 @@
* `result` A copy of the input document
* `report` XML-formatted validation report (see [ValidationReportXML])
* `html-report` HTML-formatted validation report
+ * `validation-status` An XML document describing, briefly, whether the
validation was successful (see [ValidationStatusXML])
+
+= Sample usage =
+
+This section shows how to use the DTBook Validator via the Pipeline 2
command line interface.
+
+Run the script like this:
+{{{
+➜ ./dp2 dtbook-validator --x-input-dtbook file:/path/to/book/dtbook.xml
--o-result /tmp/t1 --o-report /tmp/t2 --o-html-report /tmp/t3
--o-validation-status /tmp/t4 --x-output-dir /tmp/dpout
+}}}
+
+Make sure the directory `/tmp/dpout` already exists.
+
+Also note the special syntax for the input file option, which has changed
in this update (July 2013):
+{{{
+--x-input-dtbook file:/path/to/book/dtbook.xml
+}}}
+
+When execution is complete, you will see these files in the output
directory that you specified:
+{{{
+dtbook-validation-report.xml
+dtbook-validation-report.xhtml
+}}}
+
+
+Note: If instead of using the `--x-output-dir` option to put all output in
one directory, you would rather specify a file path for each file, then
just use the output parameters (prefixed by `--o`). Above they are shown as
temp files (e.g. `/tmp/t1`) but they could just as easily store their
output anywhere (e.g. `/path/to/output/my-report.xml`).
+
+They are as follows
+
+== `dtbook-validation-report.xml` ==
+
+Raw validation output from DTBook validation. See [ValidationReportXML]
for details on the file format.
+
+== `dtbook-validation-report.xhtml` ==
+
+XHTML file containing a summary of all validation errors for the DTBook
file.

= Development notes =

MathML 3 element set can follow the same rules as MathML 2. Here is an
analysis: [ComparisonOfMathMLContentElements]

-Schematron rules apply to DTBook 2005 versions. *Need to check regarding
older versions.*
-
== Challenges ==

* Detecting the MathML version. At the start, this will be set by the
user as a parameter.