Skip to content

Commit

Permalink
Merge branch 'release/2.4' into develop
Browse files Browse the repository at this point in the history
* 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
infotexture committed Nov 12, 2016
2 parents bfd28ea + f04c510 commit 28d2747
Show file tree
Hide file tree
Showing 23 changed files with 1,093 additions and 866 deletions.
Binary file modified dev_ref/images/processing-flow.graffle
Binary file not shown.
Binary file modified dev_ref/images/processing-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
261 changes: 2 additions & 259 deletions dev_ref/images/processing-flow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 89 additions & 0 deletions dev_ref/migrating-to-2.4.dita
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>
15 changes: 8 additions & 7 deletions dev_ref/migration.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@
<map>
<title>Migrating customizations</title>
<topicref href="migration.dita" keys="migration" locktitle="yes">
<topicref href="migrating-to-2.3.dita" navtitle="To 2.3"/>
<topicref href="migrating-to-2.4.dita" keys="migrating-to-2-4" navtitle="To 2.4"/>
<topicref href="migrating-to-2.3.dita" keys="migrating-to-2-3" navtitle="To 2.3"/>
<topicref href="migrating-to-2.2.dita" keys="migrating-to-2-2" navtitle="To 2.2"/>
<topicref href="migrating-to-2.1.dita" navtitle="To 2.1"/>
<topicref href="migrating-to-2.0.dita" navtitle="To 2.0"/>
<topicref href="migrating-to-1.8.dita" navtitle="To 1.8"/>
<topicref href="migrating-to-1.7.dita" navtitle="To 1.7">
<topicref href="migrating-to-2.1.dita" keys="migrating-to-2-1" navtitle="To 2.1"/>
<topicref href="migrating-to-2.0.dita" keys="migrating-to-2-0" navtitle="To 2.0"/>
<topicref href="migrating-to-1.8.dita" keys="migrating-to-1-8" navtitle="To 1.8"/>
<topicref href="migrating-to-1.7.dita" keys="migrating-to-1-7" navtitle="To 1.7">
<topicref rev="1.7" href="flagging-migration.dita" keys="flagging-migration" navtitle="Flagging updates"/>
</topicref>
<topicref href="migrating-to-1.6.dita" navtitle="To 1.6"/>
<topicref href="migrating-to-1.5.4.dita" navtitle="To 1.5.4"/>
<topicref href="migrating-to-1.6.dita" keys="migrating-to-1-6" navtitle="To 1.6"/>
<topicref href="migrating-to-1.5.4.dita" keys="migrating-to-1-5-4" navtitle="To 1.5.4"/>
</topicref>
</map>
2 changes: 1 addition & 1 deletion dev_ref/pdf-customization-example.dita
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
plugin.xml</codeblock>
</result>
<postreq>
<p>Run <filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <option>--install</option> to install the plug-in and make the <option>print-pdf</option> transformation
<p>Run <filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--install</parmname> to install the plug-in and make the <option>print-pdf</option> transformation
available.</p>
</postreq>
</taskbody>
Expand Down
2 changes: 1 addition & 1 deletion dev_ref/plugins-installing.dita
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<step>
<cmd>At the command-line prompt, enter the following command:</cmd>
<info>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <option>--install</option>=<varname>plug-in-zip</varname></codeblock>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--install</parmname>=<varname>plug-in-zip</varname></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"/>
Expand Down
2 changes: 1 addition & 1 deletion dev_ref/plugins-removing.dita
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<step>
<cmd>At the command-line prompt, enter the following command:</cmd>
<info>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <option>--uninstall</option>=<varname>plug-in-id</varname></codeblock>
<codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--uninstall</parmname>=<varname>plug-in-id</varname></codeblock>
<p>where:</p>
<ul>
<li conref="../resources/conref-task.dita#ID/novice-variables-1"/>
Expand Down
8 changes: 4 additions & 4 deletions parameters/dita-command-arguments.dita
Original file line number Diff line number Diff line change
Expand Up @@ -185,14 +185,14 @@
</plentry>
<plentry>
<pt>
<parmname>--parameter=value</parmname></pt>
<parmname>--parameter</parmname>=<varname>value</varname></pt>
<pt>
<parmname>-D</parmname><varname>parameter</varname>=<varname>value</varname>
</pt>
<pd>Specify a value for a DITA-OT or Ant build parameter.
<p>The GNU-style <parmname>--parameter=value</parmname> form is only available for parameters that are
configured in the plug-in configuration file; the Java-style <parmname>-D</parmname> form can also be used
to specify additional non-configured parameters or set system properties.</p>
<p>The GNU-style <parmname>--parameter</parmname>=<varname>value</varname> form is only available for
parameters that are configured in the plug-in configuration file; the Java-style <parmname>-D</parmname>
form can also be used to specify additional non-configured parameters or set system properties.</p>
<p>Parameters not implemented by the specified transformation type or referenced in a
<filepath>.properties</filepath> file are ignored.</p><note
conref="../resources/conref-task.dita#ID/pass-input-dir"/></pd>
Expand Down
2 changes: 1 addition & 1 deletion parameters/parameters.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<topicref href="dita-command-arguments.dita" keys="dita-command-arguments"/>
<topicref href="parameters_intro.dita" keys="dita-ot-params">
<topicref href="parameters-base.dita" keys="parameters-base" navtitle="Common"/>
<topicref href="parameters-base-html.dita">
<topicref href="parameters-base-html.dita" keys="parameters-base-html">
<topicref href="generate-copy-outer.dita" keys="generate-copy-outer" toc="no"/>
</topicref>
<topicref href="parameters-html5.dita"/>
Expand Down
6 changes: 3 additions & 3 deletions parameters/parameters_intro.dita
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

<shortdesc>Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based
transformations. Some parameters apply only to specific transformation types. These parameters can be passed as
options to the <cmdname>dita</cmdname> command using the <option>-Dparameter-name=value</option> syntax or included
options to the <cmdname>dita</cmdname> command using the <parmname>--parameter</parmname>=<varname>value</varname> syntax or included
in build scripts as Ant properties.</shortdesc>

<refbody>
<section>
<p>If your toolkit installation includes custom plug-ins that define additional parameters, you can
add entries to the following topics by rebuilding the DITA-OT documentation.</p>
<p>If your toolkit installation includes custom plug-ins that define additional parameters, you can add entries to
the following topics by rebuilding the DITA-OT documentation.</p>
</section>
</refbody>
</reference>
Loading

0 comments on commit 28d2747

Please sign in to comment.