Step fileset-store {http://www.daisy.org/ns/pipeline/xproc}

Store the fileset to disk.

Files that exist in memory are stored to disk from memory. Files that do not exist in memory but have an original-href pointing to an existing file on disk are copied. Existing files are overwritten. Files that do not exist in memory or at the original-href location are considered missing files, even if a file already exists at the target location.

Fails when the "fail-or-error" option is set and there are missing files.

Fails if the fileset contains files outside of the base directory.

Defined in: http://www.daisy.org/pipeline/modules/fileset-utils/library.xpl

Input Ports

Port Description
fileset.in primary
in-memory.in sequence

The input fileset

A number of serialization parameters can be specified with attributes on the d:file elements:

  • byte-order-mark
  • cdata-section-elements
  • doctype
  • doctype-public
  • doctype-system
  • encoding
  • escape-uri-attributes
  • include-content-type
  • indent
  • media-type
  • method
  • normalization-form
  • omit-xml-declaration
  • standalone
  • undeclare-prefixes
  • version
  • xml-declaration

These parameters only have effect when the file exists in memory.

Output Ports

Port Description
fileset.out

The output fileset is a copy of the input fileset but with original-href attributes added (or overwritten) with the same value as href. Missing files are removed if the "fail-on-error" option is not set (default).

Options

Local Name Namespace URI Default Description
fail-on-error false()

Whether to ignore missing files or raise an error.

temp-dir ''

If set, this is the directory that will be used for extracting zipped files before they are stored at the final location (for testing purposes).

recursive false()

Don't use this option.