• Share
  • Email
  • Embed
  • Like
  • Private Content
Down the Rabbit Hole: Getting Started with the DITA Open Toolkit
 

Down the Rabbit Hole: Getting Started with the DITA Open Toolkit

on

  • 1,810 views

Workshop presentation from Intelligent Content 2012 in Pal

Workshop presentation from Intelligent Content 2012 in Pal

Statistics

Views

Total Views
1,810
Views on SlideShare
1,804
Embed Views
6

Actions

Likes
0
Downloads
5
Comments
1

2 Embeds 6

https://si0.twimg.com 5
https://twimg0-a.akamaihd.net 1

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel

11 of 1 previous next

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Down the Rabbit Hole: Getting Started with the DITA Open Toolkit Down the Rabbit Hole: Getting Started with the DITA Open Toolkit Presentation Transcript

    • Down the Rabbit Hole: Getting Started with the DITA Open Toolkit Sarah O’Keefe Scriptorium PublishingWednesday, February 22, 12
    • Sarah O’Keefe ❖ Founder and president, Scriptorium Publishing ❖ Content strategy for technical communication ❖ Interested in collision of content, publishing, and technologyWednesday, February 22, 12
    • Overview ❖ Installing the DITA Open Toolkit ❖ Generating output ❖ Customizing outputWednesday, February 22, 12
    • flickr: themaninblueWednesday, February 22, 12
    • Installing the OT ❖ Download from dita-ot.sourceforge.net ❖ Use version 1.5.4 for today ❖ DITA-OT1.5.4_full_easy_install_bin.zip ❖ USB drives contain DITA-OT1.5.4, unzipped for your convenienceWednesday, February 22, 12
    • Best practices ❖ Set up in top-level directory ❖ Do not use spaces in file names or directory names ❖ Use a stable build and not the development buildsWednesday, February 22, 12
    • Remember the command line? flickr: johnhurnWednesday, February 22, 12
    • Testing your installation ❖ Open a command window ❖ Navigate to your DITA OT folder ❖ Run ❖ ./startcmd.sh (UNIX) ❖ startcmd.bat (Windows) ❖ ant -f build_demo.xmlWednesday, February 22, 12
    • $ cd /DITA-OT1.5.4 $ ./startcmd.sh DITA_HOME environment variable is empty or not set You need to edit the startcmd.sh file.Wednesday, February 22, 12
    • #!/bin/sh # This file is part of the DITA Open Toolkit project hosted on Add this line. SPACES MATTER! # Sourceforge.net. See the accompanying license.txt file for # applicable licenses. # (c) Copyright IBM Corp. 2006 All Rights Reserved. DITA_HOME="/DITA-OT1.5.4" if [ "${DITA_HOME:+1}" != "1" ]; then echo "DITA_HOME environment variable is empty or not set"; exit 127; fi ...Wednesday, February 22, 12
    • $ ./startcmd.sh $ ant -f build_demo.xml Buildfile: build_demo.xml prompt.init: [....] prompt.output: [echo] [echo] output in the out directory [echo] [echo] Before rebuilding, please delete the output or the directory. BUILD SUCCESSFUL Total time: 33 seconds $ “Your OT is installed and working.”Wednesday, February 22, 12
    • It gets better. (No, it doesn’t.) flickr: wademWednesday, February 22, 12
    • Generating output flickr: cdemoWednesday, February 22, 12
    • Generating output Theory ant -f build.xml    -Dargs.input=input-ditamap    -Doutput.dir=output-folder    -Dtranstype=transformation-type Example ant -f build.xml -Dargs.input=C:/DITA- OT1.5.4/doc/userguide.ditamap -Doutput.dir=C:/out -Dtranstype=xhtmlWednesday, February 22, 12
    • Customizing output flickr: jpockeleWednesday, February 22, 12
    • flickr: Robobobobo Best practice: Create a pluginWednesday, February 22, 12
    • Creating a plugin ❖ Create a folder for the plugin ❖ Set up the plugin.xml and conductor.xml files ❖ Verify the installation with a tiny customizationWednesday, February 22, 12
    • Creating a folder for the plugin ❖ Plugins go in the OT’s plugins directory. ❖ Naming convention is: ❖ <your domain>.<your plugin> ❖ com.scriptorium.myhtmlWednesday, February 22, 12
    • Set up plugin.xml ❖ Copy from org.dita.xhtml folder ❖ Simplify <plugin id="com.scriptorium.myhtml"> <feature extension="dita.xsl.xhtml" file="xsl/myxsl.xsl"/> </plugin>Wednesday, February 22, 12
    • Set up conductor.xml ❖ Copy from org.dita.xhtml ❖ No changesWednesday, February 22, 12
    • myxsl.xsl (in xsl folder) <?xml version="1.0" encoding="UTF-8"?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/ XSL/Transform" version="1.0"> <xsl:template name="gen-user-header"> <div><img src="http://www.scriptorium.com/ images/HeaderImage.png" alt="scriptorium.com"/></div> </xsl:template> </xsl:stylesheet>Wednesday, February 22, 12
    • Integrate your changes $ ant -f integrator.xml Buildfile: integrator.xml lax: integrate: BUILD SUCCESSFUL Total time: 1 second $Wednesday, February 22, 12
    • Test the new plugin ❖ Same command as before $ ant -f build.xml -Dargs.input=/DITA- OT1.5.4/doc/userguide.ditamap -Doutput.dir= /out -Dtranstype=xhtmlWednesday, February 22, 12
    • More XSL customization ❖ Copy template from dita2xhtml.xsl (or referenced files) into myxhtml.xsl ❖ Modify as you likeWednesday, February 22, 12
    • Specifying custom CSS flickr: ffgWednesday, February 22, 12
    • Specifying custom CSS ❖ Set up your own build file ❖ Fix file paths ❖ Point build file at the custom CSS you wantWednesday, February 22, 12
    • Creating a custom build file ❖ In samples/ant_sample, locate sample_xhtml.xml ❖ Put a copy in the root OT folder and rename it: build_myxhtml.xmlWednesday, February 22, 12
    • Fix the file paths in custom build file <property name="sample.output.dir" value="/out/sample"/> <property name="css.source.dir" location="${dita.dir}/plugins/ com.scriptorium.myhtml/css"/>Wednesday, February 22, 12
    • Optionally, modify other settings ❖ args.input to specify the ditamap to process ❖ args.css for the CSS file name ❖ args.csspath for the CSS directory pathWednesday, February 22, 12
    • Run custom build and admire the results flickr: tompeters1994Wednesday, February 22, 12
    • Run custom build and admire the results ❖ Arguments are not needed if you customized the build file with your exact settings $ ant -f build_myxhtml.xml -Dargs.input=/ Users/okeefe/Documents/CSinTC/csintc.ditamap -Doutput.dir=/out -Dtranstype=xhtmlWednesday, February 22, 12
    • flickr: jpockele Beyond the basicsWednesday, February 22, 12
    • You will need… ❖ XHTML or HTML5 ❖ CSS ❖ Apache Ant ❖ XSLT ❖ XML DTDs ❖ XSL-FO (for PDF customization)Wednesday, February 22, 12
    • Take care of formalities flickr: Carly & ArtWednesday, February 22, 12
    • Keep changes in plugins folder and custom build files ❖ Do not change core Open Toolkit ❖ Use code comments extensivelyWednesday, February 22, 12
    • Document your changes! amazon.comWednesday, February 22, 12
    • Q & A flickr: gracewongWednesday, February 22, 12
    • Visit our booth… ❖ Sarah O’Keefe ❖ okeefe@scriptorium.com ❖ Twitter: @sarahokeefe ❖ www.scriptorium.com ❖ BTW, we’re hiring. ❖ Also, we have chocolate.Wednesday, February 22, 12