Skip to content
Permalink
Browse files

Added docs for saxon-configuration option; p:system-property extensions

  • Loading branch information
ndw committed Dec 8, 2011
1 parent f72b949 commit 65cf8a6b6710381302a1105e1e0d4ae2df314368
Showing with 92 additions and 2 deletions.
  1. +35 −0 docs/src/configuration.xml
  2. +55 −1 docs/src/extensions.xml
  3. +1 −1 docs/src/ref.xml
  4. +1 −0 docs/src/running.xml
@@ -55,6 +55,41 @@ request schema aware processing, the processor option is treated as if you'd
requested “<literal>ee</literal>” irrespective of what you actually specified.</para>
</section>

<section xml:id="cfg.saxon-configuration">
<title>Saxon configuration</title>

<para>The Saxon “professional edition” and
“enterprise edition” processors can load an
<link xlink:href="http://saxonica.com/documentation/configuration/configuration-file.xml">external
configuration file</link> to control various aspects of the Saxon processor.
There are three ways to specify the location of this file:
</para>

<informaltable frame="none" role="cfgprop">
<tgroup cols="2" colsep="0" rowsep="0">
<tbody>
<row>
<entry>Command line (long):</entry>
<entry><literal>--saxon-configuration</literal>=<replaceable>filename</replaceable></entry>
</row>
<row>
<entry>Java system property:</entry>
<entry><property>com.xmlcalabash.saxon-configuration</property>=<replaceable>filename</replaceable></entry>
</row>
<row>
<entry>XML configuration:</entry>
<entry><tag class="starttag">cc:saxon-configuration</tag><replaceable>filename</replaceable><tag class="endtag">cc:saxon-configuration</tag></entry>
</row>
</tbody>
</tgroup>
</informaltable>

<para>The settings in this file take precedence over other, related settings
available in Calabash (for example, schema awareness or processor type).
This option will cause <citetitle>XML Calabash</citetitle> to throw an error
if you are using “home edition”.</para>
</section>

<section xml:id="cfg.schema-aware">
<title>Schema aware processing</title>

@@ -4,6 +4,60 @@
xml:id="extensions" version="5.0">
<title>Extensions</title>

<section xml:id="extprop">
<title>System property extensions</title>

<para><citetitle>XML Calabash</citetitle> supports several additional
property names in <function>p:system-property</function>:
</para>

<variablelist>
<varlistentry><term>cx:transparent-json</term>
<listitem>
<para>Returns “<literal>true</literal>” if the
<link linkend="ext.transparent-json">transparent JSON</link> extension
is enabled, “<literal>false</literal>” otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry><term>cx:json-flavor</term>
<listitem>
<para>Returns the flavor of JSON returned by the transparent JSON extension,
if it's enabled.
</para>
</listitem>
</varlistentry>
<varlistentry><term>cx:general-values</term>
<listitem>
<para>Returns “<literal>true</literal>” if the
<link linkend="ext.general-values">general values</link> extension
is enabled, “<literal>false</literal>” otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry><term>cx:xpointer-on-text</term>
<listitem>
<para>Returns “<literal>true</literal>” if the
<link linkend="ext.xpointer-on-text">XPointer on text</link> extension
is enabled, “<literal>false</literal>” otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry><term>cx:saxon-version</term>
<listitem>
<para>Returns the version of the underlying Saxon processor.
</para>
</listitem>
</varlistentry>
<varlistentry><term>cx:saxon-edition</term>
<listitem>
<para>Returns the edition of the underlying Saxon processor (“he”, “pe”, or “ee”).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>

<section xml:id="extattr">
<title>Extension Attributes</title>

@@ -108,7 +162,7 @@ configuration option.</para>
<literal>cx:general-values</literal>.</para>

</section>
<section xml:id="ext.xpointer-on-text-">
<section xml:id="ext.xpointer-on-text">
<title>XPointer on text</title>

<para>If the XPointer on text extension is enabled, the <tag class="attribute">xpointer</tag>
@@ -21,7 +21,7 @@
<firstname>Norman</firstname><surname>Walsh</surname>
</personname>
</author>
<releaseinfo>0.4</releaseinfo>
<releaseinfo>0.5</releaseinfo>
<copyright>
<year>2011</year>
<holder>Norman Walsh</holder>
@@ -40,6 +40,7 @@ will run Java with the correct class path and other arguments.</para>
<cmdsynopsis>
<command><replaceable>calabash</replaceable></command>
<arg>--saxon-processor <replaceable>processortype</replaceable></arg>
<arg>--saxon-configuration <replaceable>filename</replaceable></arg>
<arg>--schema-aware</arg>
<arg>--debug</arg>
<arg>--safe-mode</arg>

0 comments on commit 65cf8a6

Please sign in to comment.
You can’t perform that action at this time.