Changes

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 [https://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document. In BaseX, they can be specified by:

* including them included in the [[XQuery_3.0#Serialization|prolog of the XQuery expression]];* specifying them specified in the XQuery functions [[File_Module#file:write({{Function|File|file:write()]] or [[XQuery_3.0#Functions|fn:serialize()]]. The serialization parameters are specified as** children of an }}, {{CodeFunction|Database|&lt;outputdb:serialization-parameters/&gt;export}} element, as defined for the [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()] function, or as);** map, which contains all key/value pairs: <code>map { "method": "xml", "cdata-section-elements": "div", ... }</code>specified in [[REST#Parameters|REST query parameters]];* using the {{Code|-s}} flag of the BaseX specified in [[Command-Line OptionsRESTXQ#BaseX StandaloneOutput|command-lineRESTXQ output annotations]] clients;* setting set via the {{Option|SERIALIZER}} option before running a query;* setting set via the {{Option|EXPORTER}} option before exporting a database; or* setting them as supplied with the {{Code|-s}} flag of the BaseX [[RESTCommand-Line Options#ParametersBaseX Standalone|RESTcommand-line]] 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 implementationclients.

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

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

| {{Code|yesno}} {{Announce|Default changed with Version 10}}

| ''string''

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

|''string''

| ''string''

| ''string''

| Parses the value as XML document with additional serialization parameters (see the [https://www.w3.org/TR/xslt-xquery-serialization-31/#serparams-in-xdm-instance Serialization Specification] for more detailsand examples).| ''string''

| Defines character mappings. May only occur in documents parsed with {{Code|parameter-document}}If mappings are supplied as 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''

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