extracting deliverables from dita

Download Extracting deliverables from DITA

Post on 13-May-2015




0 download

Embed Size (px)


  • 1.Extracting deliverables from DITA Sarah O'KeefeScriptorium Publishing

2. Preliminary notesYou should be hearing the presenter's audio atthis point.All participants are muted.Use the Questions tab in the GoToWebinarcontrol panel to ask questions anytime duringthe session.The webcast is being recorded. No participantinformation appears in the recording.The Q&A period at the end of the event will notbe recorded. 3. Poll: What is your DITA status? 4. DITA deliverable categories HTMLPDFCustom output Flickr: freewine 5. HTML output options DITA Open ToolkitVarious help authoring/conversion tools Flare RoboHelp ePublisher Pro DITA2GO 6. DITA Open Toolkit process Install the DITA Open Toolkit (!) Java Ant XSL processor XSL-FO processor (for PDF) Possibly other bits and piecesModify component les to get the output youwantGenerate output from the command line 7. Help authoring tools Set up template/congurationImport DITA content(optionally) Make changes in the helpauthoring toolPublish to HTML 8. About those last-minute changes The traditional authoring/publishing modelallows them.The automated publishing model eliminatesthem.The transition to the no tweaking mindset canbe painful.What are the costs and benets? 9. The DITA Open Toolkit is the best choice for HTML.Light customization withCSSIn-depth customizationwith XSLNo arbitrary formattingComplete automationFlickr: bobistraveling 10. The special case: WebHelp WebHelp = HTML-based help system withtripane interface (content, index, search)No support in DITA Open Toolkit (custom buildof tripane interface required)Commercial support via XMetaL, Flare, Trisoft,ePublisher Pro, DITA2GO, and perhaps othersBalance DITA Open Toolkit customization effortagainst license costs 11. PDF options DITA Open ToolkitPage layoutapplicationsOthersFlickr: freewine 12. PDF publishing is hard because: Printed page layouts have more options thanHTML layouts.Extensible Stylesheet Language FormattingObjects (XSL-FO) needs to supportsophisticated page layout options.Pushing XML into page layout tools ischallenging.Automation means giving up page-by-pageformatting. 13. Poll: The ve stages of DITA-based PDF publishingWhat's your stage? 14. Please choose one of the following terrifying options:DITA Open ToolkitPage-based layout tool FrameMaker InDesign QuarkHelp authoring/conversion tool RoboHelp ePublisher Pro Flare 15. PDF through the DITA Open Toolkit Very difcult to congureNo tweaking to x copytting problemsAlmost certainly the long-term winner 16. DITA Open Toolkit process Customize default PDF output to yourrequirements (once)Make fonts available to FO processor (once)Run Ant command to generate PDF 17. DITA Open Toolkit challenges FontsFormattingFoggy FOFOP foibles 18. PDF via FrameMaker Conguration, at a minimum, requiresmodifying a formatting templateNice PDFCan tweak to adjust pagination 19. FrameMaker process Modify the template to meet your requirements(once)Manage white space (tabs, newlines) (once)Open the map le(v8 and earlier) Generate intermediate bookSave as PDF 20. FrameMaker pitfalls Sensitive to whitespaceDITA specializationsRound-trippingAuthoring 21. FrameMaker recommendations Use DITA-FMx plug-in 22. PDF via InDesign Beautiful typographyCan tweak to adjust paginationNo default support for DITAExtensive conguration requiredWhitespace in XML results in anaphylacticshock for InDesign 23. InDesign process Transform DITA content into InDesign-friendlyXML via XSLT (once) Flatten map les Resolve and atten content references (conrefs) Modify structure of images and tables Control whitespace Do something about xrefs with InDesign scriptsSet up template in InDesign (once)Import modied XML into InDesign 24. DITA to InDesign challenges Extensive preprocessingRound-trippingAuthoringWhite space 25. What about the help authoring tools?Yes, if you need cross-browser,cross-platform help.Not the best choice for PDF only. 26. What are your PDF priorities? For typography, choose InDesign or similar.For automation, choose the DITA Open Toolkit.For a middle ground, choose FrameMaker. 27. Lower your standards. Does your audience care about ne typography?Less copytting = greater automation 28. Factors to consider for PDF output Platform requirementsTechnical resourcesTypography requirementsVelocityVolumeVersioning 29. Poll: How are you creating (or planning to create) PDF output? 30. DITA Open Toolkit PDF is not necessarily ugly.It just starts out that way.Making it pretty is a lot of work. 31. Custom output examplesYour ownimplementation ofweb-based helpMan pages and othercustom markupBuilding to anexisting formattingspecicationCustom markup, suchas IDML, XPS, or MIF Flickr: markdevries 32. XSL programming skill is an issue In-house resourcesContractors orconsultants?Technical skillsrequired are beyondtypical FrameMakertemplates, HTMLcoding, and CSS Flickr: jinxmcc 33. Automation has advantages Incremental builds (nightly updates)Zero manual formattingExcellent localization support in DITA OpenToolkit 34. Automation has disadvantages Initial conguration effortNo intermediate le for last-ditch copytting orcontent changesNo book-by-book customization 35. Overall recommendation for HTML Use the DITA Open ToolkitAutomation is more valuable than ability tonagle 36. Overall recommendation for PDF Weigh the benets of automation against thedifculty of implementing XSL-FORemember that localization support in DITA OTis excellent (and extensive)Consider the value of existing assets(FrameMaker or InDesign templates)How strict are your output requirements? Howstrict do they need to be? 37. Questions? Comments? 38. Contact information Sarah O'Keefeokeefe@scriptorium.comwww.scriptorium.comPhone: +919 459 5362Twitter: @sarahokeefe


View more >