Skip to content

Commit 8292b51

Browse files
infotextureinfotexture
committed
Structure DITA 2.0 feature section as list
Signed-off-by: Roger Sheen <roger@infotexture.net>
1 parent 240fdee commit 8292b51

File tree

1 file changed

+72
-54
lines changed

1 file changed

+72
-54
lines changed

‎release-notes/index.dita‎

Lines changed: 72 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -47,50 +47,68 @@
4747

4848
<!-- https://github.com/dita-ot/dita-ot/issues?q=milestone%3ANext%20is%3Aclosed%20label%3Afeature%20sort%3Acreated-asc -->
4949

50-
<section id="4644">
51-
<title>DITA 2.0 support</title>
52-
<p>DITA-OT now supports the DITA 2.0 <xmlelement>keytext</xmlelement> element and implements the updated
53-
<xref
54-
href="https://dita-lang.org/dita/archspec/base/processing-keyref-for-text"
55-
format="html"
56-
scope="external"
57-
>DITA 2.0 rules</xref> for generating key variable text.
58-
<xref href="https://github.com/dita-ot/dita-ot/issues/4644" format="html" scope="external">#4644</xref>
59-
</p>
60-
<p>In DITA 2.0, the <xmlelement>keytext</xmlelement> element provides a more flexible way to define the text
61-
content for key references. When a key is defined with <xmlelement>keytext</xmlelement>, this content is used
62-
to populate key references that resolve to text.</p>
63-
<p>Key processing now determines the DITA version of the map that declared each key and applies the appropriate
64-
resolution rules. When you combine DITA 1.x and DITA 2.0 maps in a single publication:</p>
50+
<section id="dita-v2-0-support">
51+
<title><b outputclass="badge badge-primary">Preview</b> DITA 2.0 support</title>
52+
<p>In addition to the
53+
<xref keyref="dita-v2-0-support"/> provided in DITA-OT 3.5 – 4.3, this release includes updated processing for
54+
the latest draft versions of the DITA 2.0 grammar files from OASIS (as of <keyword
55+
keyref="draft-dita-grammar-state"
56+
/>). </p>
6557
<ul>
66-
<li>Key references to keys defined in DITA 1.x maps use the <xmlelement>keyword</xmlelement> element for text
67-
resolution (as in previous versions).</li>
68-
<li>Key references to keys defined in DITA 2.0 maps use the <xmlelement>keytext</xmlelement> element for text
69-
resolution (following the DITA 2.0 specification).</li>
58+
<li>
59+
<p id="4644">DITA-OT now supports the DITA 2.0 <xmlelement>keytext</xmlelement> element and implements the
60+
updated
61+
<xref
62+
href="https://dita-lang.org/dita/archspec/base/processing-keyref-for-text"
63+
format="html"
64+
scope="external"
65+
>DITA 2.0 rules</xref> for generating key variable text.
66+
<xref href="https://github.com/dita-ot/dita-ot/issues/4644" format="html" scope="external">#4644</xref>
67+
</p>
68+
<p>In DITA 2.0, the <xmlelement>keytext</xmlelement> element provides a more flexible way to define the text
69+
content for key references. When a key is defined with <xmlelement>keytext</xmlelement>, this content is
70+
used to populate key references that resolve to text.</p>
71+
<p>Key processing now determines the DITA version of the map that declared each key and applies the
72+
appropriate resolution rules. When you combine DITA 1.x and DITA 2.0 maps in a single publication:</p>
73+
<ul>
74+
<li>Key references to keys defined in DITA 1.x maps use the <xmlelement>keyword</xmlelement> element for
75+
text resolution (as in previous versions).</li>
76+
<li>Key references to keys defined in DITA 2.0 maps use the <xmlelement>keytext</xmlelement> element for
77+
text resolution (following the DITA 2.0 specification).</li>
78+
</ul>
79+
<p>This approach allows you to gradually migrate content to DITA 2.0 without rewriting existing key
80+
definitions. However, mixing DITA versions in a single publication is not generally recommended.</p>
81+
</li>
82+
<li>
83+
<p id="4600">Simple chunking cases in DITA 1.x maps can now be processed using the DITA 2.0 chunking module
84+
in compatibility mode. For example, a DITA 1.3 map with <codeph>chunk="to-content"</codeph> is now
85+
processed as if it used the DITA 2.0 <codeph>chunk="combine"</codeph> action. This refactoring improves
86+
reliability by leveraging the newer chunking code, which has fewer bugs than the legacy implementation.
87+
Note that this may change how splitting operations generate file names.
88+
<xref href="https://github.com/dita-ot/dita-ot/issues/4600" format="html" scope="external">#4600</xref>
89+
</p></li>
90+
<li>
91+
<p id="4635">The DITAVAL <xmlatt>outputclass</xmlatt> attribute has been renamed to
92+
<xmlatt>add-outputclass</xmlatt> to match the DITA 2.0 specification. Support for the old attribute name
93+
is retained for backwards compatibility, but a <msgnum>DOTA014W</msgnum> warning message is now generated
94+
when the deprecated <xmlatt>outputclass</xmlatt> attribute is used.
95+
<xref href="https://github.com/dita-ot/dita-ot/issues/4635" format="html" scope="external">#4635</xref>
96+
</p></li>
97+
<li>
98+
<p id="4711">DITA 2.0 chunk processing has been improved to support multiple operation tokens. This
99+
refactoring work lays the groundwork for future support of select tokens in DITA 2.0 chunk processing.
100+
<xref href="https://github.com/dita-ot/dita-ot/issues/4711" format="html" scope="external">#4711</xref>
101+
</p></li>
102+
<li>
103+
<p id="4734">DITA-OT now supports the DITA 2.0 <xmlelement>linktitle</xmlelement> element and recognizes
104+
both the DITA 1.3 and DITA 2.0 class attributes for <xmlelement>navtitle</xmlelement>. When using a DITA
105+
2.0 root map, the preprocessed map will contain both <xmlelement>linktext</xmlelement> (for DITA 1.3
106+
compatibility) and <xmlelement>linktitle</xmlelement> (for DITA 2.0) elements. Plug-ins that handle
107+
<xmlelement>navtitle</xmlelement> or <xmlelement>linktext</xmlelement> may need to be updated to handle
108+
these new elements.
109+
<xref href="https://github.com/dita-ot/dita-ot/issues/4734" format="html" scope="external">#4734</xref>
110+
</p></li>
70111
</ul>
71-
<p>This approach allows you to gradually migrate content to DITA 2.0 without rewriting existing key definitions.
72-
However, mixing DITA versions in a single publication is not generally recommended.</p>
73-
<p id="4600">Simple chunking cases in DITA 1.x maps can now be processed using the DITA 2.0 chunking module
74-
in compatibility mode. For example, a DITA 1.3 map with <codeph>chunk="to-content"</codeph> is now processed
75-
as if it used the DITA 2.0 <codeph>chunk="combine"</codeph> action. This refactoring improves reliability by
76-
leveraging the newer chunking code, which has fewer bugs than the legacy implementation. Note that this may
77-
change how splitting operations generate file names.
78-
<xref href="https://github.com/dita-ot/dita-ot/issues/4600" format="html" scope="external">#4600</xref>
79-
</p>
80-
<p id="4635">The DITAVAL <xmlatt>outputclass</xmlatt> attribute has been renamed to
81-
<xmlatt>add-outputclass</xmlatt> to match the DITA 2.0 specification. Support for the old attribute name is
82-
retained for backwards compatibility, but a <msgnum>DOTA014W</msgnum> warning message is now generated when
83-
the deprecated <xmlatt>outputclass</xmlatt> attribute is used.
84-
<xref href="https://github.com/dita-ot/dita-ot/issues/4635" format="html" scope="external">#4635</xref>
85-
</p>
86-
<p id="4734">DITA-OT now supports the DITA 2.0 <xmlelement>linktitle</xmlelement> element and recognizes both
87-
the DITA 1.3 and DITA 2.0 class attributes for <xmlelement>navtitle</xmlelement>. When using a DITA 2.0 root
88-
map, the preprocessed map will contain both <xmlelement>linktext</xmlelement> (for DITA 1.3 compatibility)
89-
and <xmlelement>linktitle</xmlelement> (for DITA 2.0) elements. Plug-ins that handle
90-
<xmlelement>navtitle</xmlelement> or <xmlelement>linktext</xmlelement> may need to be updated to handle
91-
these new elements.
92-
<xref href="https://github.com/dita-ot/dita-ot/issues/4734" format="html" scope="external">#4734</xref>
93-
</p>
94112
</section>
95113

96114
<section id="4716">
@@ -145,19 +163,19 @@
145163
definitions that include a topic ID (such as <codeph>href="topic.dita#id"</codeph>) are not affected.
146164
<xref href="https://github.com/dita-ot/dita-ot/issues/4638" format="html" scope="external">#4638</xref>
147165
</li>
148-
<li id="4711">DITA 2.0 chunk processing has been improved to support multiple operation tokens. This
149-
refactoring work lays the groundwork for future support of select tokens in DITA 2.0 chunk processing.
150-
<xref href="https://github.com/dita-ot/dita-ot/issues/4711" format="html" scope="external">#4711</xref>
151-
</li>
152-
<li>Saxon has been updated to version 12.9, which includes minor bug fixes.
153-
<xref href="https://github.com/dita-ot/dita-ot/issues/4712" format="html" scope="external">#4712</xref>,
154-
<xref href="https://github.com/dita-ot/dita-ot/issues/4739" format="html" scope="external">#4739</xref>
155-
</li>
156-
<li>XSpec has been upgraded to version 3.2.2, which improves XSLT test capabilities and now reports all
157-
failing tests in a file instead of just the first one.
158-
<xref href="https://github.com/dita-ot/dita-ot/issues/4665" format="html" scope="external">#4665</xref>
166+
<li>Several bundled dependencies have been upgraded to the latest versions:
167+
<ul>
168+
<li>Saxon has been updated to version 12.9, which includes minor bug fixes.
169+
<xref href="https://github.com/dita-ot/dita-ot/issues/4712" format="html" scope="external">#4712</xref>,
170+
<xref href="https://github.com/dita-ot/dita-ot/issues/4739" format="html" scope="external">#4739</xref>
171+
</li>
172+
<li>XSpec has been upgraded to version 3.2.2, which improves XSLT test capabilities and now reports all
173+
failing tests in a file instead of just the first one.
174+
<xref href="https://github.com/dita-ot/dita-ot/issues/4665" format="html" scope="external">#4665</xref>
175+
</li>
176+
</ul>
159177
</li>
160-
<li>Several internal code improvements have been made to enhance code quality, test coverage, and
178+
<li>Various internal code improvements have been made for better code quality, test coverage, and
161179
maintainability:
162180
<ul>
163181
<li>Test class names now consistently use a <codeph>Test</codeph> suffix

0 commit comments

Comments
 (0)