dita darwin information typing architecture. what is dita?
Post on 21-Dec-2015
238 views
TRANSCRIPT
DITADITA
Darwin Information Typing ArchitectureDarwin Information Typing Architecture
What is DITA?What is DITA?
What is DITAWhat is DITA
DITA is an XML-based end-to-end DITA is an XML-based end-to-end architecture for authoring, producing, architecture for authoring, producing, and delivering technical information. and delivering technical information. (Wikipedia)(Wikipedia)
One Slide HistoryOne Slide History Originally developed by IBM in 2000 by a cross-company Originally developed by IBM in 2000 by a cross-company
work group after an effort to organize all their technical work group after an effort to organize all their technical documentation into a single source. documentation into a single source.
March 2004, IBM donated DITA to the Organization for the March 2004, IBM donated DITA to the Organization for the Advancement of Structured Information Systems (OASIS).Advancement of Structured Information Systems (OASIS).
May 3rd, 2005 - DITA version 1.0 approved as an OASIS May 3rd, 2005 - DITA version 1.0 approved as an OASIS
StandardStandard
OASIS continues to update DITA and are currently on OASIS continues to update DITA and are currently on version 1.1version 1.1
How Does It Work?How Does It Work?
How It WorksHow It Works DITA divides content into small, self-DITA divides content into small, self-
contained topics that can be reused in contained topics that can be reused in different deliverables.different deliverables.
The core of DITA consists of a topic DTD The core of DITA consists of a topic DTD (Document Type Definition, an XML (Document Type Definition, an XML scheme langauge a.k.a XML scheme langauge a.k.a XML “templates”—) and a map DTD (topic)“templates”—) and a map DTD (topic)
Besides generic topic type, DITA specifies Besides generic topic type, DITA specifies three basic topic types, three basic topic types, TaskTask, , ConceptConcept and and ReferenceReference. .
These are then put into Topic maps.These are then put into Topic maps.
Topic Types?!Topic Types?!
If You Get HTML and XML…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>
The Three Basics Topic TypesThe Three Basics Topic Types
Task TopicTask Topic
Concept TopicConcept Topic
Reference TopicReference Topic
Task TopicTask Topic
Describes how to accomplish a task. Describes how to accomplish a task. It lists a series of steps that users It lists a series of steps that users follow to produce a specified follow to produce a specified outcome. outcome.
(EX: Move your leg) (EX: Move your leg)
<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>
Task Topic ExampleTask Topic Example
Concept TopicConcept Topic
Information designed to be more Information designed to be more objective, containing definitions, objective, containing definitions, rules, and guidelines. rules, and guidelines.
(EX: History of Dance)(EX: History of Dance)
Concept Topic Example: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>
Reference TopicReference Topic
Describes command syntax, Describes command syntax, programming instructions, other programming instructions, other reference material; it usually reference material; it usually contains detailed, factual material.contains detailed, factual material.
(EX: A Dip)(EX: A Dip)
Reference Topic ExampleReference 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>
Topic MapTopic Map
Relationship Tables and Map ListsRelationship Tables and Map Lists
Map List ExampleMap 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>
Relationship Table ExampleRelationship Table Example
Who Should Use DITA?Who Should Use DITA?
??
You Should Use DITA If:You Should Use DITA If:
You have content online. You have content online.
You exchange technical You exchange technical documentation with other groups documentation with other groups that use DITA. that use DITA.
You have someone to enforce itYou have someone to enforce it
Shouldn’t Use If:Shouldn’t Use If:
No one will use it.No one will use it.
Your source is print based.Your source is print based.
Why Use It?Why Use It?
AdvantagesAdvantages
Topics can be easily reused in Topics can be easily reused in different deliverables. different deliverables.
Fragments of content within topics Fragments of content within topics (or less commonly, topics (or less commonly, topics themselves), can be reused through themselves), can be reused through the use of the use of content referencescontent references. .
Improves retrievability Improves retrievability
QuestionsQuestions
