Re: [dita] Conref terminology: Referencing element and referencedelement

[Kristen James Eberlein <keberlein@pobox.com>]

OK, here's what I have drafted for my conref push article:

"All the rules and restrictions are designed to ensure that the result of the push operation is valid DITA. This section uses the following terminology: 

The referencing element is the element with the @conref attribute. In the case of a push and replace operation, this element contains the content that is pushed. In the case of a push before or a push after operation, this element specifies the location where content is pushed; a second element contains the content that is pushed.

The referenced element is the element addressed by the @conref attribute; it is the element that is replaced, prefaced, or followed by the content that is pushed."

Any comments welcome.

Kris

Park Seth-R01164 wrote:

F943284D299CD9409CFA37D759ADDAD1038C8EF5@az33exm23.fsl.freescale.net" type="cite">

I think the resolution was that the TC requests that the author group consider making the terminology unambiguous.

 

The proposed terminology (paraphrased):

• The element with the referencing attribute (href, conref, keyref, etc.) is always the referencing element, regardless of the behavior of the reference.
• The referenced element is the element specified in the referencing attribute (or the resolved target of an indirect reference) of the referencing element.

This does not make it easier to explain conactions, but the best we can do is make sure the terminology is unambiguous. For example:

• When using conref pull (no conaction specified), the referenced element replaces the referencing element.
• When using conref push, the referencing element replaces the referenced element.

 

(BTW, Don said specifically that he was sensitive to making resolutions that impact arch spec activities.)

 

-sp

 

 

--------------------------------------------

seth park

information architect

Freescale Semiconductor, Inc.

seth.park@freescale.com

512.895.2463