doc.transformers.int_daisy_metadataEditor.html Maven / Gradle / Ivy
The newest version!
int_daisy_metadataEditor
Transformer documentation: Metadata
Editor
Transformer Purpose
This transformer is able to edit a metadata key/value in a file
or fileset.
Input Requirements
This transformer currently support edition of metadata of:
- DTBook documents
- XHTML documents
- NCC documents of DAISY 2.02 DTBs
- OPF package files
Output
On success
On success, the metadata set of the input file will be modified
according to the parameters configuration. Be aware that the input file
is modified by this transformer.
On error
On error, this transformer will send a fatal message, then throw
an exception and abort.
Configuration/Customization
Parameters (tdf)
- input
- The file or fileset manifest to edit the metadata of.
- name
- The name of the metadata to edit
- value
- A comma-separated list of values for the metadata. Leading and
trailing whitespace around the values is ignored.
- mode
- The edition mode. This can be:
- ADD
- Appends a new metadata value even if previous values already
exist (this can however be impossible for some non-repeatable
metadata, e.g. as specified in the X-Metadata
section of the DAISY Z39.86-2005 specification, in which case it will
revert to the 'IGNORE' mode).
- MERGE
- Merges the value with the existing metadata content: does
nothing if a metadata with the same name and value is already present,
appends a new value otherwise.
- OVERWRITE
- Overwrites the first occurrence of the metadata of the given
name with the given value.
- IGNORE
- Adds a new metadata only if no metadata with the given name
is already present.
Further development
The transformer may be extended to support more file types.
Dependencies
None.
Author
Romain Deltour, DAISY Consortium.
Licensing
LGPL.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy