1 / 25

DITA

DITA. Darwin Information Typing Architecture. What is DITA?. What is DITA. DITA is an XML-based end-to-end architecture for authoring, producing, and delivering technical information. (Wikipedia). One Slide History.

ciaran-guy
Download Presentation

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. DITA Darwin Information Typing Architecture

  2. What is DITA?

  3. What is DITA DITA is an XML-based end-to-end architecture for authoring, producing, and delivering technical information. (Wikipedia)

  4. One Slide History • Originally developed by IBM in 2000 by a cross-company work group after an effort to organize all their technical documentation into a single source. • March 2004, IBM donated DITA to the Organization for the Advancement of Structured Information Systems (OASIS). • May 3rd, 2005 - DITA version 1.0 approved as an OASIS Standard • OASIS continues to update DITA and are currently on version 1.1

  5. How Does It Work?

  6. How It Works • DITA divides content into small, self-contained topics that can be reused in different deliverables. • The core of DITA consists of a topic DTD (Document Type Definition, an XML scheme langauge a.k.a XML “templates”—) and a map DTD (topic) • Besides generic topic type, DITA specifies three basic topic types, Task, Concept and Reference. • These are then put into Topic maps.

  7. Topic Types?!

  8. If You Get HTML and XML… <topic id="topic"> <title>Dancing</title> <body> <p> Dancing is a very difficult art to master but fun to screw up.</p> </body> </topic>

  9. The Three Basics Topic Types • Task Topic • Concept Topic • Reference Topic

  10. Task Topic • Describes how to accomplish a task. It lists a series of steps that users follow to produce a specified outcome. (EX: Move your leg)

  11. Task Topic Example <task id= "movingalimb"> <title>Moving a leg</title> <taskbody> <context>If you want to dance you have to do this.</context> <steps> <step><cmd>Get your brain to tell the muscles in you leg to move</cmd></step> <step><cmd>Move your foot forward and set it down again.</cmd></step> </steps> </taskbody> </task>

  12. Concept Topic • Information designed to be more objective, containing definitions, rules, and guidelines. (EX: History of Dance)

  13. Concept Topic Example: <concept id=“danceintro"> <title>History of Dance</title> <shortdesc> People have been dancing since before recorded history.</shortdesc> <conbody> <p>Some early cultures that have records of early dancing are:</p> <ul> <li>Greece</li> <li>Egypt</li> </conbody> </concept>

  14. Reference Topic • Describes command syntax, programming instructions, other reference material; it usually contains detailed, factual material. (EX: A Dip)

  15. Reference Topic Example <reference id="refsample"> <title>The Dip</title> <refbody> <properties> <property> <proptype>Dip</proptype> <propvalue>Impressive/Basic</propvalue> <propdesc>A dip can be a basic but effective move for impressing a dance partner. It is executed by holding the partner firmly at between a 45 and 80 degree angle. If executed poorly it can result in injury.<propdesc> </property> </properties> </refbody> </reference>

  16. Topic Map Relationship Tables and Map Lists

  17. Map List Example <map title="Getting Started With Dance"> <topicref href="history.xml"> <topicref href=“basictypes.xml"/> <topicref href="modernforms.xml"/> </topicref> <topicref href=“basicsteps.xml"> <topicref href=“dip.xml"/> <topicref href=“spin.xml"/> <topicref href=“kicks.xml"/> <topicref href=“groups.xml"/> <topicref href=“exotic.xml"/> <topicref href=“professionals.xml"/> </topicref>

  18. Relationship Table Example

  19. Who Should Use DITA? ?

  20. You Should Use DITA If: • You have content online. • You exchange technical documentation with other groups that use DITA. • You have someone to enforce it

  21. Shouldn’t Use If: • No one will use it. • Your source is print based.

  22. Why Use It?

  23. Advantages • Topics can be easily reused in different deliverables. • Fragments of content within topics (or less commonly, topics themselves), can be reused through the use of content references. • Improves retrievability

  24. Questions

More Related