Web Module - Revision history

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

2023-12-01T16:39:07Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:33:41Z

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

CG: Text replacement - "" to "

2023-12-01T16:31:49Z

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

CG at 15:31, 9 March 2023

2023-03-09T15:31:56Z

CG at 14:21, 9 March 2023

2023-03-09T14:21:15Z

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

2023-03-09T13:09:43Z

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

CG at 11:10, 9 March 2023

2023-03-09T11:10:58Z

CG at 12:20, 20 July 2022

2022-07-20T12:20:22Z

CG: Text replacement - "\[\[#([^]:]+:[^|]+)\|([^]:]+:[^|]+)\]\]" to "{{Function||$1}}"

2022-07-18T17:50:46Z

Text replacement - "\[\[#([^]:]+:[^|]+)\|([^]:]+:[^|]+)\]\]" to "{{Function||$1}}"

CG: /* web:forward */

2020-10-14T10:47:57Z

web:forward

@@ Line 100: / Line 100: @@
+|
 The function call <code><nowiki>web:forward('/a/b')</nowiki></code> creates the following result (which will be interpreted as forwarding if RESTXQ is used):
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <rest:forward>/a/b</rest:forward>
 </pre>
@@ Line 122: / Line 122: @@
+|
 The query <code><nowiki>web:redirect('/a/b')</nowiki></code> returns the following result (which will be interpreted as redirection if RESTXQ is used):
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <rest:response xmlns:rest="http://exquery.org/ns/restxq">
    <http:response xmlns:http="http://expath.org/ns/http-client" status="302">
@@ Line 152: / Line 152: @@
+|
 * The function call <code>web:response-header()</code> returns:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <rest:response xmlns:rest="http://exquery.org/ns/restxq">
    <http:response xmlns:http="http://expath.org/ns/http-client"/>

@@ Line 102: / Line 102: @@
 <syntaxhighlight lang="xml">
 <rest:forward>/a/b</rest:forward>
-</syntaxhighlight>
+</pre>
 |}
@@ Line 128: / Line 128: @@
    </http:response>
 </rest:response>
-</syntaxhighlight>
+</pre>
 |}
@@ Line 157: / Line 157: @@
    <output:serialization-parameters xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization"/>
 </rest:response>
-</syntaxhighlight>
+</pre>
 * The following expression returns a media-type for binary data, a caching directive, and the OK status:<br/>
 <pre lang='xquery'>
@@ Line 165: / Line 165: @@
    map { 'status': 200, 'message': 'OK' }
+)
-</syntaxhighlight>
+</pre>
 * The following RESTXQ function returns the contents of a file to the client with correct media type:<br/>
 <pre lang='xquery'>
@@ Line 175: / Line 175: @@
+   )
 };
-</syntaxhighlight>
+</pre>
 |}

@@ Line 159: / Line 159: @@
 </syntaxhighlight>
 * The following expression returns a media-type for binary data, a caching directive, and the OK status:<br/>
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 web:response-header(
    map { 'media-type': 'application/octet-stream' },
@@ Line 167: / Line 167: @@
 </syntaxhighlight>
 * The following RESTXQ function returns the contents of a file to the client with correct media type:<br/>
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare %rest:path('media/{$file}') function local:get($file) {
    let $path := 'path/to/' || $file

@@ Line 30: / Line 30: @@
 | width='120' | '''Signature'''
 |<pre>web:create-url(
-   $url         as xs:string,
+   $href        as xs:string,
    $parameters  as map(*),
    $anchor      as xs:string  := ()
@@ Line 36: / Line 36: @@
 |- valign="top"
 | '''Summary'''
-|Creates a new URL from the specified <code>$url</code> string, query string <code>$parameters</code> and an optional {{Code|$anchor}} reference. The keys and values of the map entries will be converted to strings, URL-encoded (see {{Function||web:encode-url}}), and appended to the URL as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.
+|Creates a new URL from the specified {{Code|$href}} string, query string <code>$parameters</code> and an optional {{Code|$anchor}} reference. The keys and values of the map entries will be converted to strings, URL-encoded (see {{Function||web:encode-url}}), and appended to the URL as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.
 |- valign="top"
 | '''Examples'''

@@ Line 30: / Line 30: @@
 | width='120' | '''Signature'''
 |<pre>web:create-url(
-   $url         as xs:string
+   $url         as xs:string,
-   $parameters  as map(*)
+   $parameters  as map(*),
    $anchor      as xs:string  := ()
 ) as xs:string</pre>
@@ Line 87: / Line 87: @@
 | width='120' | '''Signature'''
 |<pre>web:forward(
-   $path        as xs:string
+   $path        as xs:string,
    $parameters  as map(*)     := ()
 ) as element(rest:forward)</pre>
@@ Line 111: / Line 111: @@
 | width='120' | '''Signature'''
 |<pre>web:redirect(
-   $url         as xs:string
+   $url         as xs:string,
-   $parameters  as map(*)     := ()
+   $parameters  as map(*)     := (),
    $anchor      as xs:string  := ()
 ) as element(rest:response)</pre>
@@ Line 137: / Line 137: @@
 | width='120' | '''Signature'''
 |<pre>web:response-header(
-   $output   as map(*)?  := ()
+   $output   as map(*)?  := (),
-   $headers  as map(*)?  := ()
+   $headers  as map(*)?  := (),
    $atts     as map(*)?  := ()
 ) as element(rest:response)</pre>
@@ Line 184: / Line 184: @@
 | width='120' | '''Signature'''
 |<pre>web:error(
-   $status   as xs:integer
+   $status   as xs:integer,
    $message  as xs:string
 ) as none</pre>

@@ Line 11: / Line 11: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:content-type(
    $path  as xs:string
@@ Line 28: / Line 28: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:create-url(
    $url         as xs:string
@@ Line 48: / Line 48: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:encode-url(
    $string  as xs:string
@@ Line 65: / Line 65: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:decode-url(
    $string  as xs:string
@@ Line 85: / Line 85: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:forward(
    $path        as xs:string
@@ Line 109: / Line 109: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:redirect(
    $url         as xs:string
@@ Line 135: / Line 135: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:response-header(
    $output   as map(*)?  := ()
@@ Line 182: / Line 182: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>web:error(
    $status   as xs:integer

@@ Line 30: / Line 30: @@
 |-
 | '''Summary'''
-|Creates a new URL from the specified <code>$url</code> string, query string <code>$parameters</code> and an optional {{Code|$anchor}} reference. The keys and values of the map entries will be converted to strings, URL-encoded (see [[#web:encode-url|web:encode-url]]), and appended to the URL as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.
+|Creates a new URL from the specified <code>$url</code> string, query string <code>$parameters</code> and an optional {{Code|$anchor}} reference. The keys and values of the map entries will be converted to strings, URL-encoded (see {{Function||web:encode-url}}), and appended to the URL as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.
 |-
 | '''Examples'''
@@ Line 82: / Line 82: @@
 * The client will not get notified of this forwarding.
 * Supplied query parameters will be attached to parameters of the current request.
-* The {{Code|$parameter}} argument is processed as described in [[#web:create-url|web:create-url]].
+* The {{Code|$parameter}} argument is processed as described in {{Function||web:create-url}}.
 |-
 | '''Examples'''
@@ Line 100: / Line 100: @@
 |-
 | '''Summary'''
-|Creates a [[RESTXQ#Forwards and Redirects|RESTXQ redirection]] to the specified {{Code|$url}}. The returned response will only work if no other items are returned by the RESTXQ function.<br/>The {{Code|$parameters}} and {{Code|$anchor}} arguments are processed as described in (see [[#web:create-url|web:create-url]]).
+|Creates a [[RESTXQ#Forwards and Redirects|RESTXQ redirection]] to the specified {{Code|$url}}. The returned response will only work if no other items are returned by the RESTXQ function.<br/>The {{Code|$parameters}} and {{Code|$anchor}} arguments are processed as described in (see {{Function||web:create-url}}).
 |-
 | '''Examples'''
@@ Line 193: / Line 193: @@
 ;Version 9.3
-* Added: [[#web:error|web:error]], [[#web:forward|web:forward]]
+* Added: {{Function||web:error}}, {{Function||web:forward}}
 ;Version 9.2
-* Updated: [[#web:create-url|web:create-url]], [[#web:redirect|web:redirect]]: third argument added.
+* Updated: {{Function||web:create-url}}, {{Function||web:redirect}}: third argument added.
 ;Version 9.0
-* Updated: [[#web:response-header|web:response-header]]: third argument added; default parameters removed.
+* Updated: {{Function||web:response-header}}: third argument added; default parameters removed.
 * Updated: error codes updated; errors now use the module namespace
 ;Version 8.4
-* Updated: [[#web:response-header|web:response-header]]: serialization method <code>raw</code> was removed (now obsolete).
+* Updated: {{Function||web:response-header}}: serialization method <code>raw</code> was removed (now obsolete).
 ;Version 8.2
-* Added: [[#web:encode-url|web:encode-url]], [[#web:decode-url|web:decode-url]].
+* Added: {{Function||web:encode-url}}, {{Function||web:decode-url}}.
 The module was introduced with Version 8.1.

@@ Line 79: / Line 79: @@
 |-
 | '''Summary'''
-|Creates a server-side [[RESTXQ#Forwards and Redirects|RESTXQ forward request]] to the specified {{Code|$path}}. The client will not get notified of this forwarding.<br/>The {{Code|$parameter}} argument is processed as described in [[#web:create-url|web:create-url]].
+|Creates a server-side [[RESTXQ#Forwards and Redirects|RESTXQ forward request]] to the specified {{Code|$path}}:
 |-
 | '''Examples'''