File Module - Revision history

Amanda: Fix syntax of wiki template usage so the content renders properly

2024-03-26T17:20:48Z

Fix syntax of wiki template usage so the content renders properly

CG: /* file:list */

2023-12-01T21:06:53Z

file:list

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

2023-12-01T16:39:40Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:30:19Z

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

CG: Text replacement - "" to "

2023-12-01T16:29:30Z

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

CG: /* file:read-text */

2023-05-23T16:45:00Z

file:read-text

CG at 15:12, 9 March 2023

2023-03-09T15:12:53Z

CG at 14:52, 9 March 2023

2023-03-09T14:52:42Z

CG at 13:29, 9 March 2023

2023-03-09T13:29:38Z

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

2023-03-09T13:03:28Z

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

Show changes

@@ Line 270: / Line 270: @@
 |- valign="top"
 | '''Summary'''
-|Writes serialized {{$input}} to the specified file. If the file already exists, it will be overwritten.<br/>The {{Code|$options}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br/>
+|Writes serialized {{Code|$input}} to the specified file. If the file already exists, it will be overwritten.<br/>The {{Code|$options}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br/>
 * either as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element:
 <pre lang="xml">

@@ Line 60: / Line 60: @@
 |- valign="top"
 | '''Examples'''
-| Return the contents of large {Code|.txt} files located in a specific directory and its subdirectories:
+| Return the contents of large {{Code|.txt}} files located in a specific directory and its subdirectories:
 <pre lang='xquery'>
 let $root := 'path/to/files/'

@@ Line 272: / Line 272: @@
 |Writes serialized {{$input}} to the specified file. If the file already exists, it will be overwritten.<br/>The {{Code|$options}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br/>
 * either as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <output:serialization-parameters>
    <output:method value='xml'/>

@@ Line 67: / Line 67: @@
 where file:size($path) > 1000000
 return file:read-text($path)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 91: / Line 91: @@
 where matches($file, '.txt', 'i') and file:size($file) > 1000000
 return file:read-text($$file)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 115: / Line 115: @@
 where matches($file, '.txt', 'i') and file:size($file) > 1000000
 return file:read-text($$file)
-</syntaxhighlight>
+</pre>
 |}
@@ Line 278: / Line 278: @@
    ...
 </output:serialization-parameters>
-</syntaxhighlight>
+</pre>
 * or as map, which contains all key/value pairs:
 <pre lang='xquery'>
 map { "method": "xml", "cdata-section-elements": "div", ... }
-</syntaxhighlight>
+</pre>
 |- valign="top"
 | '''Errors'''
@@ Line 455: / Line 455: @@
 <pre lang='xquery'>
 file:move('/projects/new/octopus', '/projects/new/septimus')
-</syntaxhighlight>
+</pre>
 <pre lang='xquery'>
 $path ! file:move(., file:parent(.)||$newName)
-</syntaxhighlight>
+</pre>
 |}

@@ Line 61: / Line 61: @@
 | '''Examples'''
 | Return the contents of large {Code|.txt} files located in a specific directory and its subdirectories:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $root := 'path/to/files/'
 for $file in file:list($root, true(), '*.txt')
@@ Line 87: / Line 87: @@
 | '''Examples'''
 | Return the contents of large {{Code|.txt}} files located in a specific directory:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 for $file in file:children('path/to/files/')
 where matches($file, '.txt', 'i') and file:size($file) > 1000000
@@ Line 111: / Line 111: @@
 | '''Examples'''
 | Return the contents of all {{Code|.txt}} files located in a specific directory and its subdirectories:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 for $file in file:descendants('path/to/files/')
 where matches($file, '.txt', 'i') and file:size($file) > 1000000
@@ Line 280: / Line 280: @@
 </syntaxhighlight>
 * or as map, which contains all key/value pairs:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 map { "method": "xml", "cdata-section-elements": "div", ... }
 </syntaxhighlight>
@@ Line 453: / Line 453: @@
 | '''Examples'''
 |When renaming a file, remember that relative file paths are resolved against the current working directory. Some ways to rename:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 file:move('/projects/new/octopus', '/projects/new/septimus')
 </syntaxhighlight>
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 $path ! file:move(., file:parent(.)||$newName)
 </syntaxhighlight>

@@ Line 154: / Line 154: @@
 |Reads the textual contents of the file specified by {{Code|$path}} and returns it as [[Lazy Module|lazy]] {{Code|xs:string}} item:
 * The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
-* By default, invalid characters will be rejected. If {{Code|$fallback}} is set to true, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).
+* By default, invalid XML characters will be rejected. If {{Code|$fallback}} is enabled, the characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).
 |- valign="top"
 | '''Errors'''

@@ Line 49: / Line 49: @@
 |<pre>file:list(
    $dir        as xs:string,
-   $recursive  as xs:boolean  := (),
+   $recursive  as xs:boolean?  := false(),
-   $pattern    as xs:string   := ()
+   $pattern    as xs:string    := ()
 ) as xs:string*</pre>
 |- valign="top"
 | '''Summary'''
-|Lists all files and directories found in the specified {{Code|$dir}}. The returned paths are relative to the provided path.<br/>The optional parameter {{Code|$recursive}} specifies whether subdirectories will be traversed, too.<br/>The optional parameter {{Code|$pattern}} defines a file name pattern in the [[Commands#Glob_Syntax|Glob Syntax]]. If present, only those files and directories are returned that correspond to the pattern. Several patterns can be separated with a comma ({{Code|,}}).<br/>
+|Lists all files and directories found in the specified {{Code|$dir}}. The returned paths are relative to the provided path.<br/>If {{Code|$recursive}} is set to true, subdirectories will be traversed.<br/>The optional parameter {{Code|$pattern}} defines a file name pattern in the [[Commands#Glob_Syntax|Glob Syntax]]. If present, only those files and directories are returned that correspond to the pattern. Several patterns can be separated with a comma ({{Code|,}}).<br/>
 |- valign="top"
 | '''Errors'''
@@ Line 148: / Line 148: @@
    $path      as xs:string,
    $encoding  as xs:string   := (),
-   $fallback  as xs:boolean  := ()
+   $fallback  as xs:boolean?  := false()
 ) as xs:string</pre>
 |- valign="top"
@@ Line 171: / Line 171: @@
 |<pre>file:read-text-lines(
    $path      as xs:string,
-   $encoding  as xs:string   := (),
+   $encoding  as xs:string    := (),
-   $fallback  as xs:boolean  := (),
+   $fallback  as xs:boolean?  := false(),
-   $offset    as xs:integer  := (),
+   $offset    as xs:integer?  := (),
-   $length    as xs:integer  := ()
+   $length    as xs:integer?  := ()
 ) as xs:string*</pre>
 |- valign="top"
@@ Line 248: / Line 248: @@
 |<pre>file:delete(
    $path       as xs:string,
-   $recursive  as xs:boolean  := ()
+   $recursive  as xs:boolean?  := false()
 ) as empty-sequence()</pre>
 |- valign="top"

@@ Line 264: / Line 264: @@
 | width='120' | '''Signature'''
 |<pre>file:write(
-   $path    as xs:string,
+   $path     as xs:string,
-   $items   as item()*,
+   $input    as item()*,
-   $params  as item()     := ()
+   $options  as map(*)?    := map { }
 ) as empty-sequence()</pre>
 |- valign="top"
 | '''Summary'''
-|Writes a serialized sequence of items to the specified file. If the file already exists, it will be overwritten.<br/>The {{Code|$params}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br/>
+|Writes serialized {{$input}} to the specified file. If the file already exists, it will be overwritten.<br/>The {{Code|$options}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br/>
 * either as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element:
 <syntaxhighlight lang="xml">
@@ Line 353: / Line 353: @@
 | width='120' | '''Signature'''
 |<pre>file:append(
-   $path    as xs:string,
+   $path     as xs:string,
-   $items   as item()*,
+   $input    as item()*,
-   $params  as item()     := ()
+   $options  as map(*)?    := map { }
 ) as empty-sequence()</pre>
 |- valign="top"
 | '''Summary'''
-|Appends a serialized sequence of items to the specified file. If the file does not exists, a new file is created.<br/>
+|Appends a serialized sequence of {{Code|$input}} to the specified file, with the supplied {{Code|$options}} as serialization parameters. If the file does not exist, a new file is created.<br/>
 |- valign="top"
 | '''Errors'''