Skip to content

Commit b29a278

Browse files
Jay Bryantbclozel
authored andcommitted
Edit Data Access part of the reference documentation
I edited the Data Access chapter for spelling, punctuation, grammar, usage, corporate voice, and clarity. I also added links and cross-references.
1 parent 95ff22c commit b29a278

File tree

2 files changed

+2104
-1708
lines changed

2 files changed

+2104
-1708
lines changed

src/docs/asciidoc/data-access-appendix.adoc

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,79 +5,84 @@
55
[[xsd-schemas]]
66
== XML Schemas
77

8-
This part of the appendix lists XML schemas for data access.
8+
This part of the appendix lists XML schemas for data access, including the following:
9+
10+
* <<xsd-schemas-tx>>
11+
* <<xsd-schemas-jdbc>>
912

1013

1114

1215
[[xsd-schemas-tx]]
13-
=== The `tx` schema
16+
=== The `tx` Schema
1417

1518
The `tx` tags deal with configuring all of those beans in Spring's comprehensive support
1619
for transactions. These tags are covered in the chapter entitled
1720
<<data-access.adoc#transaction,Transaction Management>>.
1821

19-
[TIP]
20-
====
21-
22-
You are strongly encouraged to look at the `'spring-tx.xsd'` file that ships with the
23-
Spring distribution. This file is (of course), the XML Schema for Spring's transaction
24-
configuration, and covers all of the various tags in the `tx` namespace, including
25-
attribute defaults and suchlike. This file is documented inline, and thus the
22+
TIP: We strongly encourag you to look at the `'spring-tx.xsd'` file that ships with the
23+
Spring distribution. This file contains the XML Schema for Spring's transaction
24+
configuration and covers all of the various elements in the `tx` namespace, including
25+
attribute defaults and similar information. This file is documented inline, and, thus, the
2626
information is not repeated here in the interests of adhering to the DRY (Don't Repeat
2727
Yourself) principle.
2828
====
2929
30-
In the interest of completeness, to use the tags in the `tx` schema, you need to have
31-
the following preamble at the top of your Spring XML configuration file; the text in the
30+
In the interest of completeness, to use the elements in the `tx` schema, you need to have
31+
the following preamble at the top of your Spring XML configuration file. The text in the
3232
following snippet references the correct schema so that the tags in the `tx` namespace
33-
are available to you.
33+
are available to you:
3434
35+
====
3536
[source,xml,indent=0]
3637
[subs="verbatim,quotes"]
3738
----
3839
<?xml version="1.0" encoding="UTF-8"?>
3940
<beans xmlns="http://www.springframework.org/schema/beans"
4041
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4142
xmlns:aop="http://www.springframework.org/schema/aop"
42-
__xmlns:tx="http://www.springframework.org/schema/tx"__ xsi:schemaLocation="
43+
xmlns:tx="http://www.springframework.org/schema/tx" xsi:schemaLocation=" <1>
4344
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
44-
__http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd__
45+
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd <2>
4546
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd"> <!-- bean definitions here -->
4647
4748
</beans>
4849
----
49-
50-
[NOTE]
50+
<1> Specify the namespace.
51+
<2> Specify the location (with other schema locations).
5152
====
52-
Often when using the tags in the `tx` namespace you will also be using the tags from the
53+
54+
NOTE: Often, when you use the elements in the `tx` namespace, you are also using the elements from the
5355
`aop` namespace (since the declarative transaction support in Spring is implemented
54-
using AOP). The above XML snippet contains the relevant lines needed to reference the
55-
`aop` schema so that the tags in the `aop` namespace are available to you.
56-
====
56+
by using AOP). The preceding XML snippet contains the relevant lines needed to reference the
57+
`aop` schema so that the elements in the `aop` namespace are available to you.
5758
5859
5960
6061
[[xsd-schemas-jdbc]]
61-
=== The `jdbc` schema
62+
=== The `jdbc` Schema
6263
63-
The `jdbc` tags allow you to quickly configure an embedded database or initialize an
64-
existing data source. These tags are documented in
65-
<<data-access.adoc#jdbc-embedded-database-support,Embedded database support>>
66-
and <<data-access.adoc#jdbc-initializing-datasource,Initializing a DataSource>> respectively.
64+
The `jdbc` elements let you quickly configure an embedded database or initialize an
65+
existing data source. These elements are documented in
66+
<<data-access.adoc#jdbc-embedded-database-support,Embedded Database Support>>
67+
and <<data-access.adoc#jdbc-initializing-datasource,Initializing a DataSource>>, respectively.
6768
68-
To use the tags in the `jdbc` schema, you need to have the following preamble at the top
69-
of your Spring XML configuration file; the text in the following snippet references the
70-
correct schema so that the tags in the `jdbc` namespace are available to you.
69+
To use the elements in the `jdbc` schema, you need to have the following preamble at the top
70+
of your Spring XML configuration file. The text in the following snippet references the
71+
correct schema so that the elements in the `jdbc` namespace are available to you:
7172
73+
====
7274
[source,xml,indent=0]
7375
[subs="verbatim,quotes"]
7476
----
7577
<?xml version="1.0" encoding="UTF-8"?>
7678
<beans xmlns="http://www.springframework.org/schema/beans"
7779
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
78-
__xmlns:jdbc="http://www.springframework.org/schema/jdbc"__ xsi:schemaLocation="
80+
xmlns:jdbc="http://www.springframework.org/schema/jdbc" xsi:schemaLocation=" <2>
7981
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
80-
__http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd"__> <!-- bean definitions here -->
82+
http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd"> <!-- bean definitions here --> <2>
8183
8284
</beans>
8385
----
86+
<1> Specify the namespace.
87+
<2> Specify the location (with other schema locations).
88+
====

0 commit comments

Comments
 (0)