DITA Technical Committee DITA 2.0 proposals DITA TC work product Page 1 of 234 Table of contents 1 Overview....................................................................................................................................................3 2 DITA 2.0: Stage two proposals.................................................................................................................. 3 2.1 Base edition.......................................................................................................................................3 2.1.1 Stage two: #08 <include> element............................................................................................ 3 2.1.2 Stage two: #15 Relax specialization rules.................................................................................7 2.1.3 Stage two #16: Add <titlealts> element to map.......................................................................10 2.1.4 Stage two: #17 Make @outputclass universal........................................................................ 14 2.1.5 Stage two: #18 Make audience, platform, product, otherprops into specializations................17 2.1.6 Stage two: #21 Resolve inconsistent class values for <shortdesc>, <linktext>, and <searchtitle>................................................................................................................................20 2.1.7 Stage two: #27 Multimedia domain......................................................................................... 23 2.1.8 Stage two: #29 Update <bookmap>........................................................................................28 2.1.9 Stage two: #34 Remove <topicset> and <topicsetref>............................................................32 2.1.10 Stage two: #36 Remove deprecated elements and attributes...............................................35 2.1.11 Stage two: #46: Remove @xtrf and @xtrc............................................................................ 43 2.1.12 Stage two: #73 Remove delayed conref domain...................................................................47 2.1.13 Stage two: #105 Redesign chunking.....................................................................................49 2.1.14 Stage two #107: Add <em> and <strong>.............................................................................59 2.1.15 Stage two: #164 Redesign <hazardstatement>.................................................................... 66 2.1.16 Stage two: #217 Remove @domains attribute......................................................................75 2.1.17 Stage two: #252 Add @outputclass to DITAVAL................................................................... 80 2.1.18 Stage two: #253 Indexing changes....................................................................................... 83 2.1.19 Stage two: #277 Change specialization base for <imagemap>............................................ 87 2.1.20 Stage two: #279 Remove @lockmeta attribute..................................................................... 91 2.2 Technical Content edition.................................................................................................................93 2.2.1 Stage two: #85 Add <sub> and <sup> to glossary elements.................................................. 93 2.2.2 Stage two: #106: Nest <steps>............................................................................................... 99 3 DITA 2.0: Stage three proposals............................................................................................................104 3.1 Base edition...................................................................................................................................104 3.1.1 Stage 3: #08 Add <include> element.................................................................................... 104 3.1.2 Stage 3: #17 Make @outputclass universal...........................................................................111 3.1.3 Stage 3: #18 Make @audience, @platform, @product, @otherprops into specializations... 114 3.1.4 Stage 3: #27 Multimedia domain...........................................................................................121 3.1.5 Stage 3: #36 Remove deprecated elements and attributes.................................................. 145 3.1.6 Stage 3: #46 Remove @xtrf and @xtrc.................................................................................184 3.1.7 Stage 3: #73 Remove delayed conref domain...................................................................... 186 3.1.8 Stage 3: #105 Redesign chunking.........................................................................................190 3.1.9 Stage 3: #253 Indexing changes...........................................................................................207 3.1.10 Stage 3: #277 Change specialization base for <imagemap>..............................................218 3.2 Technical Content edition...............................................................................................................222 3.2.1 Stage 3: #85 Add @sub and <sup> to glossary elements.................................................... 222 3.2.2 Stage 3: #106 Nest steps...................................................................................................... 226 4 Revision history......................................................................................................................................232 Index...............................................................................................................................234 DITA TC work product Page 2 of 234 1 Overview This document contains the text of the stage two and stage three proposals for DITA 2.0 that have been approved by the OASIS DITA Technical Committee (DITA TC). This document is regenerated periodically, as new proposals are approved by the DITA TC. 2 DITA 2.0: Stage two proposals These proposals have been approved by the DITA TC at the stage two level. For more information about stage two criteria, see DITA 2.0 proposal process. 2.1 Base edition 2.1.1 Stage two: #08 <include> element A new base element for inclusion of content from external files. This new element will serve as the base element for the existing transclusion elements <coderef>, <svgref>, and <mathmlref>. Date and version information Date that this feature proposal was completed February 25, 2018 Champion of the proposal Chris Nitchie Links to any previous versions of the proposal None Links to minutes where this proposal was discussed at stage 1 and moved to stage 2 https://lists.oasis-open.org/archives/dita/201607/msg00086.html Links to e-mail discussion that resulted in new versions of the proposal N/A Link to the GitHub issue https://github.com/oasis-tcs/dita/issues/8 Original requirement or use case The <coderef> element is a transclusion element – it loads the referenced file and places its contents as CDATA at the location of the referencing element. However, <coderef> is a specialization of <xref>, which is not a transclusion element. That is, the specialization-based fallback behavior for <coderef> is fundamentally incompatible with the expected processing. The same is true for <svgref> and <mathmlref>. The only way for people other than the TC to create similar transclusion elements via specialization is to specialize from one of those, or customize their processors to do the right thing with their element. Use cases • A company wants to enable the transclusion of some foreign XML markup other than SVG or MathML. DITA TC work product Page 3 of 234 • A company wants to enable the reuse of README textual content from their source code into their DITA content. • A tool vendor wants to provide feature support for the inclusion of CSV data as DITA tables. • A tool vendor wants to provide feature support for the inclusion of relational database query results as DITA tables. New terminology None. Proposed solution A new base vocabulary element called <include>. This element will use standard DITA referencing mechanics, but will be used for transclusion rather than simple referencing. It will be the base element for <coderef>, <mathmlref>, and <svgref>. In addition to the standard referencing attributes, the element will carry a @parse attribute specifying the processing to apply to the contents of the referenced file. Standard values for this attribute will be text, which will imply the conversion of <, >, and & into their equivalent character entity references, and xml, which will not. Vendors may provide support for additional processing modes. Benefits Who will benefit from this feature? Developers of DITA processing engines, who can now use a single, unified mechanism for processing transclusion elements, rather than special-casing the current three elements. Organizations needing to support transclusion of non-DITA content other than MathML and SVG, and code examples. What is the expected benefit? An extensible mechanism fr transclusion of non-DITA content. How many people probably will make use of this feature? Many. How much of a positive impact is expected for the users who will make use of the feature? Significant. Technical requirements New base element: <include> with a @class of "- topic/include ". In addition to %univ-atts; and @outputclass, this element will carry the following attributes: @href URI of content to include. @keyref Key reference to content to include. @format The format