[daisy-pipeline.wiki] push by - Edited wiki page NimasFilesetValidator through web user interface. on 2013-07-06 21:33 GMT

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

Revision: 60fbacc8abb5
Branch: default
Author: marisa....@gmail.com
Date: Sat Jul 6 14:33:34 2013
Log: Edited wiki page NimasFilesetValidator through web user interface.
http://code.google.com/p/daisy-pipeline/source/detail?r=60fbacc8abb5&repo=wiki

Modified:
/NimasFilesetValidator.wiki

=======================================
--- /NimasFilesetValidator.wiki Tue Jun 25 11:37:29 2013
+++ /NimasFilesetValidator.wiki Sat Jul 6 14:33:34 2013
@@ -1,20 +1,24 @@
#summary Overview of the NIMAS fileset validation module

+*The details below are for the upcoming July 2013 release.*
+
= Input =

- * `source` Package document (`*.opf`)
+There is no input port. See the `input-opf` option.

= Options =

+ * `input-opf` Required path to the input OPF file. Formatted as
file:/folder/package.opf.
* `mathml-version` Options are '2.0' or '3.0' (default).
* `check-images` Whether or not to check that images referenced by DTBook
file(s) 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`
+ * `output-dir` If set, the reports are saved in this directory.

= Output =

* `result` A single XHTML-formatted validation report representing all
files
* `package-doc-validation-report` An XML-formatted validation report for
the package document (see [ValidationReportXML])
* `dtbook-validation-report` A sequence of XML-formatted validation
reports for the DTBook document(s) (see [ValidationReportXML])
+ * `validation-status` An XML document describing, briefly, whether the
validation was successful (see [ValidationStatusXML])

= Sample usage =

@@ -22,11 +26,15 @@

Run the script like this:
{{{
-➜ ./dp2 nimas-fileset-validator --i-source /book/my-package-file.opf
--x-check-images true --x-output-dir /pipeline-output --o-result /tmp/t1 -
--o-package-doc-validation-report /tmp/t2 --o-dtbook-validation-report
/tmp/t3
+➜ ./dp2 nimas-fileset-validator --x-input-opf
file:/path/to/book/package.opf --x-output-dir /tmp/dpout
--o-package-doc-validation-report /tmp/t1 --o-dtbook-validation-report
/tmp/t2 --o-result /tmp/t3 --o-validation-status /tmp/t4
}}}

-Make sure the directory `/pipeline-output` already exists.
+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-opf file:/path/to/book/package.opf
+}}}

When execution is complete, you will see these files in the output
directory that you specified:
{{{
@@ -36,7 +44,7 @@
}}}


-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 but they could just as easily store their output anywhere.
+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