diff --git a/doctypes/dtd/technicalContent/glossentry.mod b/doctypes/dtd/technicalContent/glossentry.mod index 8ff28914..281283de 100644 --- a/doctypes/dtd/technicalContent/glossentry.mod +++ b/doctypes/dtd/technicalContent/glossentry.mod @@ -56,8 +56,6 @@ "glossScopeNote" > - @@ -391,8 +389,7 @@ (%glossStatus;)?, (%glossProperty;)*, (%glossUsage;)?, - (%note;)*, - (%glossAlternateFor;)*)" + (%note;)*)" > - - - - - - - @@ -446,7 +414,6 @@ - diff --git a/doctypes/rng/technicalContent/glossentryMod.rng b/doctypes/rng/technicalContent/glossentryMod.rng index befeb98d..45ae895c 100644 --- a/doctypes/rng/technicalContent/glossentryMod.rng +++ b/doctypes/rng/technicalContent/glossentryMod.rng @@ -61,9 +61,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Glossary Entry//EN" - - - @@ -664,9 +661,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Glossary Entry//EN" - - - @@ -684,48 +678,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Glossary Entry//EN" -
- LONG NAME: Glossary - Alternate For - - - - - - - - - - - - - - - - - - - - external - local - peer - -dita-use-conref-target - - - - - - - - The <glossAlternateFor> element indicates when a variant term has a relationship to another variant term as well as to the preferred term. - - - - - - - - -
SPECIALIZATION ATTRIBUTE DECLARATIONS @@ -785,11 +737,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Glossary Entry//EN" - - - - - diff --git a/specification/langRef/glosssary-elements.ditamap b/specification/langRef/glosssary-elements.ditamap index 7b5b7a72..b0a16bf0 100644 --- a/specification/langRef/glosssary-elements.ditamap +++ b/specification/langRef/glosssary-elements.ditamap @@ -5,7 +5,6 @@ - diff --git a/specification/langRef/key-definitions-glosssary-elements.ditamap b/specification/langRef/key-definitions-glosssary-elements.ditamap index f5569587..69bbe7e1 100644 --- a/specification/langRef/key-definitions-glosssary-elements.ditamap +++ b/specification/langRef/key-definitions-glosssary-elements.ditamap @@ -7,7 +7,6 @@ - diff --git a/specification/langRef/quick-reference/technicalContent-elements-a-to-z.dita b/specification/langRef/quick-reference/technicalContent-elements-a-to-z.dita index 19c24030..d0b5a25d 100644 --- a/specification/langRef/quick-reference/technicalContent-elements-a-to-z.dita +++ b/specification/langRef/quick-reference/technicalContent-elements-a-to-z.dita @@ -90,7 +90,6 @@ - diff --git a/specification/langRef/technicalContent/glossAlternateFor.dita b/specification/langRef/technicalContent/glossAlternateFor.dita deleted file mode 100644 index 75f7a92a..00000000 --- a/specification/langRef/technicalContent/glossAlternateFor.dita +++ /dev/null @@ -1,91 +0,0 @@ - - - -<xmlelement>glossAlternateFor</xmlelement> -The glossAlternateFor element indicates when a variant term has - a relationship to another variant term in addition to the term specified in the topic's - glossterm element.I am still - struggling with this so we'll address it in the review. Couldn't <glossAlternativeFor> be - used alone in a <glossAlt> element to indicate the <glossterm> of this topic is an - alternative for another term defined in another topic? Why are we limiting the definition to - indicate that a variant is an alternative for another term in addition to the current - one? - -glossAlternateFor - glossariesvariant terms - glossentry - elementsglossAlternateFor - - -
- Usage information -

The glossAlternateFor element is available inside the - glossAlt element, which is a container that provides a variant - for the term specified in the topic's glossterm element. The - glossAlternateFor element makes it clear that there is a - relationship between the current topic's term, the variant term defined in the parent - glossAlt element, and the term defined in the external glossary - entry topic that it is linked to.

-
-
- Specialization hierarchy -

The glossAlternateFor element is specialized from - xref. It is defined in the glossary entry module.

-
-
- Attributes -

The following attributes are available on this element: , , and keyref.

-

For this element, the - href or keyref attribute references a term for which the - current variant is an alternate (in addition to the glossterm of - this glossentry topic). The reference could be to another - glossentry topic or to a glossAlt - element within the same glossentry topic (indicating that the - current variant is an alternate for both the glossterm and the - referenced alternate term).

- -

The above wording does not track for me, nor does it match the earlier example for - glossentry, or the 2009 Kara Warburton white paper. You can - read my interpretation in the explanation of the example below.

-

DS: I don't think the phrasing precludes your interpretation. In the example, fridge is - an alternate for icebox and for refrigerator. But icebox could in fact be an alternate for - refrigerator, so there could be a glossAlt establishing that, and then the - glossAlternateFor from fridge could point to that glossAlt rather than another topic, - and/or vice versa. I would think you would do that if you didn't want to have a separate - topic for icebox.

-

DS: I did have to think through cases where all glossAlts might not be alternates for - each other, though, to determine why you would do this. I decided if my term was airplane, - plane might be an alt, as might 747 or 737, while plane might be an alternatefor 747 and - 737, 747 would not be an alternate for 737. I don't know if I'm making sense, but this is - how I've justified this element at all in my own head.

- -
- - Example -

The following code sample shows a glossary entry topic for the term "Refrigerator". In - addition to providing a definition, the glossary entry topic defines a variant term - ("fridge"). It also links to another glossary entry topic for a variant term ("icebox") - which is defined in a separate glossary entry topic.

- <glossentry id="refrigerator"> - <glossterm>Refrigerator</glossterm> - <glossdef>A refrigerator is a commercial and home appliance consisting - of a thermally insulated compartment and a heat pump (mechanical, - electronic or chemical) that transfers heat from its inside to its - external environment so that its inside is cooled to a temperature - below the room temperature.</glossdef> - <glossBody> - <glossPartOfSpeech value="noun"/> - <glossAlt> - <glossSynonym>fridge</glossSynonym> - <glossUsage>Casual and colloquial usage only.</glossUsage> - <glossAlternateFor keyref="glossentry-icebox"/> - </glossAlt> - </glossBody> -</glossentry> - - - - diff --git a/specification/non-normative/elementsMerged.dita b/specification/non-normative/elementsMerged.dita index 9c1e7b46..dbf68021 100644 --- a/specification/non-normative/elementsMerged.dita +++ b/specification/non-normative/elementsMerged.dita @@ -2,50 +2,38 @@ Element-by-element recommendations for translators - This topic contains a list of all OASIS DITA elements that are - available in the edition. It includes recommendations on whether the - element contents are likely to be suitable for translation and whether - the element has attributes whose values are likely to be suitable for - translation. Examples of content that is not suitable for translation - include code fragments and mailing addresses. + This topic contains a list of all OASIS DITA elements that are available in the + edition. It includes recommendations on whether the element contents are likely to be suitable + for translation and whether the element has attributes whose values are likely to be suitable + for translation. Examples of content that is not suitable for translation include code fragments + and mailing addresses.
Notes on the tables below
    -
  • Note that an element might be a block element in one context - and an inline element in another. In addition, specialized - element types might be rendered in a way that varies from their - specialization base. Accordingly, the distinctions presented in - the tables are provided only as a guide to known behavior with - the base DITA. For element specializations that are not - distributed by OASIS, the suggested default is to fall back to - the closest ancestor element that is part of the OASIS - distribution.
    • -
  • For all elements, the translate attribute - overrides the suggested defaults specified in the tables - below.
    • -
  • Certain block-level elements might appear in the - middle of a translation segment. They are considered - subflow elements in regard to translation. When - located in the middle of a translation segment, these element - should not be translated as part of that segment. Whenever - possible, such elements should be placed only at sentence - boundaries in order to aid translation. The subflow elements in - base DITA are draft-comment, - fn, idex-see, - index-see-also, - indexterm, and - required-cleanup
    • -
  • The keyword element (as well as - specializations of keyword) is an - inline, phrase-like element when it appears in the body of a - document. It can also appear in the - keywords element in - topicmeta (for maps) or in the - prolog (for topic). When it appears in - the keywords element, each - keyword represents an individual - segment. In that location, keyword is +
  • Note that an element might be a block element in one context and an inline element in + another. In addition, specialized element types might be rendered in a way that varies + from their specialization base. Accordingly, the distinctions presented in the tables are + provided only as a guide to known behavior with the base DITA. For element specializations + that are not distributed by OASIS, the suggested default is to fall back to the closest + ancestor element that is part of the OASIS distribution.
    • +
  • For all elements, the translate attribute overrides the suggested + defaults specified in the tables below.
    • +
  • Certain block-level elements might appear in the middle of a translation + segment. They are considered subflow elements in regard to translation. When + located in the middle of a translation segment, these element should not be translated as + part of that segment. Whenever possible, such elements should be placed only at sentence + boundaries in order to aid translation. The subflow elements in base DITA are + draft-comment, fn, + idex-see, index-see-also, + indexterm, and required-cleanup
    • +
  • The keyword element (as well as specializations of + keyword) is an inline, phrase-like element when it appears in + the body of a document. It can also appear in the keywords + element in topicmeta (for maps) or in the + prolog (for topic). When it appears in the + keywords element, each keyword + represents an individual segment. In that location, keyword is considered a subflow element.
@@ -59,54 +47,46 @@
Specialization base
-
The element from which the current element is specialized. - This column only appears in tables for the domain - elements.
+
The element from which the current element is specialized. This column only appears in + tables for the domain elements.
Same behavior as specialization base?
-
Indicates whether the element has the same behaviors in - regard to translation as its specialization base. The behaviors - are whether the element is formatted as a single block or as an - inline element, whether the element represents a complete - translatable segment, and whether the element contains - translatable content. This column only appears in tables for - the domain elements.
+
Indicates whether the element has the same behaviors in regard to translation as its + specialization base. The behaviors are whether the element is formatted as a single + block or as an inline element, whether the element represents a complete translatable + segment, and whether the element contains translatable content. This column only appears + in tables for the domain elements.
Block/inline translation
-
Indicates whether the element represents a complete - translatable +
Indicates whether the element represents a complete translatable segment.
Translatable content?
Whether the element contains one or both of the following:
  • Text content that can be translated
    • -
  • Child elements that contain content that can be - translated
    • +
  • Child elements that contain content that can be translated
Notes
-
This column contains any additional information, including - the following items.This column only appears in tables when it - is needed.
    -
  • Whether the element has any attributes with values that - might need translation
    • -
  • If specializations of the element might need - translation,
    • -
  • If the element is a "subflow" element for the purposes of +
    This column contains any additional information, including the following items.This + column only appears in tables when it is needed.
      +
    • Whether the element has any attributes with values that might need translation
      • +
    • If specializations of the element might need translation,
      • +
    • If the element is a "subflow" element for the purposes of translation
    Bookmap elements -

    The following table contains information about the bookmap - specialization. There are no translatable attributes.

    +

    The following table contains information about the bookmap specialization. There are no + translatable attributes.

    Element name @@ -539,8 +519,8 @@
    Concept elements -

    The following table contains information about the concept - specialization. There are no translatable attributes.

    +

    The following table contains information about the concept specialization. There are no + translatable attributes.

    Element name @@ -574,8 +554,7 @@
    Glossary entry elements -

    The following table contains information about the glossary entry - specialization.

    +

    The following table contains information about the glossary entry specialization.

    Element name @@ -601,18 +580,9 @@ yes - - glossAlternateFor - xref - yes - n/a (empty element) - n/a (empty element) - - glossbody - body, - conbody + body, conbody yes block yes @@ -628,8 +598,7 @@ glossentry - topic, - concept + topic, concept yes block yes @@ -687,8 +656,7 @@ glossSymbol image yes - block when placement= break, otherwise - inline + block when placement= break, otherwise inline yes @@ -714,15 +682,14 @@ yes block yes - othertype can specify translatable - content. + othertype can specify translatable content.
    Glossary group elements -

    The following table contains information about the glossary group - specialization. There are no translatable attributes.

    +

    The following table contains information about the glossary group specialization. There are + no translatable attributes.

    Element name @@ -742,8 +709,8 @@
    Reference elements -

    The following table contains information about the reference - specialization. There are no translatable attributes.

    +

    The following table contains information about the reference specialization. There are no + translatable attributes.

    Element name @@ -847,8 +814,8 @@
    Task elements -

    The following table contains information about the task - specialization. There are no translatable attributes.

    +

    The following table contains information about the task specialization. There are no + translatable attributes.

    Element name @@ -1050,8 +1017,8 @@
    Troubleshooting elements -

    The following table contains information about the troubleshooting - specialization. There are no translatable attributes.

    +

    The following table contains information about the troubleshooting specialization. There + are no translatable attributes.

    Element name @@ -1113,9 +1080,8 @@
    Abbreviated form domain (abbrev-d) -

    The following table contains information about the abbreviated - form domain. There are no translatable attributes in this - domain.

    +

    The following table contains information about the abbreviated form domain. There are no + translatable attributes in this domain.

    Element name @@ -1135,8 +1101,8 @@
    Equation domain (equation-d) -

    The following table contains information about the equation - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the equation domain. There are no + translatable attributes in this domain.

    Element name @@ -1177,9 +1143,8 @@
    Glossary reference domain (glossref-d) -

    The following table contains information about the glossary - reference domain. There are no translatable attributes in this - domain.

    +

    The following table contains information about the glossary reference domain. There are no + translatable attributes in this domain.

    Element name @@ -1199,8 +1164,8 @@
    Hardware domain (hw-d ) -

    The following table contains information about the hardware - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the hardware domain. There are no + translatable attributes in this domain.

    Element name @@ -1227,8 +1192,8 @@
    Markup domain (markup-d) -

    The following table contains information about the markup domain. - There are no translatable attributes in this domain.

    +

    The following table contains information about the markup domain. There are no translatable + attributes in this domain.

    Element name @@ -1248,8 +1213,8 @@
    MathML domain (mathml-d) -

    The following table contains information about the MathML domain. - There are no translatable attributes in this domain.

    +

    The following table contains information about the MathML domain. There are no translatable + attributes in this domain.

    Element name @@ -1276,8 +1241,8 @@
    Programming domain (pr-d) -

    The following table contains information about the programming - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the programming domain. There are no + translatable attributes in this domain.

    Element name @@ -1360,9 +1325,8 @@
    Release management domain (relmgmt-d) -

    The following table contains information about the release - management domain. There are no translatable attributes in this - domain.

    +

    The following table contains information about the release management domain. There are no + translatable attributes in this domain.

    Element name @@ -1452,8 +1416,8 @@
    Software domain (sw-d) -

    The following table contains information about the software - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the software domain. There are no + translatable attributes in this domain.

    Element name @@ -1522,8 +1486,8 @@
    SVG domain (svg-d) -

    The following table contains information about the SVG domain. - There are no translatable attributes in this domain.

    +

    The following table contains information about the SVG domain. There are no translatable + attributes in this domain.

    Element name @@ -1550,8 +1514,8 @@
    Syntax diagram domain (syntaxdiagram-d) -

    The following table contains information about the syntax diagram - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the syntax diagram domain. There are no + translatable attributes in this domain.

    Element name @@ -1676,8 +1640,8 @@
    User interface domain (ui-d) -

    The following table contains information about the user interface - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the user interface domain. There are no + translatable attributes in this domain.

    Element name @@ -1725,8 +1689,8 @@
    XML mention domain (xml-d) -

    The following table contains information about the XML mention - domain. There are no translatable attributes in this domain.

    +

    The following table contains information about the XML mention domain. There are no + translatable attributes in this domain.

    Element name @@ -1737,56 +1701,49 @@ numcharref - keyword, - markupname + keyword, markupname no inline no parameterentity - keyword, - markupname + keyword, markupname no inline no textentity - keyword, - markupname + keyword, markupname no inline no xmlatt - keyword, - markupname + keyword, markupname no inline no xmlelement - keyword, - markupname + keyword, markupname no inline no xmlnsname - keyword, - markupname + keyword, markupname no inline no xmlpi - keyword, - markupname + keyword, markupname no inline no