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 [http://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document. In BaseX, they can be specified by: * by including them in the [[XQuery_3.0#Serialization|prolog of the XQuery expression]],;* by specifying them in the XQuery functions [[File_Module#file:write|file:write()]] or [[XQuery_3.0#Functions|fn:serialize()]],*: . The serialization parameters can either be are specifiedas** as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element, as defined for the [http://www.w3.org/TR/xpath-functions-30/#func-serialize fn:serialize()] function;, or as** as map, which contains all key/value pairs:**: <pre class="brush:xml"code>map { "method" := "xml", "cdata-section-elements" := "div", ... }</precode>;* by using the {{Code|-s}} flag of the BaseX [[Command-Line Options#BaseX Standalone|command-line]] clients,;* by setting the [[Options#SERIALIZER{{Option|SERIALIZER]] }} option before running a query,;* by setting the [[Options#EXPORTER{{Option|EXPORTER]] }} option before exporting a database, ; or* by setting them as [[REST#Parameters|REST]] query parameters<br/>. 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.

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

! width="60%" | Description

| Specifies the serialization method:* . {{Code|xml}}, {{Code|xhtml}}, {{Code|html}}, {{Code|text}} and {{Code|textadaptive}} are adopted from part of the official specification.* For more details on {{Code|jsonbasex}} is specific to BaseX and can be used to output XML nodes as JSON objects (see the [[JSON Module]] for more details).* , {{Code|csv}} is BaseX-specific and can be used to output XML nodes as CSV data (see the [[CSV Module]] for more details).* {{Code|rawjson}} is BaseX-specific, too: Binary data types are output in their ''raw'' form, i.e., without modifications. For all other types, the items’ string values are returned. No indentation takes place, and and no characters are encoded via entitiessee [[XQuery Extensions#Serialization|XQuery Extensions]].| {{Code|xml}}, {{Code|xhtml}}, {{Code|html}}, {{Code|text}}, {{Code|json}}, {{Code|adaptive}}, {{Code|csv}}, {{Code|rawbasex}}| {{Code|xmlbasex}}

| {{Code|xml/xhtml}}: {{Code|1.0}}, {{Code|1.1}}<br/>{{Code|html}}: {{Code|4.0}}, {{Code|4.01}}, {{Code|5.0}}<br/>

| ''arbitrary strings'', {{Code|\n}}, {{Code|\r\n}}, {{Code|\r}}

| Defines character mappings (not supported). May only occur in documents parsed with {{Code|parameter-document}}.

| Includes 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}}

BaseX provides some additional, implementation-specific serialization parameters:

! width="60%" | Description

| Defines the way how data is serialized as CSV. {{Version|7.8}}

| Defines the way how data is serialized as JSON. {{Version|7.8}}

* Added: {{Code|csv}} and {{Code|json}} serialization parameters.* Removed: {{Code|separator}} option (use {{Code|item-separator}} instead).

* Added: {{Code|csv}} serialization method.* Added: temporary serialization methods {{Code|csv-header}}, {{Code|csv-separator}}, {{Code|json-unescape}}, {{Code|json-spec}}, {{Code|json-format}}.

* Added: official {{Code|item-separator}} and {{Code|html-version}} parameter.

* Added: {{Code|separator}} parameter.

* Added: {{Code|newline}} parameter.

* Added: Serialization parameters added to [[REST API]]; JSON/JsonML/raw methods.