mathew dita deep dive

31
To DITA or not to DITA? Mathew Varghese Content Architect, Citrix

Upload: akashjd

Post on 19-Jan-2015

457 views

Category:

Documents


0 download

DESCRIPTION

 

TRANSCRIPT

Page 1: Mathew DITA Deep Dive

To DITA or not to DITA?

Mathew VargheseContent Architect, Citrix

Page 2: Mathew DITA Deep Dive

Agenda

• Creating DITA topics• Generating output using DITA Open Toolkit• Profiling using ditaval• Altering style sheets

Page 3: Mathew DITA Deep Dive

Misinformation!

•Long, boring, and highly theoretical

•Demos will not work!• Lots of Q&A to keep you awake :D

Page 4: Mathew DITA Deep Dive

CREATING DITA TOPICS

Page 5: Mathew DITA Deep Dive

http://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture

Page 6: Mathew DITA Deep Dive
Page 7: Mathew DITA Deep Dive

Adopting DITA Entails

• Understanding topic-based writing

• Understanding minimalism• Greater emphasis on information architecture

In short, good writing practices.

Page 8: Mathew DITA Deep Dive

Adopting DITA Does Not Entail

• Learning XML• Coding and/or working on a CLI

In short, no drastic change.

Page 9: Mathew DITA Deep Dive

DITA makes you a better writer

AND

Provides alternate career opportunities

Page 10: Mathew DITA Deep Dive

DITA Building Blocks

TopicsConceptTaskReference

MapsDitamapBookmap

Page 11: Mathew DITA Deep Dive

DITA Building Blocks

C

C

RT

TT T

Page 12: Mathew DITA Deep Dive

Creating DITA Topics

AnalyzeAnalyzeAnalyze again!

Extend the DITA Information Model

Content Strategy - Later

Get the right specs

Understand Semantic Tagging

FrameMaker vs. DITA

Page 13: Mathew DITA Deep Dive

Get the Right Specs

• Language Specification• http://docs.oasis-open.org/dita/v1.1/langspec

/ditaref-type.html

• Architecture Specification• http://docs.oasis-open.org/dita/v1.1/archspec

/archspec.html

Page 14: Mathew DITA Deep Dive

Extend the DITA Information Model

RT

C

Page 15: Mathew DITA Deep Dive

Extend the DITA Information Model

CC

C

Page 16: Mathew DITA Deep Dive

Analyze, analyze, and analyze again!

Audience Analysis

Task Analysis

DITA Topics

Every DITA topic should map to a unique objective.

Page 17: Mathew DITA Deep Dive

Content Strategy - Later

The Paradigm

Shift

Page 18: Mathew DITA Deep Dive

Semantic Tagging

Build your

tagging scheme

Page 19: Mathew DITA Deep Dive

FrameMaker and DITA

FrameMaker DITA

Book Map

Chapter Topic

Conditional text Ditaval

SaveAs PDF, XML,….. DITA OT

Please, don’t hit me!

FrameMaker is a tool and DITA is an information architecture. FrameMaker supports DITA.

Page 20: Mathew DITA Deep Dive

GENERATING OUTPUT

Page 21: Mathew DITA Deep Dive

Install DITA OThttp://sourceforge.net/projects/dita-ot/

Page 22: Mathew DITA Deep Dive

Quick, Dirty, out-of-the-box!

ant -f samples\ant_sample\sample_pdf.xml

Using ANT

Page 23: Mathew DITA Deep Dive

Using the JAVA Command Line

java -jar lib/dost.jar /i:samples/sequence.ditamap /outdir:out /transtype:xhtml

Page 24: Mathew DITA Deep Dive

Using the DITA OT GUI

http://sourceforge.net/projects/ditaotgui/

Page 25: Mathew DITA Deep Dive

Using Your Editing Tool

Page 26: Mathew DITA Deep Dive

PROFILING USING DITAVAL

Page 27: Mathew DITA Deep Dive

Tips

•Profile sparingly•Always plan for negative conditions

•Publish profiling rules

Page 28: Mathew DITA Deep Dive

Pillar Test

audience

context

Page 29: Mathew DITA Deep Dive

TRANSFORMS

Page 30: Mathew DITA Deep Dive

Simple Tricks

• Modifying the CSS for HTML-based outputs

• XSL mods for PDFOpen demo/fo/cfg/fo/attrs/front-matter-attr.xslGo to __frontmatter__title attribute set

Page 31: Mathew DITA Deep Dive

QUESTIONS