Diff for Working with content references (conref)

Thu, 2006-03-23 20:13 by Bruce EsrigFri, 2006-02-10 21:46 by Bruce Esrig
Changes to Body
Line 1Line 1
-
<p>Content referencing (conref) is a convenient DITA mechanism for reuse of content from other topics or maps. A fragment of content in one topic or map can be pulled&nbsp;by reference into&nbsp;any other topic or map where the content is allowed. To create the reference, start by creating an empty element of the type that you want to pull in, and then use the element's conref attribute to provide the target's location.</p>
+
<p>Content referencing (conref) is a convenient mechanism for reuse of content fragments. A fragment of content may be included from another location. To do so, the top element to be included is repeated at the location that will receive the inclusion. Instead of the usual attributes or content, the referencing element is given a conref attribute that specifies the location of the referenced element.</p>
  +
<p>The element containing the content reference acts as a placeholder for the referenced element. The identifier for the referenced element must be either absolute or resolvable in the context of the referencing element. (See <a href="http://docs.oasis-open.org/dita/v1.0/archspec/id.html">Identity attribute</a> for the details on identifiers.)</p>
  +
<p>More formally, the DITA conref attribute can be considered a transclusion mechanism. In that respect, conref is similar to XInclude as well as HyTime value references. DITA differs from these mechanisms, however, by comparing the constraints of each context to ensure the ongoing validity of the replacement content in its new context. In other words, conref validity does not apply simply to the current content at the time of replacement, but to the ranges of possible content given the constraints of the two document types. A valid conref processor does not allow the resolution of a reuse relationship that could be rendered invalid under the rules of either the reused or reusing content.</p>
 
<p>The architectural specification describes content referencing at:</p>
 
<p>The architectural specification describes content referencing at:</p>
 
<ul>
 
<ul>
-
<li><font size="2" face="Lucida Sans Unicode"><a href="http://docs.oasis-open.org/dita/v1.0/archspec/conref.html">http://docs.oasis-open.org/dita/v1.0/archspec/conref.html</a></font> </li>
+
<li><font face="Lucida Sans Unicode" size="2"><a href="http://docs.oasis-open.org/dita/v1.0/archspec/conref.html">http://docs.oasis-open.org/dita/v1.0/archspec/conref.html</a>.</font></li>
-
</ul>
+
-
<p>The language specification describes the syntax of the conref attribute at:</p>
+
-
<ul>
+
-
<li><a href="http://docs.oasis-open.org/dita/v1.0/langspec/id-atts.html">http://docs.oasis-open.org/dita/v1.0/langspec/id-atts.html</a> </li>
+
-
</ul>
+
-
<p>Editors for the Architecture area:</p>
+
-
<ul>
+
-
<li><a href="http://dita.xml.org/user/26" title="View user profile."><strong><font color="#ac083e">Bruce Esrig</font></strong></a></li>
+
-
<li><a href="http://dita.xml.org/user/25" title="View user profile."><strong><font color="#ac083e">Michael Priestley</font></strong></a></li>
+
 
</ul>
 
</ul>
Revision of Fri, 2006-02-10 21:46:

Content referencing (conref)

Content referencing (conref) is a convenient mechanism for reuse of content fragments. A fragment of content may be included from another location. To do so, the top element to be included is repeated at the location that will receive the inclusion. Instead of the usual attributes or content, the referencing element is given a conref attribute that specifies the location of the referenced element.

The element containing the content reference acts as a placeholder for the referenced element. The identifier for the referenced element must be either absolute or resolvable in the context of the referencing element. (See Identity attribute for the details on identifiers.)

More formally, the DITA conref attribute can be considered a transclusion mechanism. In that respect, conref is similar to XInclude as well as HyTime value references. DITA differs from these mechanisms, however, by comparing the constraints of each context to ensure the ongoing validity of the replacement content in its new context. In other words, conref validity does not apply simply to the current content at the time of replacement, but to the ranges of possible content given the constraints of the two document types. A valid conref processor does not allow the resolution of a reuse relationship that could be rendered invalid under the rules of either the reused or reusing content.

The architectural specification describes content referencing at:

XML.org Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | XML.org | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I