Daisy documentation
 PreviousHomeNext 
7.3 Export toolBook Index7.3.3 Using the export tool programatically

7.3.2 Configuration

The behaviour of the export tool can be influenced by a number of options. In addition, the documents and the schema can be altered upon export.

The configurations are done in an XML file which is supplied via the -o argument. To see an example of the such a file, which also shows the default configuration, use the -d argument:

daisy-export -d > exportoptions.xml

7.3.2.1 Options

Option

Description

exportLastVersion

Sets whether the data from the last version of the document should be exported, rather than the live version. Default false.

failOnError

Sets whether the export should be interrupted when a failure occurs during exporting the document. Default false. When false, the export will simply continue with the next document (a list of failures is however kept and provided at the end of the import). When true, the export will stop in case of an error.

stackTracesOfFailures

Sets whether full stack traces of failures should be kept (for logging in the summary file). Default false.

includeListOfRetiredDocuments

Sets whether a list of retired documents should be included in the export. Default true.

exportDocumentOwners

Sets whether the owners of documents should be exported. Default false.

enableLinkExtraction

Sets whether link extraction should occur on document content. Default true. When true, the content of supported parts (e.g. Daisy HTML, navigation, books) are parsed for links. The branches, languages and namespaces used in those links are included in the export as non-required (the registration of these branches, languages and namespaces in the target repository is important for link extraction to work, and in case of the namespaces to make sure they are associated with the correct fingerprint). Setting this to false can save the export tool some work (the export will run a bit faster).

exportVersionState

Sets whether the state of the exported version should be excluded in the export. Default true. When the option exportLastVersion is false (the default), then the version state will always be 'publish' and thus this option serves little purpose in that case.

exportReferenceLanguage

Sets whether the reference language should be exported. Default true.

7.3.2.2 DocumentExportCustomizer

See the description of the document import customizer of the import tool.

The document export customizer is very similar, it is able to manipulate documents before being exported. The default implementation is able to drop fields, parts and collections, and can exclude out-of-line links and custom fields from the export. The interface to be implemented for custom implementations is:

org.outerj.daisy.tools.importexport.export.config.DocumentExportCustomizer

7.3.2.3 SchemaCustomizer

Exactly the same as for the import tool.

 PreviousHomeNext 
7.3 Export tool7.3.3 Using the export tool programatically