Name
p:unarchive — The standard p:unarchive step.
Synopsis
The p:unarchive step outputs on its result port specific entries
in an archive (for instance from a zip file).
| Input port | Primary | Sequence | Content types |
|---|---|---|---|
| source | ✔ | any |
| Output port | Primary | Sequence | Content types |
|---|---|---|---|
| result | ✔ | ✔ | any |
| Option name | Type | Default value |
|---|---|---|
| exclude-filter | RegularExpression | () |
| format | xs:QName? | () |
| include-filter | RegularExpression | () |
| override-content-types | array(array(xs:string))? | () |
| parameters | map(xs:QName, item()*)? | () |
| relative-to | xs:anyURI? | () |
Declaration
1 |<p:declare-step xmlns:p="http://www.w3.org/ns/xproc">
| <p:input port="source"
| primary="true"
| content-types="any"
5 | sequence="false"/>
| <p:output port="result"
| primary="true"
| content-types="any"
| sequence="true"/>
10 | <p:option xmlns:e="http://www.w3.org/1999/XSL/Spec/ElementSyntax"
| name="include-filter"
| as="xs:string*"
| e:type="RegularExpression"/>
| <p:option xmlns:e="http://www.w3.org/1999/XSL/Spec/ElementSyntax"
15 | name="exclude-filter"
| as="xs:string*"
| e:type="RegularExpression"/>
| <p:option name="format" as="xs:QName?"/>
| <p:option name="parameters" as="map(xs:QName, item()*)?"/>
20 | <p:option name="relative-to" as="xs:anyURI?"/>
| <p:option name="override-content-types" as="array(array(xs:string))?"/>
|</p:declare-step>Errors
| Code | Description |
|---|---|
err:XC0079 | It is a dynamic error (err:XC0079) if the map
parameters contains an entry whose key is defined by the implementation
and whose value is not valid for that key. |
err:XC0085 | It is a dynamic error (err:XC0085) if the format of the archive
does not match the specified format, cannot be understood, determined and/or processed. |
err:XC0120 | It is a dynamic error (err:XC0120) if the
relative-to option is not present and the document on the
source port does not have a base URI. |
err:XC0147 | It is a dynamic
error (err:XC0147) if a specified value is not a valid XPath regular
expression. |
err:XD0064 | It is a dynamic
error (err:XD0064) if the option is not a valid URI according to RFC 3986. |
Implementation defined features
- It is implementation-defined what other formats are supported.
- It is implementation-defined how the step determines the archive's format.
- The semantics of the keys and the allowed values for these keys are implementation-defined.
Description
The p:unarchive step is defined in the
XProc 3.0:
Standard Step Library. It is also described on
XProcRef.org.
Supported formats
The supported formats are
7z,
Ar,
Arj,
Cpio,
Jar,
Tar, and
Zip. For more information, see the
p:archive step.