Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Serialization parameters define how XQuery items and XML nodes are textually output, i.e., ''serialized''. (For input, see [[Parsers]].)
They have been formalized in the [http://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document.
In BaseX, they can be specified by…
{{Mark|Updated with Version 8.4}}: New serialization method <code>basex</code>; method <code>raw</code> was removed. By default, items of binary type are now output in their native byte representation. The following table gives a brief summary of all serialization parameters recognized are supported by BaseX. For (further details, please refer to can be looked up in the official specification.):
| {{Code|xml/xhtml}}: {{Code|1.0}}, {{Code|1.1}}<br/>{{Code|html}}: {{Code|4.0}}, {{Code|4.01}}, {{Code|5.0}}<br/>
'''Query''':
→Parameters
This page is part of the [[XQuery|XQuery Portal]].
Serialization parameters define how XQuery items and XML nodes will be ''serialized'' (i.e., returned to the client or an API, usually in textual form). The official parameters are defined in the [http://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document. In BaseX, they can be specified by: * including them in the [[XQuery_3.0#Serialization|prolog of the XQuery expression]],;
* specifying them in the XQuery functions [[File_Module#file:write|file:write()]] or [[XQuery_3.0#Functions|fn:serialize()]]. The serialization parameters are specified as
** children of an {{Code|<output:serialization-parameters/>}} element, as defined for the [http://www.w3.org/TR/xpath-functions-30/#func-serialize fn:serialize()] function, or as
** map, which contains all key/value pairs: <code>map { "method": "xml", "cdata-section-elements": "div", ... }</code>,;* using the {{Code|-s}} flag of the BaseX [[Command-Line Options#BaseX Standalone|command-line]] clients,;* setting the [[Options#SERIALIZER{{Option|SERIALIZER]] }} option before running a query,;* setting the [[Options#EXPORTER{{Option|EXPORTER]] }} option before exporting a database, ; or
* setting them as [[REST#Parameters|REST]] query parameters.
Due to the wide range of ways how parameters can be supplied, we deliberately ignored one rule of the specification, which requires non-official features to be defined in a non-null namespace URI. In the following, we will indicate which features are specific to our implementation.
=Parameters=
{| class="wikitable sortable" width="100%"
|- valign="top"
! width="140" | Parameter
! width="60%" | Description
! Allowed
! Default
|- valign="top"
| {{Code|method}}
| Specifies the serialization method. {{Code|xml}}, {{Code|xhtml}}, {{Code|html}}, {{Code|text}}, {{Code|json}}, and {{Code|adaptive}} are adopted from part of the official specification. The methods For more details on {{Code|basex}}, {{Code|csv}} and {{Code|csvjson}} are specific to BaseX (, see [[XQuery Extensions#Serialization|XQuery Extensions]]).
| {{Code|xml}}, {{Code|xhtml}}, {{Code|html}}, {{Code|text}}, {{Code|json}}, {{Code|adaptive}}, {{Code|csv}}, {{Code|basex}}
| {{Code|basex}}
| {{Code|version}}
| Specifies the version of the serialization method.
| {{Code|1.0}}
|- valign="top"
| {{Code|item-separator}}
| Determines a string to be used as item separator. If a separator is specified, the default separation of atomic values with single whitespaces will be skipped.
| ''arbitrary strings'', {{Code|\n}}, {{Code|\r\n}}, {{Code|\r}}
| ''empty''
|- valign="top"
|- valign="top"
| {{Code|include-content-type}}
| Includes Inserts a {{Code|meta}} content-type element into the head element if the result is output as HTML<br />Example: <code><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head></code>. The head element must already exist or nothing will be added. Any existing {{Code|meta}} content-type elements will be removed.
| {{Code|yes}}, {{Code|no}}
| {{Version|9.2}}: {{Code|noyes}}
|}
|- valign="top"
! width="140" | Parameter
! width="60%" | Description
! Allowed
! Default
The {{Code|csv}} and {{Code|json}} parameters are supplied with a list of options. Option names and values are combined with <code>=</code>, several options are separated by <code>,</code>:
<pre class="brush:xquery">
(: The output namespace declaration is optional, because it is statically declared in BaseX) :)
</record>
</csv>
</pre>
If {{Code|fn:serialize}} is called, output-specific parameters can be supplied via nested options:
<pre class="brush:xquery">
serialize(
<csv>
<record>
<Name>John</Name>
<City>Newton</City>
</record>
<record>
<Name>Jack</Name>
<City>Oldtown</City>
</record>
</csv>,
map {
'method': 'csv',
'csv': map { 'header': 'yes', 'separator': ';' }
}
)
</pre>
John;Newton
Jack;Oldtown
</pre>
=Character mappings=
Character maps allow a specific character in the instance of the data model to be replaced with a specified string of characters during serialization. The string that is substituted is output "as is," and the serializer performs no checks that the resulting document is well-formed. This may only occur in documents parsed with {{Code|parameter-document}}. If a character is mapped, then it is not subjected to XML or HTML escaping. For details refer to section [https://www.w3.org/TR/2015/CR-xslt-xquery-serialization-31-20151217/#character-maps 11 Character maps] in the [http://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document
This example maps the Unicode U+00A0 NO-BREAK SPACE as &#160; (without the serialization parameter, the Unicode character would be output):
'''Example query''':
<pre class="brush:xquery">
declare option output:parameter-document "map.xml";
<x>&#xA0;</x>
</pre>
'''Example parameter-document''':
<pre class="brush:xml">
<serialization-parameters
xmlns="http://www.w3.org/2010/xslt-xquery-serialization">
<use-character-maps>
<character-map character="&#160;" map-string="&amp;#160;"/>
</use-character-maps>
</serialization-parameters>
</pre>
=Changelog=
;Version 9.2
* Updated: New default value for {{Code|include-content-type}} is {{Code|yes}}.
;Version 8.4
