1 / 22

Authoring with DITA

Authoring with DITA. Yas Etessam XML Technology Specialist Blast Radius XMetaL yas.etessam@blastradius.com. Agenda. Key DITA Concepts DITA-Based Authoring Demo Q&A. Key DITA Concepts. DITA for Software. DITA for Hardware. DITA for eLearning. DocBook. S1000D.

bernad
Download Presentation

Authoring with DITA

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Authoring with DITA Yas Etessam XML Technology Specialist Blast Radius XMetaL yas.etessam@blastradius.com

  2. Agenda • Key DITA Concepts • DITA-Based Authoring Demo • Q&A

  3. Key DITA Concepts

  4. DITA forSoftware DITA forHardware DITA foreLearning DocBook S1000D Going Beyond Conventional Doc Types DITA Document Types DITA Framework Base DITA Other Traditional Doc Types DITA Architecture Topics, Maps, Content Reuse, Specialization ` Other XHTML XML Elements, attributes, entities, DTDs, schemas SGML Other Unicode Character Representation

  5. Topics and Maps • Topic Orientation • Topic: a unit of information that is meaningful when it stands alone • Maps • Organize topics into a coherent set • Typically for different deliverables (e.g. PDF, Website, Help) Topics DITA Maps Deliverables

  6. Key DITA Concepts II • Information Type (infotype) • A specialization of a topic • Concept, Task, and Reference are primary types for technical documentation • New types can be created for other communities • Domains • Collections of elements for a particular subject area, e.g. Typographic, Programming, Software, User interfaces, Utilities • Used across infotypes e.g. FAQ for End Users, FAQ for Programmers

  7. Key DITA Concepts III • Specialization • Structural: Define new types of information • Domain: Define new markup (elements) that can be used across information types • Property-Based Processing • Metadata and attributes for filtering, personalization, searching • Used to implement Conditional Text

  8. DITA is Designed for Reuse

  9. DITA - Authoring Demo

  10. The Role of DITA Tools An authoring tool is a user interface for creating DITA content

  11. Tool usability affects: • The learning curve • Training costs • Author productivity • Adoption in and beyond the core tech pubs team • Overall success of the DITA deployment

  12. Evaluating DITA Authoring Tools • How easy is it to write using the tool? • How does the tool support special elements and attributes? • E.g. cross-references, content references, and conditional text • How does the tool support editing DITA maps? • How well does the tool handle DITA's attributes? • Does the tool make it easier to create deliverables through the DITA toolkit?

  13. Getting Started with DITA • Option 1: Assemble a solution from parts • Download and configure the correct version of JVM. • Download and configure “Ant.” • Download the DITA toolkit from sourceforge.net • Create content in a separate authoring tool. • Option 2: Install a free evaluation version of the XMetaL DITA Edition, which comes integrated with the toolkit

  14. XMetaL DITA Extension CMS Interface XMetaL Author DITA Open Toolkit XMetaL Platform Architectural Overview – XMetaL Author DITA Edition Single Source Publishing Topics Maps ReusableComponents

  15. Demonstration DITA AuthoringXMetaL Author DITA Edition

  16. XMetaL Author DITA Edition - Advantages • Accelerates user adoption • Natural Structured Authoring™ • Encourages reuse • Topic-Oriented User Interface • Reduces implementation cost • Out of the box behaviour for all DITA elements • Simplifies deployment • Transparent integration with DITA Open Toolkit

  17. XMetaL DITA Edition Features • Visual DITA Map Editor • Create headings and topics • Organize topic hierarchy • Set contextual metadata • Natural Structured Authoring™ • Smart insert • Automatic IDs • Attribute dialogs • Mini-Templates • Reusable Components • Inline creation and display of conrefs • Single Source Publishing • Conditional Text • PDF, HTML, Help generation • Index/TOC generation

  18. XMetaL DITA Edition Recap • New DITA Support • Visual Map Editing • Natural Structured Authoring™ • Reusable Components • Single Source Publishing • Plus all the standard XMetaL features: • Multiple Views: Normal, Tags-On, Plain Text (Source), Preview, and Structured • Continuous validation • CMS and application integrations • Revision marking • Resource Manager • Embeddable forms and controls • and much more…

  19. XMetaL Central XMetaL Author DITA Edition XMetaL Developer XMetaL Reviewer XMetaL Author XMetaL Family– The Big Picture COMPLETE CONTENT CREATION SOLUTIONS CONTENT RE-USE & SINGLE SOURCE PUBLISHING Desktop XML Authoring Websites Web-based XML Reviewing & Collaboration Handheld Devices Web-based XML Authoring CD-ROM Content Management System XMAX Print Topic-Based XML Authoring

  20. About Blast Radius • Develops products and solutions that integrate strategy, technology, and design to help clients deliver innovative, profitable customer experiences • Founded 1996; Acquired XMetaL business in 2004 • Growing rapidly: 350+ employees • 8 offices worldwide: Vancouver, Toronto, New York, Chicago, Los Angeles, San Francisco, Amsterdam, London • Named to Deloitte’s: • North America Fast 500, 2004 and 2005 • Canada’s 50 Best Managed Companies, 2004

  21. Global, Visionary Customers Global, Visionary Customers 1,000 customers across 40,000 installed seats of XMetaL High-Tech Automotive Aerospace Misc. Financial Publishing

  22. For More Information • XMetaL DITA Edition online help • OASIS DITA Cover Pages: http://xml.coverpages.org/dita.html • DITA Language Specification: http://xml.coverpages.org/DITAv10-OS-LangSpec20050509.pdf • Preparing for DITA: What you need to know: http://www.rockley.com/whitepap.htm • DITA-Users Yahoo Group: http://groups.yahoo.com/group/dita-users/ • DITA 2006 Conference: www.travelthepath.com/dita2006.html • Watch for more DITA resources on: www.xmetal.com www.xmetal.com 1-866-793-1542 products@blastradius.com

More Related