Changes

Serialization parameters define how XQuery items and XML nodes are textually output, i.e., ''serialized''.They have been formalized in This page is part of the [http://www.w3.org/TR/xslt-xquery-serialization-30 W3C [XQuery|XQuery Serialization 3.0Portal]] document.In BaseX, they can be specified in several ways:

* by using the <code>-s</code> flag of the BaseX [[Startup_Options#BaseX|command-line]] clientsSerialization parameters define how XQuery items and XML nodes will be ''serialized'' (i.e.,* by setting returned to the [[Options#Query options|SERIALIZER]] option before running a query,* by setting the [[Options#Query options|EXPORTER]] option before exporting a database,* by setting them via the [[JAX-RX_API#Query_Parameters|Output Parameter]] of the JAX-RX client or an API,* by including them usually in textual form). The official parameters are defined in the [[XQuery_3https://www.w3.0#org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization|prolog of the XQuery expression]3.1] (since XQuery 3document.0)In BaseX, or* by specifying them in the XQuery function [[File_Functions#filethey can be:write|file:write()]].

==* 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 following table gives a brief summary of all namespace for serialization parameters recognized by BaseX. For details, please refer is statically bound to official specificationthe {{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= The following serialization parameters are supported by BaseX (further details can be looked up in the official specification): {| class="wikitablesortable" width="100%"

! width="140" | Parameter

| <code>{{Code|method}}| Specifies the serialization method. {{Code|xml}}, {{Code|xhtml}}, {{Code|html}}, {{Code|text}} and {{Code|adaptive}} are part of the official specification. For more details on {{Code|basex}}, {{Code|csv}} and {{Code|json}}, see [[XQuery Extensions#Serialization|XQuery Extensions]].| {{Code|xml}}, {{Code|xhtml}}, {{Code|html}}, {{Code|text}}, {{Code|json}}, {{Code|adaptive}}, {{Code|csv}}, {{Code|basex}}| {{Code|basex}}|- valign="top"| {{Code|version</code>}}| Specifies the XML versionof the serialization method.| <code>xml/xhtml: {{Code|1.0}},{{Code|1.1}}<br/code>html: {{Code|4.0}}, {{Code|4.01}}, {{Code| 5.0}}<codebr/>| {{Code|1.0</code>}}|- valign="top"| {{Code|html-version}}| <code>Specifies the versionof the HTML serialization method.| {{Code|4.0}}, {{Code|4.01}}, {{Code|5.0}}| {{Code|4.0}}|- valign=1"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.0</code>| ''string''|

| <code>{{Code|encoding</code>}}

|''[https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html all encodings supported by Java]''| <code>{{Code|UTF-8</code>| <code>encoding=US-ASCII</code>}}

| <code>{{Code|indent</code>}}| Adjusts Adds leading whitespaces to make the output better more readable.| <code>{{Code|yes}},{{Code|no</code>}}| <code>yes</code>{{Code| <code>indent=no</code>}}

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

| <code>{{Code|omit-xml-declaration</code>}}| 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>| <code>{{Code|yes}},{{Code|no</code>}}| <code>{{Code|yes</code>| <code>omit-xml-declaration=no</code>}}

| <code>{{Code|standalone</code>}}| Prints or omits the "{{Code|standalone" }} attribute in the XML declaration.| <code>{{Code|yes}},{{Code|no}},{{Code|omit</code>}}| <code>{{Code|omit</code>| <code>standalone=yes</code>}}

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

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

| <code>{{Code|undeclare-prefixes</code>}}

| <code>{{Code|yes}},{{Code|no</code>}}| <code>{{Code|no</code>| <code>undeclare-prefixes=yes</code>}}

| <code>{{Code|normalization-form</code>}}| Specifies a normalization form. BaseX supports Form C (<code>{{Code|NFC</code>}}).| <code>{{Code|NFC}},{{Code|none</code>}}| <code>{{Code|NFC</code>| <code>normalization-form=none</code>}}

| <code>{{Code|media-type</code>}}

| ''string''| <code>{{Code|application/xml</code>| <code>media-type=text/plain</code>}}

| <code>{{Code|use-character-maps}}| Defines character mappings. 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>| Defines character mappings (not supported).''string''

| <code>{{Code|byte-order-mark</code>}}

| <code>{{Code|yes}},{{Code|no</code>}}| <code>{{Code|no</code>| <code>byte-order-mark=yes</code>}}

| <code>{{Code|escape-uri-attributes</code>}}| 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>| <code>{{Code|yes}},{{Code|no</code>}}| <code>{{Code|no</code>| <code>escape-uri-attributes=yes, method=html</code>}}

| <code>{{Code|include-content-type</code>}}| Includes Inserts a <code>{{Code|meta</code> }} 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>{{Code|yes}},{{Code|no</code>}}| <code>no</code>{{Code| <code>include-content-type=yes, method=html</code>}}

BaseX provides some additional, implementation-defined serialization parameters (<font color="orange">Version 6.5.1</font>):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="wikitablesortable" 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''| |} =Custom Parameters= BaseX provides some additional serialization parameters: {| class="wikitable sortable" width="100%"

! width="140" | Parameter

| <code>format</code>{{Code|csv}}| Turns output formatting on/off. This Defines the way how data is helpful for suppressing unwanted indentation of plain textserialized as CSV.| <code>yes,no</code>| <code>yes</code>see [[CSV Module]]| <code>format=no</code>

| <code>tabulator</code>{{Code|json}}| Uses tab characters (<code>\t</code>) for indenting elementsDefines the way how data is serialized as JSON.| see [[JSON Module]]

| <code>{{Code|tabulator}}| Uses tab characters ({{Code|\t}}) instead of spaces for indenting elements.| {{Code|yes}}, {{Code|no}}| {{Code|no}}|- valign="top"| {{Code|indents</code>}}

| ''positive number''| <code>{{Code|2</code>}}| <code>indents- valign=1"top"| {{Code|indent-attributes}}| {{Announce|Version 11:}} Indent attributes after the element name, one below the other.| {{Code|yes}}, {{Code|no}}| {{Code|false}}|- valign="top"| {{Code|newline}}| Specifies the type of newline to be used as end-of-line marker. | {{Code|\n}}, {{Code|\r\n}}, tabulator{{Code|\r}}| ''system dependent''|- valign=yes</code>"top"| {{Code|limit}}| Stops serialization after the specified number of bytes has been serialized. If a negative number is specified, everything will be output.| ''positive number''| {{Code|-1}}

| {{Code|binary}}| Indicates if items of binary type are output in their native byte representation. Only applicable to the <code>wrap-prefix</code>,<br /><code>wrap-uribase</code>serialization method.| Specifies a prefix and/or URI for wrapping the query results.{{Code|yes}}, {{Code| no}}| {{Code| <code>wrap-prefix=jax-rx, wrap-uri=http://jax-rx.sourceforge.net</code>yes}}