dita 101 -- why the buzz
TRANSCRIPT
![Page 1: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/1.jpg)
DITA 101: Why the Buzz?
Sarah O'KeefeScriptorium Publishing
![Page 2: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/2.jpg)
About the presenter
Sarah O'KeefeFounder and president, Scriptorium PublishingConsultantExperienced with lots of different publishing ideas, including XML and DITA
![Page 3: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/3.jpg)
You've got questions...
...we've got answersType any questions in the Question and Answer area of the GoToWebinar barSharon Burton, MadCap Product manager, will do her best to answerI will provide contact information if you need to follow up after the webinar
![Page 4: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/4.jpg)
Housekeeping notes for this webinar
You are muted. Feel free to talk...but we can't hear you.We’re recording this webinar for posterity.
Your information will not appear in the final webinar.We will send you the download link in a follow-up email, which will also include...A short survey. Please fill it out so that we can make future webinars better.
We should be done by the top of the hour.We know you have a busy day.
![Page 5: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/5.jpg)
Overview
What is DITA?Key DITA conceptsTypical scenarios for DITAIs DITA right for you?
![Page 6: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/6.jpg)
What is DITA?
Darwin Information Typing ArchitectureDarwin – because you can evolve new elements from existing elementsInformation Typing – content is categorized as task, reference, conceptArchitecture – includes components for reuse, single sourcing, and generating output
Developed by IBM, maintained by OASIS
![Page 7: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/7.jpg)
Why is DITA important? Is DITA important?
Structured authoring is creating content with programmatic enforcement of the required structureDITA is a gateway to structured authoring
![Page 8: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/8.jpg)
What is DITA, really?
XML standardBuilt for topic-oriented authoringA way to work in XML without having to design your own structure?A major buzzword in tech commCost-effective way to create, publish, reuse, and exchange structured content
![Page 9: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/9.jpg)
DITA components
Document type definitions (DTDs)Open Toolkit for generating output
HTML, Eclipse help, CHM, and others through XSLPDF through XSL-FO
Documentation
![Page 10: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/10.jpg)
DITA publishing
DITA topics
DITA Open Toolkit
HTMLCHMPDFEclipse help…
DITA map fileDITA topics
Links
<topic>...</topic>
DITA map file
<map> <topic>... </topic> <topic>... </topic></map>
![Page 11: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/11.jpg)
What DITA is not
![Page 12: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/12.jpg)
It's more like this...
![Page 13: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/13.jpg)
Is DITA better than XML?
![Page 14: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/14.jpg)
Which is better?
![Page 15: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/15.jpg)
![Page 16: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/16.jpg)
![Page 17: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/17.jpg)
DITA's niche
Topic-oriented, modular contentContent reuseInformation exchange with other organizationSemantic requirements are minimalBasic metadata (audience, platform, output) is adequate
![Page 18: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/18.jpg)
DITA strengths
Topic-oriented, modularSupport for reuse of topics (map files)Support for reuse of content (content references)Specialization mechanism for customization of content model
![Page 19: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/19.jpg)
DITA weaknesses
Generic content modelOutput through Open Toolkit is rudimentarySpecialization can be challenging
![Page 20: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/20.jpg)
DITA topic (simplified)
<topic id=”seuss”><title>One tag, two tag</title><body>
<p>Red tag, blue</p> <p>Black tag, blue tag, old tag, new tag</p> <p>This one has a little car</p> <p>This one has a little star</p> <note>Say, what a lot of tags there are!</note></body>
</topic>
![Page 21: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/21.jpg)
<?xml version="1.0"?><!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd"><dita> <topic id="aardvark" audience="internal"> <title>Aardvark</title> <body> <p>Aardvarks eat mostly termites. </p> <p>Do not take the aardvarks' offer to help deal with your termite problem. You will <b>not</b> like the results.</p> <note type="danger" id="nofeeding">Do not feed animals snacks, scraps, or people food.</note> </body> </topic> </dita>
![Page 22: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/22.jpg)
Key DITA concepts
TopicsMap filesContent references (conrefs)Specialization
![Page 23: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/23.jpg)
Topics
Requires writing modular contentThink about consistency and making pieces reusableA writing challenge rather than a technology challenge
![Page 24: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/24.jpg)
Map files
Let you organize topics sequentially and hierarchicallyBasis for creating books, help, deliverables
![Page 25: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/25.jpg)
<?xml version="1.0"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
rev="1" title="Zoo Policies" xml:lang="en-us">
<topicmeta>
<author>Sarah</author>
<critdates>
<created date="2006/10/31"/>
<revised modified="2009/01/31"/>
</critdates>
</topicmeta>
<topicref href="Animal_nutrition.xml" navtitle="Animal nutrition" type="reference">
<topicref href="Aardvark.xml" navtitle="Aardvark" type="topic"/>
<topicref href="Baboon.xml" navtitle="Baboon" type="topic"/>
<topicref href="Crane.xml" navtitle="Crane" type="topic"/>
<topicref href="Dingo.xml" navtitle="Dingo" type="topic"/>
</topicref>
<topicref href="Visitor_behavior.xml" navtitle="Visitor behavior" type="topic">
<topicref href="Adults.xml" navtitle="Adults" type="topic"/>
<topicref href="Children.xml" navtitle="Children" type="topic"/>
</topicref>
</map>
![Page 26: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/26.jpg)
conrefs <topic id="aardvark">
...
<note type="danger" id="nofeeding">Do not feed animals snacks, scraps, or people food.
…
<topic>
Named destination in Aardvark.xml
id="baboon"><title>Baboon</title><body>
<p>Baboons eat mostly fruit.</p> <p> <note conref="Aardvark.xml#aardvark/nofeeding"/> </p>
</body></topic>
Link in Baboon.xml
![Page 27: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/27.jpg)
Specialization
Lets you create additional elements without breaking DITA Open Toolkit processing.New element is a specialization of the base element.This is what put the D in DITA.
![Page 28: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/28.jpg)
The structure you need versus the structure you have...
CustomizationSubsettingSpecialization
![Page 29: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/29.jpg)
Customization
![Page 30: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/30.jpg)
Subsetting
![Page 31: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/31.jpg)
Specialization
![Page 32: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/32.jpg)
Business case for XML
Content exchangeDatabase publishingReuse content/reduce duplicationAutomated formatting/publishingCompliance
![Page 33: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/33.jpg)
Beyond XML's business case, DITA may...
Reduce content modeling effortMake content truly portableSupport content reuseTake advantage of software supportProvide output optionsReduce overall cost of implementation
![Page 34: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/34.jpg)
Reduce content modeling effort
Assume that DITA structure is a reasonable matchSpeed up the transition to structureBut what if DITA doesn't match?Does your industryhave specialrequirements?
![Page 35: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/35.jpg)
Make content truly portable
Do you need to send content to a customer, partner, vendor, other department?Will they standardize on DITA?
![Page 36: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/36.jpg)
Support content reuse
Map files for topic reuseconrefs for smaller reuse
![Page 37: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/37.jpg)
Software support
DITA support found in many (most?) XML authoring toolsSome tools support only DITA and not general XML
![Page 38: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/38.jpg)
Provide output options
XHTML, HTML Help, PDF, Eclipse, DocBook, JavaHelp, troff, Word RTF through DITA Open ToolkitStarting point for outputNot suitable for production workflowCustomization is difficult and time-consuming
![Page 39: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/39.jpg)
Is DITA right for you?
![Page 40: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/40.jpg)
Yes.
DITA meets all requirements.A business partner or customer requires DITA content.Single sourcing is a requirement.No existing content.Can be flexible with markup requirements to make implementation faster.
![Page 41: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/41.jpg)
No.
Content must conform to a specific standard, such as S1000DContent is and should remain narrative.Semantic requirements are industry-specific, complex, and/or strict.
![Page 42: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/42.jpg)
Maybe
DITA is not an exact match.Customization/specialization would be required.
![Page 44: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/44.jpg)
Questions
![Page 45: DITA 101 -- Why the Buzz](https://reader031.vdocuments.site/reader031/viewer/2022032216/55a699fd1a28ab86668b4616/html5/thumbnails/45.jpg)
Thanks!
Thank you to Madcap Software for organizing.Thank you to participants for attending.