Stage 3: #372 remove <data-about>
Remove the <data-about>
element.
Champion
Robert D Anderson
Tracking information
Event | Date | Links |
---|---|---|
Stage 1 proposal accepted | 1 Sept 2020 | https://lists.oasis-open.org/archives/dita/202009/msg00021.html |
Stage 2 proposal submitted | 25 Sept 2020 | https://lists.oasis-open.org/archives/dita/202009/msg00041.html; DITA source: https://tools.oasis-open.org/version-control/svn/dita/trunk/DITA-2.0/stage-2/Issue372-Remove-data-about.dita |
Stage 2 proposal discussed | 29 Sept 2020 | https://lists.oasis-open.org/archives/dita/202009/msg00050.html |
Stage 2 proposal approved | 6 Oct 2020 | https://lists.oasis-open.org/archives/dita/202010/msg00016.html |
Stage 3 proposal submitted to reviewers | 9 Oct 2020 | Carsten Brennecke, Deb Bissantz |
Stage 3 proposal (this document) submitted to TC | 15 Oct 2020 |
Approved technical requirements
Remove the <data-about>
element, which is no longer easily
distinguishable from <data>
.
Dependencies or interrelated proposals
N/A.
Modified grammar files
Exact changes to the grammar files can be seen here: https://github.com/oasis-tcs/dita/pull/385/commits/cee6bd85f512f60c7aff123a0aa5f8e6256c9d4e
- Remove the DTD entity declaration from doctypes/dtd/base/commonElements.ent
- Remvoe the DTD element definition, and remove it from all content models in the common module: doctypes/dtd/base/commonElements.mod, doctypes/rng/base/commonElementsMod.rng
- Remove a reference to the element from the hazard domain module: doctypes/dtd/base/hazardstatementDomain.mod, doctypes/rng/base/hazardstatementDomain.rng
In addition, the technical content specification will require a few updates due to this proposal; those changes are summarized here: https://github.com/oasis-tcs/dita-techcomm/pull/81/files
Modified terminology
N/A
Modified specification documentation
Remove all mention of the element from the specification, as implemented here: https://github.com/oasis-tcs/dita/pull/385/commits/cee6bd85f512f60c7aff123a0aa5f8e6256c9d4e#diff-49398dc44065d66c8f51e9642875bf7d
- Remove the element from a description of metadata cascading in specification/archSpec/base/reconciling-topic-and-map-metadata.dita
- Remove the element from coding examples: specification/archSpec/base/relax-ng-coding-element-domains.dita, specification/archSpec/base/specialization-including-non-dita-content.dita, specification/non-normative/foreigngeneralization.dita
- Remove other miscellaneous mentions of the element: specification/common/reuse-w-lwdita/reuse-data.dita
- Remove the topic from the language reference: specification/langRef/base/data-about.dita, specification/langRef/key-definitions-specialization-elements.ditamap, specification/langRef/quick-reference/base-elements-a-to-z.dita, specification/langRef/specialization-elements.ditamap
- Remove from the list of recommendations for translators: specification/non-normative/elementsMerged.dita
In addition, the technical content specification will require a few updates due to this proposal; those changes are summarized here: https://github.com/oasis-tcs/dita-techcomm/pull/81/files
Migration plans for backwards incompatibilities
Recommendation is to migrate the <data-about>
element to
<data>
; the exact migration will vary based on how
<data-about>
might have been used (or mis-used) in DITA 1.x
documents.