Archive Module - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:38:40Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:32:05Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:31:05Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG: /* archive:create-from */

2023-03-09T15:19:19Z

archive:create-from

CG at 14:46, 9 March 2023

2023-03-09T14:46:50Z

CG: /* archive:create-from */

2023-03-09T14:43:14Z

archive:create-from

CG at 13:10, 9 March 2023

2023-03-09T13:10:52Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:02:47Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

CG at 11:02, 9 March 2023

2023-03-09T11:02:51Z

CG: Text replacement - "
" to "
"

2023-03-09T08:16:33Z

Text replacement - "<br />" to "<br/>"

@@ Line 22: / Line 22: @@
 * {{Code|compressed-size}}: compressed file size
 An example:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <archive:entry size="1840" last-modified="2009-03-20T03:30:32" compressed-size="672">
    doc/index.html
@@ Line 136: / Line 136: @@
 * {{Code|encoding}}: for textual entries (default: UTF-8)
 An example:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <archive:entry last-modified='2011-11-11T11:11:11'
                 compression-level='8'

@@ Line 26: / Line 26: @@
    doc/index.html
 </archive:entry>
-</syntaxhighlight>
+</pre>
 |- valign="top"
 | '''Errors'''
@@ Line 35: / Line 35: @@
 <pre lang='xquery'>
 sum(archive:entries(file:read-binary('zip.zip'))/@size)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 60: / Line 60: @@
    "algorithm": "deflate"
+}
-</syntaxhighlight>
+</pre>
 |}
@@ Line 86: / Line 86: @@
 for $entry in archive:entries($archive)[ends-with(., '.txt')]
 return archive:extract-text($archive, $entry)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 114: / Line 114: @@
    file:create-dir(replace($entry, "[^/]+$", "")),
    file:write-binary($entry, $content)
-})</syntaxhighlight>
+})</pre>
 |}
@@ Line 140: / Line 140: @@
                 compression-level='8'
                 encoding='US-ASCII'>hello.txt</archive:entry>
-</syntaxhighlight>
+</pre>
 The actual {{Code|$contents}} must be {{Code|xs:string}} or {{Code|xs:base64Binary}} items.<br/>
 The {{Code|$options}} parameter contains archiving options:
@@ Line 153: / Line 153: @@
 <pre lang='xquery'>
 archive:create(<archive:entry>file.txt</archive:entry>, 'Hello World')
-</syntaxhighlight>
+</pre>
 The following function creates an archive {{Code|mp3.zip}}, which contains all MP3 files of a local directory:
 <pre lang='xquery'>
@@ Line 162: / Line 162: @@
    return file:read-binary($path || $file)
+)
-return file:write-binary('mp3.zip', $zip)</syntaxhighlight>
+return file:write-binary('mp3.zip', $zip)</pre>
 |}
@@ Line 196: / Line 196: @@
 let $updated := archive:update($archive, $doc, $entry)
 return file:write-binary($output, $updated)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 221: / Line 221: @@
 let $entries := archive:entries($zip)[matches(., '\.x?html?$', 'i')]
 return file:write-binary('new.zip', archive:delete($zip, $entries))
-</syntaxhighlight>
+</pre>
 |}
@@ Line 250: / Line 250: @@
 let $zip := archive:create-from('/home/user/')
 return file:write-binary('archive.zip', $zip)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 274: / Line 274: @@
 <pre lang='xquery'>
 archive:extract-to('.', file:read-binary('archive.zip'))
-</syntaxhighlight>
+</pre>
 |}
@@ Line 304: / Line 304: @@
    ('Archive with MP3 files', $files ! file:read-binary(.))
+)
-</syntaxhighlight>
+</pre>
 |}

@@ Line 33: / Line 33: @@
 |'''Examples'''
 |Sums up the file sizes of all entries of a JAR file:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 sum(archive:entries(file:read-binary('zip.zip'))/@size)
 </syntaxhighlight>
@@ Line 55: / Line 55: @@
 | '''Examples'''
 |A standard ZIP archive will return the following options:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 map {
    "format": "zip",
@@ Line 82: / Line 82: @@
 | '''Examples'''
 |The following expression extracts all {{Code|.txt}} files from an archive:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $archive := file:read-binary("documents.zip")
 for $entry in archive:entries($archive)[ends-with(., '.txt')]
@@ Line 107: / Line 107: @@
 | '''Examples'''
 |This example unzips all files of an archive to the current directory:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $archive  := file:read-binary('archive.zip')
 let $entries  := archive:entries($archive)
@@ Line 151: / Line 151: @@
 | '''Examples'''
 |The following one-liner creates an archive {{Code|archive.zip}} with one file {{Code|file.txt}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 archive:create(<archive:entry>file.txt</archive:entry>, 'Hello World')
 </syntaxhighlight>
 The following function creates an archive {{Code|mp3.zip}}, which contains all MP3 files of a local directory:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $path  := 'audio/'
 let $files := file:list($path, true(), '*.mp3')
@@ Line 184: / Line 184: @@
 | '''Examples'''
 |This example replaces texts in a Word document:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare variable $input  := "HelloWorld.docx";
 declare variable $output := "HelloUniverse.docx";
@@ Line 217: / Line 217: @@
 | '''Examples'''
 |This example deletes all HTML files in an archive and creates a new file:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $zip := file:read-binary('old.zip')
 let $entries := archive:entries($zip)[matches(., '\.x?html?$', 'i')]
@@ Line 247: / Line 247: @@
 | '''Examples'''
 |This example writes the files of a user’s home directory to <code>archive.zip</code>:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $zip := archive:create-from('/home/user/')
 return file:write-binary('archive.zip', $zip)
@@ Line 272: / Line 272: @@
 | '''Examples'''
 |The following expression unzips all files of an archive to the current directory:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 archive:extract-to('.', file:read-binary('archive.zip'))
 </syntaxhighlight>
@@ Line 297: / Line 297: @@
 | '''Examples'''
 |All mp3 files from a directory are zipped and written to a file, along with an info file:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $files := file:children('music')[ends-with(., 'mp3')]
 return archive:write(

@@ Line 238: / Line 238: @@
 |- valign="top"
 | '''Summary'''
-|This convenience function creates an archive from all files in the specified directory {{Code|$path}}.<br/>The {{Code|$options}} parameter contains archiving options, and the files to be archived can be limited via {{Code|$entries}}. The format of the two last arguments is identical to {{Function||archive:create}}, but two additional options are available:
+|This convenience function creates an archive from all files in the specified directory {{Code|$path}}.<br/>The {{Code|$options}} parameter contains archiving options, and the files to be archived can be limited via {{Code|$entries}}. The format of the two last arguments is identical to {{Function||archive:create}}, with two additional options:
 * {{Code|recursive}}: parse all files recursively (default: {{Code|true}}; ignored if entries are specified via the last argument).
 * {{Code|root-dir}}: use name of supplied directory as archive root directory (default: {{Code|false}}).

@@ Line 127: / Line 127: @@
    $entries   as item(),
    $contents  as item()*,
-   $options   as map(*)?  := ()
+   $options   as map(*)?  := map { }
 ) as xs:base64Binary</pre>
 |- valign="top"
@@ Line 286: / Line 286: @@
    $entries   as item(),
    $contents  as item()*,
-   $options   as map(*)?    := ()
+   $options   as map(*)?  := map { }
 ) as xs:base64Binary</pre>
 |- valign="top"

@@ Line 233: / Line 233: @@
 |<pre>archive:create-from(
    $path     as xs:string,
-   $options  as map(*)?    := (),
+   $options  as map(*)?    := map { },
    $entries  as item()*    := ()
 ) as xs:base64Binary</pre>

@@ Line 69: / Line 69: @@
 | width='120' | '''Signature'''
 |<pre>archive:extract-text(
-   $archive   as xs:base64Binary
+   $archive   as xs:base64Binary,
-   $entries   as item()*          := ()
+   $entries   as item()*          := (),
    $encoding  as xs:string        := ()
 ) as xs:string*</pre>
@@ Line 95: / Line 95: @@
 | width='120' | '''Signature'''
 |<pre>archive:extract-binary(
-   $archive  as xs:base64Binary
+   $archive  as xs:base64Binary,
    $entries  as item()*          := ()
 ) as xs:base64Binary*</pre>
@@ Line 125: / Line 125: @@
 | width='120' | '''Signature'''
 |<pre>archive:create(
-   $entries   as item()
+   $entries   as item(),
-   $contents  as item()*
+   $contents  as item()*,
    $options   as map(*)?  := ()
 ) as xs:base64Binary</pre>
@@ Line 171: / Line 171: @@
 | width='120' | '''Signature'''
 |<pre>archive:update(
-   $archive   as xs:base64Binary
+   $archive   as xs:base64Binary,
-   $entries   as item()*
+   $entries   as item()*,
    $contents  as item()*
 ) as xs:base64Binary</pre>
@@ Line 205: / Line 205: @@
 | width='120' | '''Signature'''
 |<pre>archive:delete(
-   $archive  as xs:base64Binary
+   $archive  as xs:base64Binary,
    $entries  as item()*
 ) as xs:base64Binary</pre>
@@ Line 232: / Line 232: @@
 | width='120' | '''Signature'''
 |<pre>archive:create-from(
-   $path     as xs:string
+   $path     as xs:string,
-   $options  as map(*)?    := ()
+   $options  as map(*)?    := (),
    $entries  as item()*    := ()
 ) as xs:base64Binary</pre>
@@ Line 259: / Line 259: @@
 | width='120' | '''Signature'''
 |<pre>archive:extract-to(
-   $path     as xs:string
+   $path     as xs:string,
-   $archive  as xs:base64Binary
+   $archive  as xs:base64Binary,
    $entries  as item()*          := ()
 ) as empty-sequence()</pre>
@@ Line 283: / Line 283: @@
 | width='120' | '''Signature'''
 |<pre>archive:write(
-   $path      as xs:string
+   $path      as xs:string,
-   $entries   as item()
+   $entries   as item(),
-   $contents  as item()*
+   $contents  as item()*,
    $options   as map(*)?    := ()
 ) as xs:base64Binary</pre>

@@ Line 12: / Line 12: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|archive:entries|$archive as xs:base64Binary|element(archive:entry)*}}<br />
+|{{Func|archive:entries|$archive as xs:base64Binary|element(archive:entry)*}}<br/>
 |- valign="top"
 | '''Summary'''
@@ Line 41: / Line 41: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|archive:options|$archive as xs:base64Binary|map(*)}}<br />
+|{{Func|archive:options|$archive as xs:base64Binary|map(*)}}<br/>
 |- valign="top"
 | '''Summary'''
@@ Line 70: / Line 70: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br />{{Error|error|#Errors}} archive creation failed.
+|{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br/>{{Error|error|#Errors}} archive creation failed.
 |- valign="top"
 | '''Examples'''
@@ Line 113: / Line 113: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|archive:create|$entries as item(), $contents as item()*|xs:base64Binary}}<br />{{Func|archive:create|$entries as item(), $contents as item()*, $options as map(*)?|xs:base64Binary}}<br />
+|{{Func|archive:create|$entries as item(), $contents as item()*|xs:base64Binary}}<br/>{{Func|archive:create|$entries as item(), $contents as item()*, $options as map(*)?|xs:base64Binary}}<br/>
 |- valign="top"
 | '''Summary'''
@@ Line 132: / Line 132: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|number|#Errors}} the number of entries and contents differs.<br />{{Error|format|#Errors}} the specified option or its value is invalid or not supported.<br />{{Error|descriptor|#Errors}} entry descriptors contain invalid entry names, timestamps or compression levels.<br/>{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br/>{{Error|single|#Errors}} the chosen archive format only allows single entries.<br />{{Error|error|#Errors}} archive creation failed.
+|{{Error|number|#Errors}} the number of entries and contents differs.<br/>{{Error|format|#Errors}} the specified option or its value is invalid or not supported.<br/>{{Error|descriptor|#Errors}} entry descriptors contain invalid entry names, timestamps or compression levels.<br/>{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br/>{{Error|single|#Errors}} the chosen archive format only allows single entries.<br/>{{Error|error|#Errors}} archive creation failed.
 |- valign="top"
 | '''Examples'''
@@ Line 161: / Line 161: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|number|#Errors}} the number of entries and contents differs.<br />{{Error|descriptor|#Errors}} entry descriptors contain invalid entry names, timestamps, compression levels or encodings.<br/>{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br />{{Error|modify|#Errors}} the entries of the given archive cannot be modified.<br/>{{Error|error|#Errors}} archive creation failed.
+|{{Error|number|#Errors}} the number of entries and contents differs.<br/>{{Error|descriptor|#Errors}} entry descriptors contain invalid entry names, timestamps, compression levels or encodings.<br/>{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br/>{{Error|modify|#Errors}} the entries of the given archive cannot be modified.<br/>{{Error|error|#Errors}} archive creation failed.
 |- valign="top"
 | '''Examples'''
@@ Line 252: / Line 252: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|archive:write|$path as xs:string, $entries as item(), $contents as item()*|xs:base64Binary}}<br />{{Func|archive:write|$path as xs:string, $entries as item(), $contents as item()*, $options as map(*)?|xs:base64Binary}}<br />
+|{{Func|archive:write|$path as xs:string, $entries as item(), $contents as item()*|xs:base64Binary}}<br/>{{Func|archive:write|$path as xs:string, $entries as item(), $contents as item()*, $options as map(*)?|xs:base64Binary}}<br/>
 |- valign="top"
 | '''Summary'''
@@ Line 258: / Line 258: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|number|#Errors}} the number of entries and contents differs.<br />{{Error|format|#Errors}} the specified option or its value is invalid or not supported.<br />{{Error|descriptor|#Errors}} entry descriptors contain invalid entry names, timestamps or compression levels.<br/>{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br/>{{Error|single|#Errors}} the chosen archive format only allows single entries.<br />{{Error|error|#Errors}} archive creation failed.
+|{{Error|number|#Errors}} the number of entries and contents differs.<br/>{{Error|format|#Errors}} the specified option or its value is invalid or not supported.<br/>{{Error|descriptor|#Errors}} entry descriptors contain invalid entry names, timestamps or compression levels.<br/>{{Error|encode|#Errors}} the specified encoding is invalid or not supported, or the string conversion failed. Invalid XML characters will be ignored if {{Option|CHECKSTRINGS}} is turned off.<br/>{{Error|single|#Errors}} the chosen archive format only allows single entries.<br/>{{Error|error|#Errors}} archive creation failed.
 |- valign="top"
 | '''Examples'''