Skip to content
Browse files

Assorted markup tweaks

  • Loading branch information...
1 parent 0fcad01 commit 9566b139a6b0552c45736838f69048c8181b7725 Zearin committed Jul 12, 2013
View
2 src/docbook/patterns/abstraction/collection.xml
@@ -116,7 +116,7 @@
<para>In this example the Collection Element was needed to establish a context for the
exchange data. Without a collection element, this information would have to be
- duplicated in every Stock element.</para>
+ duplicated in every <tag class="element">Stock</tag> element.</para>
</section>
<section>
View
18 src/docbook/patterns/abstraction/optional-container.xml
@@ -13,23 +13,21 @@
<abstract>
<para>When creating large DTDs with many logical units authors might be required to learn a
- large number of these logical units to know how to use the DTD. By hiding the details of
- optional parts of the DTD beneath optional elements, some of this complexity can be
- reduced.</para>
+ large number of these logical units to know how to use the DTD.
+ By hiding the details of optional parts of the DTD beneath optional elements,
+ some of this complexity can be reduced.</para>
</abstract>
</info>
<section>
<title>Problem</title>
- <para>In a DTD with many logical units, an author of a document can be overwhelmed with the
- number of choices that have to be made.</para>
+ <para>In a DTD with many logical units, an author of a document can be overwhelmed with the number of choices that have to be made.</para>
</section>
<section>
<title>Context</title>
- <para>In large, general-purpose DTDs where many logical units are presented, and more than
- one of the units is optional. The document will be authored by humans.</para>
+ <para>In large, general-purpose DTDs where many logical units are presented, and more than one of the units is optional. The document will be authored by humans.</para>
</section>
<section>
@@ -129,9 +127,9 @@
<!ATTLIST metadata owner CDATA #REQUIRED>
]]></programlisting>
- <para>When generating an XBEL document, the info element is not required. This means that if
- the author was never interested in creating an info element, he would not need to know
- about the info element, the metadata element, or the owner attribute, thus eliminating 3
+ <para>When generating an <acronym>XBEL</acronym> document, the <tag class="element">info</tag> element is not required. This means that if
+ the author was never interested in creating an <tag class="element">info</tag> element, he would not need to know
+ about the <tag class="element">info</tag> element, the <tag class="element">metadata</tag> element, or the <tag class="attribute">owner</tag> attribute, thus eliminating 3
logical units from what the author needs to learn.</para>
</section>
View
12 src/docbook/patterns/consistency/common-attributes.xml
@@ -12,8 +12,7 @@
<title>Common Attributes</title>
<abstract>
- <para>Provide a set of attributes that can be placed on all, or most, elements in the
- document type.</para>
+ <para>Provide a set of attributes that can be placed on all, or most, elements in the document type.</para>
</abstract>
</info>
@@ -127,10 +126,11 @@
<section>
<title>Known Uses</title>
- <para>The XMLspec DTD Common Attributes Chapter explains the use of Common Attributes in the
- DTD.</para>
- <para>XHTML defines a set of core attributes. These attributes are applied to almost every
- element in the XHTML document type. The core attributes are defined like this:</para>
+ <para>The XMLspec DTD Common Attributes Chapter explains the use of Common Attributes in the DTD.</para>
+ <para>
+ XHTML defines a set of core attributes.
+ These attributes are applied to almost every element in the XHTML document type.
+ The core attributes are defined like this:</para>
<programlisting language="xml"><![CDATA[
<!ENTITY % coreattrs
View
10 src/docbook/patterns/consistency/parallel-design.xml
@@ -57,7 +57,7 @@
]]></programlisting>
- <para>These two elements &quot;Figure&quot; and &quot;Table&quot; have very similar content
+ <para>These two elements <tag class="element">Figure</tag> and <tag class="element">Table</tag> have very similar content
and identical attribute lists. This makes it very easy for authors of the document. Once
they have learned the structure of one of the elements, the other one will be easy to
use. The more variation there is between the two, the easier it is to confuse the two
@@ -68,10 +68,10 @@
<para>The more consistent the structure of various elements is the easier it is to learn to
use a document type. Subtle differences in structure can be particularly difficult to
- learn. If, for example, in the above example, one of the &quot;id&quot; attributes was
+ learn. If, for example, in the above example, one of the <tag class="attribute">id</tag> attributes was
IMPLIED and the other one was REQUIRED, this would be a difficult distinction to
remember. Users would constantly need to refer to the documentation to remind them which
- element’s id was required and which one wasn’t.</para>
+ element’s <tag class="attribute">id</tag> was required and which one wasn’t.</para>
</section>
<section>
<title>Related Patterns</title>
@@ -100,8 +100,8 @@
</programlisting>
- <para>All four of the elements have identical content model. This helps enormously in
- learning the specifics of this DTD.</para>
+ <para>All four of the elements have identical content model.
+ This helps enormously in learning the specifics of this DTD.</para>
</section>
<section>
<title>References</title>
View
6 src/docbook/patterns/flexibility/catch-all.xml
@@ -48,8 +48,7 @@
<example>
<title>Example</title>
- <para>This example shows how a document that describes a car would allow a comment
- element that includes elements from HTML.</para>
+ <para>This example shows how a document that describes a car would allow a comment element that includes elements from HTML.</para>
<programlisting language="xml"><![CDATA[
<car>
<model>Pinto</model>
@@ -65,8 +64,7 @@
<example>
<title>Example</title>
- <para>To allow this type of inclusion using an XML Schema, use the any element as
- follows:</para>
+ <para>To allow this type of inclusion using an XML Schema, use the any element as follows:</para>
<programlisting language="xml"><![CDATA[
<element name="car">
<complexType>
View
2 src/docbook/patterns/metadata/head-body.xml
@@ -136,7 +136,7 @@
<title>Known Uses</title>
<para><tag class="element">HEAD</tag> and <tag class="element">BODY</tag> elements in XHTML.</para>
- <para>SOAP (Simple Object Access Protocol) uses Header and Body Elements inside an <link xl:href="/patterns/organization/envelope.xml">Envelope</link>
+ <para>SOAP (Simple Object Access Protocol) uses <tag class="element">Header</tag> and <tag class="element">Body</tag> Elements inside an <link xl:href="/patterns/organization/envelope.xml">Envelope</link>
element.</para>
</section>

0 comments on commit 9566b13

Please sign in to comment.
Something went wrong with that request. Please try again.