-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release/2.4' into develop
* release/2.4: Re-use migration info on HTML5 & legacy plug-ins Split contribution info between core & docs Add topic on migrating to 2.4 Add keys to migration map Link to new topic on DITA features used in docs Add topic on DITA features used in docs (Fixes #50) Increase stroke width, use $brand-primary color Normalize parameter tagging per coding guidelines Remove reference to obsolete command line tool Use new double-hyphen syntax in parameters intro Add “Extension points by plug-in” to docs updates List remaining issues resolved in v2.4 Draft 2.4 Release Highlights Add IDs to facilitate re-use Update FOP version key & add FOP Release Notes keys Archive 2.3 Release Notes for posterity Bump 'release' & 'maintenance-version' keys to 2.4
- Loading branch information
Showing
23 changed files
with
1,093 additions
and
866 deletions.
There are no files selected for viewing
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. --> | ||
|
||
<reference id="migrating-to-2.4"> | ||
|
||
<title>Migrating to release 2.4</title> | ||
|
||
<shortdesc>In DITA-OT 2.4, the <option>HTML5</option> transformation was refactored as an independent plug-in that no | ||
longer depends on the <option>XHTML</option> plug-in. </shortdesc> | ||
|
||
<refbody> | ||
<section> | ||
<note>This topic provides a summary of changes in DITA-OT 2.4 that may require modifications to custom stylesheets | ||
or plug-ins. For more information on changes in this release, see the | ||
<xref keyref="2.4-release-notes"/>.</note> | ||
</section> | ||
<section> | ||
<title>HTML5</title> | ||
<ul> | ||
<li> | ||
<div id="24-html5-split"> | ||
<p>The <option>HTML5</option> transformation introduced in release 2.0 as part of the <option>XHTML</option> | ||
plug-in was moved to a separate <option>HTML5</option> plug-in in release 2.2, but that version of the | ||
<option>HTML5</option> transformation still depended on the <option>XHTML</option> plug-in for certain | ||
common processing.</p> | ||
<p>In release 2.4, all dependencies between <option>HTML5</option> and <option>XHTML</option> have been | ||
removed to ensure that HTML5 processing can be further refactored in the future without affecting XHTML | ||
output, or other HTML-based transformations such as <option>eclipsehelp</option>, | ||
<option>htmlhelp</option> or <option>javahelp</option>.</p> | ||
</div> | ||
<p>Customizations that extended the previous HTML5 output under the <option>XHTML</option> plug-in (as | ||
provided in releases 2.0 and 2.1) or the <option>HTML5</option> plug-in that shipped with release 2.2 will | ||
need to be refactored to build on the new HTML5 plug-in.</p></li> | ||
<li> | ||
<p>Note title processing was revised in release 2.2 to include a common <codeph>note__title</codeph> class for | ||
note elements of all types. The legacy <codeph><varname>{$type}</varname>title</codeph> classes (such as | ||
<codeph>.notetitle</codeph>, <codeph>.cautiontitle</codeph>, <codeph>.tiptitle</codeph>, etc.) were | ||
included in release 2.2 for backwards compatibility, but have now been removed in release 2.4.</p> | ||
<p>Stylesheets that apply formatting overrides to note titles should be revised to replace the deprecated | ||
class selectors with the equivalent descendant selectors, for example:</p> | ||
<ul> | ||
<li><codeph>.note_note .note__title</codeph></li> | ||
<li><codeph>.note_caution .note__title</codeph></li> | ||
<li><codeph>.note_tip .note__title</codeph></li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</section> | ||
<section id="24-legacy-plugin-removal"> | ||
<title>Legacy plug-ins removed</title> | ||
<p>DITA-OT 2.4 no longer includes the following legacy transformation plug-ins in the default distribution:</p> | ||
<table frame="none" rowsep="1" colsep="0"> | ||
<title>Legacy plug-ins</title> | ||
<tgroup cols="2"> | ||
<colspec colname="c1" colnum="1" colwidth="1.0*"/> | ||
<colspec colname="c2" colnum="2" colwidth="1.0*"/> | ||
<thead> | ||
<row> | ||
<entry>Plug-in </entry> | ||
<entry>Source code location</entry> | ||
</row> | ||
</thead> | ||
<tbody> | ||
<row> | ||
<entry>DocBook</entry> | ||
<entry> | ||
<xref href="https://github.com/dita-ot/org.dita.docbook" format="html" scope="external"/></entry> | ||
</row> | ||
<row> | ||
<entry>Eclipse Content</entry> | ||
<entry> | ||
<xref href="https://github.com/dita-ot/org.dita.eclipsecontent" format="html" scope="external"/></entry> | ||
</row> | ||
<row> | ||
<entry>Word RTF</entry> | ||
<entry> | ||
<xref href="https://github.com/dita-ot/org.dita.wordrtf" format="html" scope="external"/></entry> | ||
</row> | ||
</tbody> | ||
</tgroup> | ||
</table> | ||
<note>If necessary, they may be re-installed from earlier DITA-OT distributions, but they are no longer actively | ||
maintained or supported by the core toolkit committers. The source code is available on GitHub for anyone | ||
interested in maintaining the plug-ins for use with future toolkit versions.</note> | ||
</section> | ||
|
||
</refbody> | ||
</reference> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.