Dita for Publishers HTML5 plugin

The DITA for Publishers HTML5 plugin makes it possible to generate complete HTML5-based Web sites including all the supporting Javascript and CSS files. It manages generating the HTML5 source and copying any supporting toolking for the Web site. You can configure the theme you want or use any HTML5 library or design you prefer.

The HTML5 plugin depends on the following other plugins:

• The DITA Community org.dita-community.common.html plugin
• The DITA Community org.dita-community.preprocess-extensions plugin
• The D4P org.dita4publishers.common.mapdriven plugin
• The D4P org.dita4publishers.common.xslt" plugin
• The D4P org.dita4publishers.json" plugin

All these plugins are provided in the main DITA for Publishers distribution or you can install each plugin individually.

NOTE: Currently only works with the 1.8.5 Open Toolkit due to dependencies on the org.dita-community.adjust-copy-to plugin, which only works with 1.8.5. Work is under way to remove this limitation so the transform will work with OT 1.7.5, 1.8.5, and 2.1+.

Updates

18 June 2015: Take @copy-to into account for result files.

Installation

There three ways to install the plugin:

1. Download the DITA for Publishers main distribution and install it.
2. Download this repository as a Zip from Github and extract it into your Toolkit's plugins/ directory
3. Use git to clone this repository into your Toolkit's plugins directory (if you want to be really clever you can make the Toolkit's plugins/ directory into a git repo and configure each plugin you want to track as a git submodule. See the DITA for Publishers project wiki for details on how to work with git submodules).

Additional steps for developers

If you want to do development on top of the HTML5 plugin, you will need to install the YUI compressor. This tool is used to compress your css and javascripts assets.

• Download the YUI compressor version 2.4.7
• extract the content into the org.dita4publishers.html5 plugin directory

Notes:

• The YUI compressor version 2.4.8 does not work properly on Windows. There is a path resolution issue.
• 3 July 2014 - Due to a java issue, there is no way to have the GET task working properly with ant over SSL on Java 7. I had to remove the YUI compressor installer

Running the transformation

Using Ant:
ant -Dargs.input=samples/hierarchy.ditamap -Doutput.dir=out/garage-num -Dtranstype=d4p-html5

Using Java:
java -jar lib\dost.jar /i:samples/hierarchy.ditamap /transtype:d4p-html5

Documentation

The documentation has been moved to the main Dita4Publishers project.

Authors and Contributors

• Bertrand Lefort
• Eliot Kimber Contrext, LLC
• Jim Owens
• Ray Fan Tweedle
• Mica Semrick Silent Umbrella