Skip to content
Browse files

Under .../patterns, use `xref`s for all references to other patterns …

…in all “Related Patterns” sections
  • Loading branch information...
1 parent 9d5bdb3 commit 6eb9611d18fce6be19360a4d524042539547ec11 Zearin committed Jul 12, 2013
View
7 src/docbook/patterns/abstraction/choice-reducing-container.xml
@@ -108,15 +108,14 @@
<section>
<title>Related Patterns</title>
- <para>This Choice Reducing Container is similar to the Optional Container Element in that
+ <para>This Choice Reducing Container is similar to the <xref xl:href="optional-container.xml"/> in that
they both try to make the DTD easier to use by the author by introducing new element
types. Existing elements are grouped together as children of the new element. One
difference between the two is the context they are used in. The Choice Reducing
- Container relates elements that are all choices in a content group while the Optional
- Container Element relates optional elements from the content group.</para>
+ Container relates elements that are all choices in a content group while the <xref xl:href="optional-container.xml"/> relates optional elements from the content group.</para>
<para>The motivation for the two is also different. In the Choice Reducing Container, the
amount of information at any one point is reduced, but it is not intended to reduce the
- overall complexity of the document for a single author. The Optional Container Element
+ overall complexity of the document for a single author. The <xref xl:href="optional-container.xml"/>
hides parts of the structure permanently from the view of individual authors. It is
likely that some authors will never use certain parts of large DTDs.</para>
</section>
View
2 src/docbook/patterns/abstraction/collection.xml
@@ -134,7 +134,7 @@
<section>
<title>Related Patterns</title>
- <para>This is a specialization of the Container Element pattern.</para>
+ <para>This is a specialization of the <xref xl:href="container.xml"/> pattern.</para>
</section>
<section>
View
6 src/docbook/patterns/abstraction/container.xml
@@ -91,10 +91,8 @@
<section>
<title>Related Patterns</title>
- <para>The <link xl:href="/patterns/organization/marketplace.xml">Marketplace</link> pattern can be used if there is more than one category that can apply
- to each type.</para>
- <para>The <link xl:href="/patterns/metadata/head-body.xml">Head-Body pattern</link> uses two specific types of Container Elements, one for metadata
- and one for content.</para>
+ <para>The <xref xl:href="/patterns/organization/marketplace.xml" /> pattern can be used if there is more than one category that can apply to each type.</para>
+ <para>The <xref xl:href="/patterns/metadata/head-body.xml" /> pattern uses two specific types of Container Elements, one for metadata and one for content.</para>
<para>The <tag class="element">Collection</tag> Element is a container for single type of element.</para>
</section>
View
12 src/docbook/patterns/abstraction/optional-container.xml
@@ -109,12 +109,12 @@
<section>
<title>Related Patterns</title>
- <para>This Optional Group is similar to the Choice Reducing Container in that they both hide
- logical units of a document from the author by introducing new element types. Existing
- elements are group together beneath the new element. The major difference between the
- two is the context they are used in. The Choice Group relates elements that are all
- choices in a content group while the Optional Group relates optional elements from the
- content group.</para>
+ <para>This Optional Group is similar to the <xref xl:href="choice-reducing-container.xml" />
+ in that they both hide logical units of a document from the author by introducing
+ new element types. Existing elements are group together beneath the new element.
+ The major difference between the two is the context they are used in.
+ The Choice Group relates elements that are all choices in a content group while the
+ Optional Group relates optional elements from the content group.</para>
</section>
<section>
View
3 src/docbook/patterns/consistency/common-attributes.xml
@@ -121,8 +121,7 @@
<section>
<title>Related Patterns</title>
- <para>The Common Attributes are usually declared in a <link xl:href="/patterns/organization/flyweight.xml">Flyweight</link> to help
- maintainability.</para>
+ <para>The Common Attributes are usually declared in a <xref xl:href="../organization/flyweight.xml" /> to help maintainability.</para>
</section>
<section>
View
4 src/docbook/patterns/consistency/parallel-design.xml
@@ -77,8 +77,8 @@
<title>Related Patterns</title>
<para>Often the parts of the structure that are the same between two elements can be
- represented as <link xl:href="/patterns/organization/flyweight.xml">Flyweight</link>s. This will help ensure that the two structures remain similar
- even through revisions of the document type.</para>
+ represented as <xref xl:href="../organization/flyweight.xml" />s.
+ This will help ensure that the two structures remain similar even through revisions of the document type.</para>
</section>
<section>
<title>Known Uses</title>
View
4 src/docbook/patterns/doc-roots/multi-doc-types.xml
@@ -87,8 +87,8 @@ EndDate #CDATA>
<section>
<title>Related Patterns</title>
- <para><link xl:href="/patterns/doc-roots/universal-root.xml">Universal Root</link> allows multiple types of data under one document root. Multi Root
- Document Types allows for multiple types of documents to be declared in a single
+ <para><xref xl:href="universal-root.xml" /> allows multiple types of data under one document root.
+ Multi Root Document Types allows for multiple types of documents to be declared in a single
declaration.</para>
</section>
View
3 src/docbook/patterns/doc-roots/multi-root.xml
@@ -79,8 +79,7 @@
<section>
<title>Related Patterns</title>
- <para><xref xl:href="../universal-root.xml" /> and <xref xl:href="../multi-doc-types.xml" /> are alternatives.</para>
- <para><link xl:href="/patterns/doc-roots/universal-root.xml">Universal Root</link> and <link xl:href="/patterns/doc-roots/multi-doc-types.xml">Multiple Document Types</link> are alternatives.</para>
+ <para><xref xl:href="universal-root.xml" /> and <xref xl:href="multi-doc-types.xml" /> are alternatives.</para>
</section>
<section>
View
2 src/docbook/patterns/doc-roots/universal-root.xml
@@ -105,7 +105,7 @@
<section>
<title>Related Patterns</title>
- <para><link xl:href="/patterns/doc-roots/multi-root.xml">Multi Root Document Types</link> and <link xl:href="/patterns/doc-roots/multi-doc-types.xml">Multiple Document Types</link> are alternatives to this
+ <para><xref xl:href="multi-root.xml" /> and <xref xl:href="multi-doc-types.xml" /> are alternatives to this
pattern.</para>
</section>
View
7 src/docbook/patterns/flexibility/catch-all.xml
@@ -102,9 +102,10 @@
<section>
<title>Related Patterns</title>
- <para>The <link xl:href="/patterns/organization/envelope.xml">Envelope</link> pattern uses a similar mechanism, but the intent of the <link xl:href="/patterns/organization/envelope.xml">Envelope</link> is to
- wrap a document without adding any domain data of its own. The intent of the Catch-All
- Element is to allow authors to mix data from separate document types.</para>
+ <para>The <xref xl:href="../organization/envelope.xml" /> pattern uses a similar mechanism,
+ but the intent of the <xref xl:href="../organization/envelope.xml" /> is to
+ wrap a document without adding any domain data of its own.
+ The intent of the Catch-All Element is to allow authors to mix data from separate document types.</para>
</section>
<section>
View
2 src/docbook/patterns/flexibility/extensible.xml
@@ -224,7 +224,7 @@ xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<section>
<title>Related Patterns</title>
<para>This mechanism is powerful, but also requires knowledge of DTD syntax to apply. Often
- the <link xl:href="/patterns/flexibility/generic.xml">Generic Element</link> pattern combined with <link xl:href="/patterns/flexibility/role.xml">Role Attribute</link>s may be a more appropriate
+ the <xref xl:href="generic.xml" /> pattern combined with <xref xl:href="role.xml" />s may be a more appropriate
choice if the authors of the document are not experienced with XML.</para>
</section>
View
2 src/docbook/patterns/flexibility/generic.xml
@@ -65,7 +65,7 @@
<section>
<title>Related Patterns</title>
- <para>A <link xl:href="/patterns/flexibility/role.xml">Role Attribute</link> is often used in conjunction with Generic Elements.</para>
+ <para>A <xref xl:href="role.xml" /> is often used in conjunction with Generic Elements.</para>
</section>
<section>
View
4 src/docbook/patterns/flexibility/role.xml
@@ -94,8 +94,8 @@
<section>
<title>Related Patterns</title>
- <para>Role Attributes are almost always used on <link xl:href="/patterns/flexibility/generic.xml">Generic Element</link> types.
- <link xl:href="/patterns/flexibility/generic.xml">Generic Element</link>s are
+ <para>Role Attributes are almost always used on <xref xl:href="generic.xml" /> types.
+ <xref xl:href="generic.xml" />s are
created when the designer of a document type does not know all of the uses of that
element, and the Role Attribute allows the author of a document to make the element more
specialized to his or her use of the element.</para>
View
7 src/docbook/patterns/metadata/head-body.xml
@@ -127,9 +127,10 @@
<section>
<title>Related Patterns</title>
- <para>The Head-Body pattern consists of two new Container Elements added to the structure of
- the document, one for the <tag class="element">Head</tag> element, and one for the <tag class="element">Body</tag>.
- This is a specialization of the Separate Metadata and Data.</para>
+ <para>The Head-Body pattern consists of two new Container Elements added to the structure of the document,
+ one for the <tag class="element">Head</tag> element,
+ and one for the <tag class="element">Body</tag>.
+ This is a specialization of <xref xl:href="metadata-data.xml"/>.</para>
</section>
<section>
<title>Known Uses</title>
View
2 src/docbook/patterns/metadata/metadata-data.xml
@@ -86,7 +86,7 @@
<section>
<title>Related Patterns</title>
- <para><link xl:href="/patterns/metadata/metadata-doc.xml">Metadata in Separate Document</link> and <link xl:href="head-body.xml">Head-Body</link> are specializations of this pattern.</para>
+ <para><xref xl:href="metadata-doc.xml" /> and <xref xl:href="head-body.xml" /> are specializations of this pattern.</para>
</section>
<section>
View
4 src/docbook/patterns/metadata/metadata-doc.xml
@@ -103,8 +103,8 @@
<section>
<title>Related Patterns</title>
- <para>This is a specialization of both the the Separate Metadata and Data and
- patterns.</para>
+ <para>This is a specialization of both the the <xref xl:href="matadata-data.xml" /> and
+ <uri xl:href="#">FIXME</uri> patterns.</para>
</section>
<section>
View
2 src/docbook/patterns/metadata/metadata-first.xml
@@ -91,7 +91,7 @@
<section>
<title>Related Patterns</title>
- <para>The ordering of the head and body element in the <link xl:href="/patterns/metadata/head-body.xml">Head-Body pattern</link> is an application
+ <para>The ordering of the head and body element in the <xref xl:href="head-body.xml" /> is an application
of this pattern.</para>
</section>
View
2 src/docbook/patterns/misc/content-type-label.xml
@@ -82,7 +82,7 @@
<section>
<title>Related Patterns</title>
- <para>This is an example of a <link xl:href="/patterns/organization/flyweight.xml">Flyweight</link>.</para>
+ <para>This is an example of a <xref xl:href="../organization/flyweight.xml" />.</para>
</section>
<section>
View
3 src/docbook/patterns/misc/reuse-doc-types.xml
@@ -109,7 +109,6 @@
<section>
<title>References</title>
- <para>There are several sources of existing schemas on the web: XML.org’s Catalog
- Schema.net</para>
+ <para>There are several sources of existing schemas on the web: XML.org’s Catalog Schema.net</para>
</section>
</section>
View
2 src/docbook/patterns/organization/declare-before.xml
@@ -91,7 +91,7 @@
<section>
<title>Related Patterns</title>
- <para>Consider this pattern when applying the <link xl:href="/patterns/organization/referenced-note.xml">Referenced Note</link>. The <link xl:href="/patterns/metadata/metadata-first.xml">Metadata First</link> is very
+ <para>Consider this pattern when applying the <xref xl:href="referenced-note.xml" />. The <xref xl:href="../metadata/metadata-first.xml" /> is very
similar to this patterns, except it deals with metadata instead of general elements as
this pattern does.</para>
</section>
View
8 src/docbook/patterns/organization/envelope.xml
@@ -78,14 +78,14 @@
<section>
<title>Related Patterns</title>
- <para>This is similar to the <link xl:href="/patterns/flexibility/catch-all.xml">Catch-All Element</link>, except that the the document type of the
- <link xl:href="/patterns/organization/envelope.xml">Envelope</link> pattern exists solely as an holder for other data and, the <link xl:href="/patterns/flexibility/catch-all.xml">Catch-All Element</link> is
- for embedding new elements within exsisting data.</para>
+ <para>This is similar to the <xref xl:href="../flexibility/catch-all.xml" />, except that the the document type of the
+ <xref xl:href="envelope.xml" /> pattern exists solely as an holder for other data and,
+ the <xref xl:href="../flexibility/catch-all.xml" /> is for embedding new elements within exsisting data.</para>
</section>
<section>
<title>Known Uses</title>
- <para><acronym>SOAP</acronym> (Simple Object Access Protocol) is an <link xl:href="/patterns/organization/envelope.xml">Envelope</link> for doing remote transport of
+ <para><acronym>SOAP</acronym> (Simple Object Access Protocol) is an <xref xl:href="envelope.xml" /> for doing remote transport of
messages.</para>
</section>
<section>
View
2 src/docbook/patterns/organization/flyweight.xml
@@ -155,7 +155,7 @@
<section>
<title>Related Patterns</title>
- <para>See <link xl:href="/patterns/metadata/declare-before.xml">Declare Before First Use</link> for suggestions on where to place the shared
+ <para>See <xref xl:href="../metadata/declare-before.xml" /> for suggestions on where to place the shared
information.</para>
</section>
View
2 src/docbook/patterns/organization/referenced-note.xml
@@ -117,7 +117,7 @@ This paragraph refers to a note.
<title>Related Patterns</title>
<para>This is an example of a Domain Element from the publishing world.</para>
- <para>Also consider using <link xl:href="/patterns/metadata/declare-before.xml">Declare Before First Use</link> with this pattern.</para>
+ <para>Also consider using <xref xl:href="../metadata/declare-before.xml" /> with this pattern.</para>
</section>
<section>

0 comments on commit 6eb9611

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