Changes

* including them in the [[XQuery_3.0#Serialization|prolog of the parameters define how XQuery expression]]items and XML nodes will be ''serialized'' (i.e.,* specifying them in returned to the XQuery functions [[File_Module#file:write|file:write()]] client or [[XQuery_3.0#Functions|fn:serialize(an API, usually in textual form)]]. The serialization official parameters are specified as** children of an {{Code|&lt;output:serialization-parameters/&gt;}} element, as defined for in the [httphttps://www.w3.org/TR/xpathxslt-functionsxquery-30/#funcserialization-serialize fn:serialize()31 W3C XQuery Serialization 3.1] function, or as** map, which contains all key/value pairs: <code>map { "method": "xml", "cdata-section-elements": "div", ..document. }</code>,* using the {{Code|-s}} flag of the BaseX [[Command-Line Options#In BaseX Standalone|command-line]] clients,* setting the [[Options#SERIALIZER|SERIALIZER]] option before running a query,* setting the [[Options#EXPORTER|EXPORTER]] option before exporting a database, or* setting them as [[REST#Parameters|REST]] query parameters.they can be:

* included in the [[XQuery_3.0#Serialization|prolog of the XQuery expression]];* specified in XQuery functions ({{Function|File|file:write}}, {{Function|Database|db:export}}, [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()]);* specified in [[REST#Parameters|REST query parameters]];* specified in [[RESTXQ#Output|RESTXQ output annotations]];* set via the {{Option|SERIALIZER}} option before running a query;* set via the {{Option|EXPORTER}} option before exporting a database; or* supplied with the {{Code|-s}} flag of the BaseX [[Command-Line Options#BaseX Standalone|command-line]] clients. The namespace for serialization parameters is statically bound to the {{Code|output}} prefix. This means that it need not (but may) be declared in the query prolog: <pre lang='xquery'>declare namespace output = 'http://www.w3.org/2010/xslt-xquery-serialization';declare option output:method 'text';<xml>Hi there</xml></pre> 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. =Standard Parameters=

| 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]]).

| ''arbitrary stringsstring''| ''empty''

| ''[httphttps://docs.oracle.com/javase/78/docs/technotes/guides/intl/encoding.doc.html all encodings supported by Java]''

| Adjusts Adds leading whitespaces to make the output better more readable.

| {{Code|yesno}}

| List of elements to be output as CDATA, separated by whitespaces.<br />Example: {{Code|&lt;text&gt;&lt;![CDATA[ &lt;&gt; ]]&gt;&lt;/text&gt;}}| ''string''

| Omits the XML declaration, which is serialized before the actual query result<br />Example: <code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;</code>

| Prints or omits the "{{Code|standalone" }} attribute in the XML declaration.

| Introduces the output with a document type declaration and the given system identifier.<br />Example: {{Code|&lt;!DOCTYPE x SYSTEM "entities.dtd"&gt;}}|''string''

| If {{Code|doctype-system}} is specified, adds a public identifier.<br />Example: {{Code|&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "<nowiki>http://www.w3.org/TR/html4/strict.dtd</nowiki>"&gt;}}| ''string''

| ''string''

| Defines character mappings. May only occur in documents parsed with {{Code|parameter-document}}If mappings are supplied as a single string, keys and values are separated by the equal sign, and multiple pairs are separated by commas. Separators that are to be defined as keys or values can be encoded as entities.<br/>Example: <code>A=alpha,B=beta</code>| ''string''

| Escapes URI information in certain HTML attributes<br />Example: <code>&lt;a&nbsp;href="%C3%A4%C3%B6%C3%BC"&gt;äöü&lt;a&gt;</code>

| Inserts a {{Code|meta}} content-type element into the head element if the result is output as HTML<br />Example: <code>&lt;head&gt;&lt;meta http-equiv="Content-Type" content="text/html; charset=UTF-8"&gt;&lt;/head&gt;</code>. The head element must already exist or nothing will be added. Any existing {{Code|meta}} content-type elements will be removed.

| {{Code|noyes}}|} =Query Prolog Parameters= The following parameters can only be specified in the query prolog (see [https://www.w3.org/TR/xquery-31/#id-serialization XQuery: Specification] for more details and examples): {| class="wikitable sortable" width="100%"|- valign="top"! width="140" | Parameter! Description! Allowed! Default|- valign="top"| {{Code|parameter-document}}| Parses the value as an XML document with additional serialization parameters.| ''string''|

<pre classlang="brush:'xquery"'>(: The output namespace declaration is optional, because it is statically declared in BaseX) :)declare namespace output = "http://www.w3.org/2010/xslt-xquery-serialization";

<pre classlang="brush:'xquery"'>

<pre classlang="brush:xml">

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 “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 [httphttps://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document.

<pre classlang="brush:'xquery"'>

<pre classlang="brush:xml">

* Updated: <code>method=html5</code> removed; serializers updated with the [httphttps://www.w3.org/TR/2013/WD-xslt-xquery-serialization-30-20130108/ latest version of the specification], using <code>method=html</code> and <code>version=5.0</code>.