Title: Re: [dita] Terminology issues: Linking and addressing terms? Referencing and referenced element?
The first bulleted list appears to indicate that the items, i.e., conkeyref, are a list of “elements that are referenced”. I would omit the list here and just put in the example with the ID=
Then list the elements only under referencing elements, since these the point at which the operators are actually used.
Do we need an example of Push?
JoAnn
On 12/3/09 7:20 AM, "Kristen James Eberlein" <> wrote:
That would give us something like the following. Thoughts? What is a non-example?
Referenced element An element that is referenced by another DITA element (the referencing element).
@conkeyref attribute
@conref attribute
@href attribute
@keyref attribute
Example
The following code sample is from the installation-reuse.dita topic. The <step> element that it contains is a referenced element; other DITA topics reference the <step> element by using the @conref attribute.
<step id="run-startcmd-script">
<cmd>Run the startcmd script that is applicable to your operating-system environment.</cmd>
</step>
Non-example
Referencing element An element which specifies one of the following DITA attributes in order to address another DITA element:
@conkeyref attribute
@conref attribute
@href attribute
@keyref attribute
Example
The following <step> element is a referencing element. It uses the @conref attribute to reference a <step> element in the installation-reuse.dita topic.
<step conref="installation-reuse.dita#reuse/run-startcmd-script>
<cmd/>
</step>
Non-example
Kris
Joann Hackos wrote:
Re: [dita] Terminology issues: Linking and addressing terms? Referencing and referenced element? I really think we need examples here — the definitions are too circular, which isn’t surprising considering the concept is circular. You need three elements to make a concept understandable: a definition, an example, and a non-example. We have the first part, but are missing the example and maybe the non-example.
I recommend an example — that would easily clarify the idea we’re trying to convey.
JoAnn
<snipped>
