From b73ccf86b9025f208edd426712809691232af611 Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Wed, 26 Jun 2024 13:58:34 -0500 Subject: [PATCH] Add ID to universal att DL Signed-off-by: Robert D Anderson --- .../attributes/universalAttributes.dita | 297 +++++++----------- 1 file changed, 122 insertions(+), 175 deletions(-) diff --git a/specification/langRef/attributes/universalAttributes.dita b/specification/langRef/attributes/universalAttributes.dita index f1ae9da5..500e2e50 100644 --- a/specification/langRef/attributes/universalAttributes.dita +++ b/specification/langRef/attributes/universalAttributes.dita @@ -93,24 +93,20 @@

The universal attributes for OASIS DITA elements are defined below. Specialized attributes, which are part of the OASIS distribution but are only available when explicitly included in a shell, are noted in the list.

-
+
audience - (specialized - attribute)
+ (specialized attribute)
Indicates the intended audience for the element.
base
-
Specifies metadata about the element. It is often used as a - base for specialized attributes that have a simple syntax for - values, but which are not conditional processing - attributes.

The base attribute takes a - space-delimited set of values.

+
Specifies metadata about the element. It is often used as a base for specialized + attributes that have a simple syntax for values, but which are not conditional + processing attributes.

The base attribute takes a space-delimited set + of values.

class @@ -129,84 +125,69 @@
conaction
-
Specifies how the element content will be pushed into a new - location. The following values are valid:
+
Specifies how the element content will be pushed into a new location. The following + values are valid:
mark
-
The element acts as a marker when pushing content - before or after the target, to help ensure that the push - action is valid. The element with - conaction="mark" also specifies the - target of the push action with conref. - Content inside of the element with - conaction="mark" is not pushed to the - new location.
+
The element acts as a marker when pushing content before or after the target, to + help ensure that the push action is valid. The element with + conaction="mark" also specifies the target of the push action + with conref. Content inside of the element with + conaction="mark" is not pushed to the new location.
pushafter
-
Content from this element is pushed after the location - specified by conref on the element with - conaction="mark". The element with - conaction="pushafter" is the first - sibling element after the element with - conaction="mark".
+
Content from this element is pushed after the location specified by + conref on the element with conaction="mark". + The element with conaction="pushafter" is the first sibling + element after the element with conaction="mark".
pushbefore
-
Content from this element is pushed before the location - specified by conref on the element with - conaction="mark". The element with - conaction="pushbefore" is the first - sibling element before the element with - conaction="mark".
+
Content from this element is pushed before the location specified by + conref on the element with conaction="mark". + The element with conaction="pushbefore" is the first sibling + element before the element with conaction="mark".
pushreplace
-
Content from this element replaces any content from the - element referenced by the conref - attribute. A second element with - conaction="mark" is not used when - using conaction="pushreplace".
+
Content from this element replaces any content from the element referenced by + the conref attribute. A second element with + conaction="mark" is not used when using + conaction="pushreplace".
-

See for examples - and details about the syntax.

+

See for examples and details about the + syntax.
conkeyref
-
Specifies a key name or a key name with an element ID that - acts as an indirect reference to reusable content. The - referenced content is used in place of the content of the - current element. See for - more details about the syntax and behaviors.
+
Specifies a key name or a key name with an element ID that acts as an indirect + reference to reusable content. The referenced content is used in place of the content of + the current element. See for more details about + the syntax and behaviors.
conref
-
Specifies a URI that references a DITA - element. The referenced content is used in place of the content - of the current element. See for examples and details about - the syntax.

For HDITA, the - equivalent of conref is +

Specifies a URI that references a DITA element. The referenced + content is used in place of the content of the current element. See + for examples and details about the syntax. +

For HDITA, the equivalent of conref is data-conref.
conrefend
-
Specifies a URI that references the last element in a - sequence of elements, with the first element of the sequence - specified by conref. The referenced sequence - of elements is used in place of the content of the current - element. See for examples - and details about the syntax.
+
Specifies a URI that references the last element in a sequence of elements, with the + first element of the sequence specified by conref. The referenced + sequence of elements is used in place of the content of the current element. See for examples and details about the syntax.
deliveryTarget - (specialized - attribute)
+ (specialized attribute)
@@ -214,14 +195,13 @@
dir
-

Identifies or overrides the text - directionality. The following values are valid:

+

Identifies or overrides the text directionality. The following + values are valid:

lro
-
Indicates an override of the Unicode Bidirectional - Algorithm, forcing the element into left-to-right - mode.
+
Indicates an override of the Unicode Bidirectional Algorithm, forcing the + element into left-to-right mode.
ltr
@@ -229,71 +209,57 @@
rlo
-
Indicates an override of the Unicode Bidirectional - Algorithm, forcing the element into right-to-left - mode.
+
Indicates an override of the Unicode Bidirectional Algorithm, forcing the + element into right-to-left mode.
rtl
Indicates right-to-left.
 - +
-

See for more +

See for more information.

id
-
Specifies an identifier for the current - element. This ID is the target for references by - href and conref attributes - and for external applications that refer to DITA or LwDITA - content. This attribute is defined with the XML data type - NMTOKEN, except where noted for specific elements within the - language reference.

See for more - details.

+
Specifies an identifier for the current element. This ID is the + target for references by href and conref attributes + and for external applications that refer to DITA or LwDITA content. This attribute is + defined with the XML data type NMTOKEN, except where noted for specific elements within + the language reference.

See for more details.
importance
-
Specifies the importance or priority that is assigned to an - element. The following values are valid: - default, deprecated, - high, low, - normal, obsolete, - optional, recommended, - required, urgent, and - -dita-use-conref-target. This attribute is - not used for conditional processing, although applications - might use the value of the importance - attribute to highlight elements. For - example, in steps of a task topic, the value of the - importance attribute indicates whether a - step is optional or required. -

I think the phrase "to highlight elements" is a little - off. Maybe "render generated text"? And how about adding - "Processors often add text or images to ensure that readers - of the generated content understand whether the step is - optional or required." to the end of the example?

+
Specifies the importance or priority that is assigned to an element. The following + values are valid: default, deprecated, + high, low, normal, + obsolete, optional, + recommended, required, + urgent, and -dita-use-conref-target. This + attribute is not used for conditional processing, although applications might use the + value of the importance attribute to highlight elements. For example, in steps of a task topic, the value of the + importance attribute indicates whether a step is optional or + required. +

I think the phrase "to highlight elements" is a little off. Maybe "render generated + text"? And how about adding "Processors often add text or images to ensure that + readers of the generated content understand whether the step is optional or + required." to the end of the example?
otherprops - (specialized - attribute)
-
Specifies a property or properties that provide selection - criteria for the element. Alternatively, the - props attribute can be specialized to - provide a new metadata attribute instead of using the general - otherprops attribute. + (specialized attribute) +
Specifies a property or properties that provide selection criteria for the element. + Alternatively, the props attribute can be specialized to provide a new + metadata attribute instead of using the general otherprops attribute. +
@@ -311,99 +277,80 @@
platform (specialized attribute)
-
Indicates operating system and hardware. - I - think this could specify a platform that is not an operating - system or hardware, right? The current definition explicitly - limits platform to those two … maybe "Specifies a platform or - platforms to which the element applies, such as the operating - system or hardware relevant to a task."
+
Indicates operating system and hardware. + I think this could specify a + platform that is not an operating system or hardware, right? The current definition + explicitly limits platform to those two … maybe "Specifies a platform or platforms to + which the element applies, such as the operating system or hardware relevant to a + task."
product - (specialized - attribute)
-
Specifies the name of the product to which the element - applies. + (specialized attribute) +
Specifies the name of the product to which the element applies.
props
-
Specifies metadata about the element. New - attributes can be specialized from the props - attribute. +
Specifies metadata about the element. New attributes can be specialized + from the props attribute. -

The props attribute takes a space-delimited - set of values.

For HDITA, the - equivalent of props is +

The props attribute takes a space-delimited set of values.

For HDITA, the equivalent of props is data-props
rev
-
Specifies a revision level of an element that identifies when - the element was added or modified. It can be used to flag - outputs when it matches a run-time parameter. It cannot be used - for filtering nor is it sufficient to be used for version - control. Specifies a revision level of an element that identifies when the element was added or + modified. It can be used to flag outputs when it matches a run-time parameter. It cannot + be used for filtering nor is it sufficient to be used for version control. -

I want to tweak this. How about the following? Also, - neither definition describes what values are permitted.

-

Specifies metadata that identifies when the element was - added or the content of the element was modified. The - rev attribute can be used for flagging. - It cannot be used for filtering nor is it sufficient to be - used for version control.

+

I want to tweak this. How about the following? Also, neither definition describes + what values are permitted.

+

Specifies metadata that identifies when the element was added or the content of the + element was modified. The rev attribute can be used for flagging. + It cannot be used for filtering nor is it sufficient to be used for version control. +

status
-
Specifies the modification status of the element. The - following values are valid: new, - changed, deleted, - unchanged, and - -dita-use-conref-target.
+
Specifies the modification status of the element. The following values are valid: + new, changed, deleted, + unchanged, and -dita-use-conref-target.
translate
-
Specifies whether the content of the element should be - translated. The following values are valid: - yes, no, and - -dita-use-conref-target.The following values are valid: - yes and no.

See for - suggested processing defaults for each - element.

-

Does really provide suggested processing defaults for each - element? I thought it covered whether an element was block - or in-line and whether there were considerations that - translators needed to be aware of.

+
Specifies whether the content of the element should be translated. The following values are valid: yes, no, and + -dita-use-conref-target.The following + values are valid: yes and no.

See for + suggested processing defaults for each element.

+

Does really provide + suggested processing defaults for each element? I thought it covered whether an + element was block or in-line and whether there were considerations that translators + needed to be aware of.
xml:lang
-
Specifies the language and optional locale - of the content that is contained in an element. Valid values - are language tokens or the null string. The - xml:lang attribute and its values are - described in the Extensible - Markup Language 1.0 specification, fifth edition.

Specifies the language and optional locale of the content that is + contained in an element. Valid values are language tokens or the null string. The + xml:lang attribute and its values are described in the Extensible Markup Language 1.0 specification, fifth edition.

For HDITA, the equivalent attribute is - lang.

-

Do we also want to direct readers to the architectural - topics about the xml:lang attribute?

+ lang.

+

Do we also want to direct readers to the architectural topics about the + xml:lang attribute?