Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Migrate reference guide to well-formed docbook XML

Browse Source 
Convert all docbook XML files to well-formed docbook 5 syntax:
 - Include xsi:schemaLocation element for tools support
 - Convert all id elements to xml:id
 - Convert all ulink elements to link
 - Simplify <lineannotation> mark-up
 - Fix misplaced </section> tags
 - Fix <interface> tags to <interfacename>
 - Cleanup trailing whitespace and tabs

Issue: SPR-10032
This commit is contained in:
Phillip Webb
2012-11-25 18:04:46 -08:00
parent 89b443c198
commit c37080d49d
50 changed files with 5765 additions and 5383 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
src/reference/docbook/cci.xml
View File

@@ -1,11 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
<chapter xml:id="cci"
xmlns="http://docbook.org/ns/docbook" version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="cci">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
<title>JCA CCI</title>
<section id="cci-introduction">
<section xml:id="cci-introduction">
<title>Introduction</title>
<para>Java EE provides a specification to standardize access to enterprise
@@ -45,10 +49,10 @@
</note>
</section>
<section id="cci-config">
<section xml:id="cci-config">
<title>Configuring CCI</title>
<section id="cci-config-connector">
<section xml:id="cci-config-connector">
<title>Connector configuration</title>
<para>The base resource to use JCA CCI is the
@@ -90,7 +94,7 @@
</note>
</section>
<section id="cci-config-connectionfactory">
<section xml:id="cci-config-connectionfactory">
<title><interfacename>ConnectionFactory</interfacename> configuration in
Spring</title>
@@ -133,7 +137,7 @@
</note>
</section>
<section id="cci-config-cci-connections">
<section xml:id="cci-config-cci-connections">
<title>Configuring CCI connections</title>
<para>JCA CCI allow the developer to configure the connections to the
@@ -192,7 +196,7 @@
&lt;/bean&gt;</programlisting>
</section>
<section id="cci-config-single-connection">
<section xml:id="cci-config-single-connection">
<title>Using a single CCI connection</title>
<para>If you want to use a single CCI connection, Spring provides a
@@ -232,10 +236,10 @@
</section>
</section>
<section id="cci-using">
<section xml:id="cci-using">
<title>Using Spring's CCI access support</title>
<section id="cci-record-creator">
<section xml:id="cci-record-creator">
<title>Record conversion</title>
<para>One of the aims of the JCA CCI support is to provide convenient
@@ -299,7 +303,7 @@
}</programlisting>
</section>
<section id="cci-using-template">
<section xml:id="cci-using-template">
<title>The <classname>CciTemplate</classname></title>
<para>The <classname>CciTemplate</classname> is the central class of the
@@ -408,7 +412,7 @@
}</programlisting>
</section>
<section id="cci-using-dao">
<section xml:id="cci-using-dao">
<title>DAO support</title>
<para>Spring's CCI support provides a abstract class for DAOs,
@@ -433,7 +437,7 @@
}</programlisting>
</section>
<section id="automatic-output-generation">
<section xml:id="automatic-output-generation">
<title>Automatic output record generation</title>
<para>If the connector used only supports the
@@ -473,13 +477,13 @@
</note>
</section>
<section id="template-summary">
<section xml:id="template-summary">
<title>Summary</title>
<para>The following table summarizes the mechanisms of the
<classname>CciTemplate</classname> class and the corresponding methods
called on the CCI <interfacename>Interaction</interfacename>
interface:<table frame="all" id="cci-interaction-execute-methods">
interface:<table frame="all" xml:id="cci-interaction-execute-methods">
<title>Usage of <interfacename>Interaction</interfacename> execute
methods</title>
@@ -601,7 +605,7 @@
</table></para>
</section>
<section id="cci-straight">
<section xml:id="cci-straight">
<title>Using a CCI <interfacename>Connection</interfacename> and
<interfacename>Interaction</interfacename> directly</title>
@@ -646,7 +650,7 @@
</note>
</section>
<section id="cci-template-example">
<section xml:id="cci-template-example">
<title>Example for <classname>CciTemplate</classname> usage</title>
<para>In this section, the usage of the
@@ -700,7 +704,7 @@ interactionSpec.setInteractionVerb(ECIInteractionSpec.SYNC_SEND_RECEIVE);</progr
new ConnectionCallback() {
public Object doInConnection(Connection connection, ConnectionFactory factory)
throws ResourceException {
<lineannotation>// do something...</lineannotation>
}
});
@@ -771,7 +775,7 @@ interactionSpec.setInteractionVerb(ECIInteractionSpec.SYNC_SEND_RECEIVE);</progr
</section>
</section>
<section id="cci-object">
<section xml:id="cci-object">
<title>Modeling CCI access as operation objects</title>
<para>The <literal>org.springframework.jca.cci.object</literal> package
@@ -788,7 +792,7 @@ interactionSpec.setInteractionVerb(ECIInteractionSpec.SYNC_SEND_RECEIVE);</progr
<interfacename>RecordExtractor</interfacename> interfaces, reusing the
machinery of Spring's core CCI support.</para>
<section id="cci-object-mapping-record">
<section xml:id="cci-object-mapping-record">
<title><classname>MappingRecordOperation</classname></title>
<para><classname>MappingRecordOperation</classname> essentially performs
@@ -847,7 +851,7 @@ MyMappingRecordOperation eisOperation = new MyMappingRecordOperation(getConnecti
...</programlisting>
</section>
<section id="cci-object-mapping-comm-area">
<section xml:id="cci-object-mapping-comm-area">
<title><classname>MappingCommAreaOperation</classname></title>
<para>Some connectors use records based on a COMMAREA which represents
@@ -872,7 +876,7 @@ MyMappingRecordOperation eisOperation = new MyMappingRecordOperation(getConnecti
}</programlisting>
</section>
<section id="cci-automatic-record-gen">
<section xml:id="cci-automatic-record-gen">
<title>Automatic output record generation</title>
<para>As every <classname>MappingRecordOperation</classname> subclass is
@@ -883,13 +887,13 @@ MyMappingRecordOperation eisOperation = new MyMappingRecordOperation(getConnecti
information, see <xref linkend="automatic-output-generation" />.</para>
</section>
<section id="cci-object-summary">
<section xml:id="cci-object-summary">
<title>Summary</title>
<para>The operation object approach uses records in the same manner as
the <classname>CciTemplate</classname> class.</para>
<table frame="all" id="cci-interaction-methods">
<table frame="all" xml:id="cci-interaction-methods">
<title>Usage of Interaction execute methods</title>
<tgroup cols="3">
@@ -931,7 +935,7 @@ MyMappingRecordOperation eisOperation = new MyMappingRecordOperation(getConnecti
</table>
</section>
<section id="cci-objects-mappring-record-example">
<section xml:id="cci-objects-mappring-record-example">
<title>Example for <classname>MappingRecordOperation</classname>
usage</title>
@@ -1045,7 +1049,7 @@ MyMappingRecordOperation eisOperation = new MyMappingRecordOperation(getConnecti
&lt;/bean&gt;</programlisting>
</section>
<section id="cci-objects-mapping-comm-area-example">
<section xml:id="cci-objects-mapping-comm-area-example">
<title>Example for <classname>MappingCommAreaOperation</classname>
usage</title>
@@ -1130,7 +1134,7 @@ MyMappingRecordOperation eisOperation = new MyMappingRecordOperation(getConnecti
</section>
</section>
<section id="cci-tx">
<section xml:id="cci-tx">
<title>Transactions</title>
<para>JCA specifies several levels of transaction support for resource