From 4579698d894b6fd439f06bb8031199aa3460a10c Mon Sep 17 00:00:00 2001 From: Shane Taylor Date: Mon, 15 Feb 2016 15:00:14 -0500 Subject: [PATCH 1/4] Initial migration info for 2.0 --- dev_ref/dev_ref.ditamap | 11 ++++---- dev_ref/migrating-to-2.0.dita | 51 +++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 5 deletions(-) create mode 100644 dev_ref/migrating-to-2.0.dita diff --git a/dev_ref/dev_ref.ditamap b/dev_ref/dev_ref.ditamap index a2f86eef4..84c12e5dd 100644 --- a/dev_ref/dev_ref.ditamap +++ b/dev_ref/dev_ref.ditamap @@ -58,13 +58,14 @@ - - - + + To 2.0 + To 1.8 + To 1.7 - - + To 1.6 + To 1.5.4 diff --git a/dev_ref/migrating-to-2.0.dita b/dev_ref/migrating-to-2.0.dita new file mode 100644 index 000000000..700377f28 --- /dev/null +++ b/dev_ref/migrating-to-2.0.dita @@ -0,0 +1,51 @@ + + + + + Migrating to Release 2.0 + In DITA-OT 2.0, XSLT templates were converted to XSLT 2.0, variable typing was + implemented, and some older templates were refactored or removed. In addition, the + dita command simplifies distribution of plugins by allowing installation + from a URL.There are likely other changes that should be noted + here. See + + + +
+ All Transformations — Variable Typing +

XSLT stylesheets were converted to XSLT 2.0. With that change, variable types were also + implemented. Plugins that change template variable values will need to make the following + changes:

+
    +
  • Declare the same types defined in the default templates with as.
    • +
  • Ensure that the generated values conform to the declared type.
    • +
+
+ +

For example:

+ <xsl:variable name="urltest"> +<xsl:variable name="urltest" as="xs:boolean"> + +
+ All Transformations — Refactoring +

Much of the toolkit code was refactored for release 2.0. Customization changes that were + based on a specific template in a previous version of the toolkit might not work because + the modified template is no longer used. If this is the case, the changes will need to be + reimplemented based on the new XSLT templates.

+
+ +
+ HTML5 +

A new transformation type has been added. Customizations that + previously modified the XHTML output to generate valid HTML5 should still work, but basing + your customization on the new transformation type might simplify the customization and + reduce the work required to maintain compatibility with future versions of the toolkit.

+
+
+ Plugin Installation and Distribution +

Plugins can now be installed or uninstalled from a ZIP archive using the new + dita command. Plugins can also be installed from a referenced URL. See + .

+
+ + From 31f5d1837f4a055550353cb476f72ac11d303923 Mon Sep 17 00:00:00 2001 From: Shane Taylor Date: Fri, 29 Jan 2016 22:53:34 -0500 Subject: [PATCH 2/4] Initial migration info for 2.1 --- dev_ref/dev_ref.ditamap | 1 + dev_ref/migrating-to-2.1.0.dita | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 dev_ref/migrating-to-2.1.0.dita diff --git a/dev_ref/dev_ref.ditamap b/dev_ref/dev_ref.ditamap index 84c12e5dd..3b941947e 100644 --- a/dev_ref/dev_ref.ditamap +++ b/dev_ref/dev_ref.ditamap @@ -59,6 +59,7 @@ + To 2.1 To 2.0 To 1.8 To 1.7 diff --git a/dev_ref/migrating-to-2.1.0.dita b/dev_ref/migrating-to-2.1.0.dita new file mode 100644 index 000000000..f4a036510 --- /dev/null +++ b/dev_ref/migrating-to-2.1.0.dita @@ -0,0 +1,27 @@ + + + + + Migrating to Release 2.1.0 + In DITA-OT 2.1.0, the insertVariable template was deprecated for PDF + transformations.There are likely other changes that should be + noted here. See + + +
+ PDF +

The following template has been deprecated:

+
    +
  • insertVariable
    • +
+

Calls to that template will result in warnings in the build log. To update your plugin, + make the following changes:

+ <xsl:call-template name="insertVariablegetVariable"> + <xsl:with-param name="theVariableIDid" select="var-id"/> + <xsl:with-param name="theParametersparams"> + params + </xsl:with-param> +</xsl:call-template> +
+ + From 77ec79d50598e9b4eadffb0cb5eddf13f8c982c5 Mon Sep 17 00:00:00 2001 From: Shane Taylor Date: Sat, 30 Jan 2016 15:22:37 -0500 Subject: [PATCH 3/4] Initial migration info for 2.2 --- dev_ref/dev_ref.ditamap | 1 + dev_ref/migrating-to-2.0.dita | 3 ++ dev_ref/migrating-to-2.2.0.dita | 72 +++++++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+) create mode 100644 dev_ref/migrating-to-2.2.0.dita diff --git a/dev_ref/dev_ref.ditamap b/dev_ref/dev_ref.ditamap index 3b941947e..e36613baf 100644 --- a/dev_ref/dev_ref.ditamap +++ b/dev_ref/dev_ref.ditamap @@ -59,6 +59,7 @@ + To 2.2 To 2.1 To 2.0 To 1.8 diff --git a/dev_ref/migrating-to-2.0.dita b/dev_ref/migrating-to-2.0.dita index 700377f28..02b8bb8f4 100644 --- a/dev_ref/migrating-to-2.0.dita +++ b/dev_ref/migrating-to-2.0.dita @@ -40,6 +40,9 @@ previously modified the XHTML output to generate valid HTML5 should still work, but basing your customization on the new transformation type might simplify the customization and reduce the work required to maintain compatibility with future versions of the toolkit.

+ The transformation was refactored with release 2.2.0. Before + basing your customization on the changes in release 2.0, consider whether you might want to + move to release 2.2.0 instead. See .
Plugin Installation and Distribution diff --git a/dev_ref/migrating-to-2.2.0.dita b/dev_ref/migrating-to-2.2.0.dita new file mode 100644 index 000000000..362fe54a2 --- /dev/null +++ b/dev_ref/migrating-to-2.2.0.dita @@ -0,0 +1,72 @@ + + + + + Migrating to Release 2.2.0 + In DITA-OT 2.2.0, the transformation was refactored as its own + plugin and separate plugins were created for each of the rendering engine-specific PDF + transformations.There are likely other changes that should be + noted here. + +
+ HTML5 +

The transformation introduced in release 2.0 as part of the + plugin has been moved to a separate plugin. + Customizations that extended the previous HTML5 output under the + plugin will probably need to be refactored on the new HTML5 plugin.

+
+
+ PDF +

Processing specific to Apache FOP, Antenna House Formatter, and RenderX XEP has been + separated into separate plugins for each of those rendering engines. Customizations that + extended this processing might need to extend the new org.dita.pdf2.fop, + org.dita.pdf2.axf, or org.dita.pdf2.xep plugins.

+

PDF customizations that are not specific to a rendering engine can continue to extend the + org.dita.pdf2 plugin as before.

+
+
+ Consider whether some of the folloing might be useful:
    +
  • some elements are mapped differently ;see http://www.dita-ot.org/2.1/release-notes/index.html
    • +
  • +
  • The customFileUtils code used to handle input and output + in earlier versions of DITA-OT has been replaced with the Apache Commons IO utilities library.
      +
    • 1803 Use Commons IO
      • +
    • +

  • Support for theargs.odt.img.embed parameter has been removed from OpenDocument + format transformations.

    The previous default behavior was to embed images as + Base64-encoded text, but editors do not use this as a default. Instead, office packages + such as LibreOffice will convert embedded images into linked images on opening and + saving an ODT file.
      +
    • 1832 Remove support for args.odt.img.embed
      • +
    • +

  • Keydef processing has been removed from the XHTML rendering code

    Keys are now + resolved in one preprocessing step, whereas in earlier versions of DITA-OT, the XHTML + code returned to thekeydef.xml file to look up targets for phrase elements and pull in + text when needed. This change affects non-linking elements that can't take + @href attributes, such as + <ph>, <keyword>, + <cite>, <dt>, + <term>, and + <indexterm> (when + $INDEXSHOW is active).
      +
    • 1837 Remove keydef processing from XHTML rendering + code
      • +
    • +

  • A newdita.parser extension point has been added to + allow plug-ins to contribute a custom parser for DITA files.

    If a custom DITA + parser is defined, the preprocessing routines will use it during the gen-list and + debug-filter stages to output DITA XML.
      +
    • 1847 Extension-point for custom DITA parsers
      • +
    • +
+
+ + From 6400e833ababb81cdf13ddaa855e152332375ac8 Mon Sep 17 00:00:00 2001 From: Shane Taylor Date: Mon, 15 Feb 2016 20:34:03 -0500 Subject: [PATCH 4/4] Change 2.2.0 to 2.2, 2.1.0 to 2.1 per feedback --- dev_ref/dev_ref.ditamap | 4 ++-- dev_ref/migrating-to-2.0.dita | 4 ++-- dev_ref/{migrating-to-2.1.0.dita => migrating-to-2.1.dita} | 6 +++--- dev_ref/{migrating-to-2.2.0.dita => migrating-to-2.2.dita} | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) rename dev_ref/{migrating-to-2.1.0.dita => migrating-to-2.1.dita} (86%) rename dev_ref/{migrating-to-2.2.0.dita => migrating-to-2.2.dita} (96%) diff --git a/dev_ref/dev_ref.ditamap b/dev_ref/dev_ref.ditamap index e36613baf..b4a244608 100644 --- a/dev_ref/dev_ref.ditamap +++ b/dev_ref/dev_ref.ditamap @@ -59,8 +59,8 @@ - To 2.2 - To 2.1 + To 2.2 + To 2.1 To 2.0 To 1.8 To 1.7 diff --git a/dev_ref/migrating-to-2.0.dita b/dev_ref/migrating-to-2.0.dita index 02b8bb8f4..0eb2e0a8f 100644 --- a/dev_ref/migrating-to-2.0.dita +++ b/dev_ref/migrating-to-2.0.dita @@ -40,9 +40,9 @@ previously modified the XHTML output to generate valid HTML5 should still work, but basing your customization on the new transformation type might simplify the customization and reduce the work required to maintain compatibility with future versions of the toolkit.

- The transformation was refactored with release 2.2.0. Before + The transformation was refactored with release 2.2. Before basing your customization on the changes in release 2.0, consider whether you might want to - move to release 2.2.0 instead. See . + move to release 2.2 instead. See .
Plugin Installation and Distribution diff --git a/dev_ref/migrating-to-2.1.0.dita b/dev_ref/migrating-to-2.1.dita similarity index 86% rename from dev_ref/migrating-to-2.1.0.dita rename to dev_ref/migrating-to-2.1.dita index f4a036510..7975c93b8 100644 --- a/dev_ref/migrating-to-2.1.0.dita +++ b/dev_ref/migrating-to-2.1.dita @@ -1,9 +1,9 @@ - - Migrating to Release 2.1.0 - In DITA-OT 2.1.0, the insertVariable template was deprecated for PDF + + Migrating to Release 2.1 + In DITA-OT 2.1, the insertVariable template was deprecated for PDF transformations.There are likely other changes that should be noted here. See diff --git a/dev_ref/migrating-to-2.2.0.dita b/dev_ref/migrating-to-2.2.dita similarity index 96% rename from dev_ref/migrating-to-2.2.0.dita rename to dev_ref/migrating-to-2.2.dita index 362fe54a2..37bd4ffee 100644 --- a/dev_ref/migrating-to-2.2.0.dita +++ b/dev_ref/migrating-to-2.2.dita @@ -1,9 +1,9 @@ - - Migrating to Release 2.2.0 - In DITA-OT 2.2.0, the transformation was refactored as its own + + Migrating to Release 2.2 + In DITA-OT 2.2, the transformation was refactored as its own plugin and separate plugins were created for each of the rendering engine-specific PDF transformations.There are likely other changes that should be noted here.