Top Banner
IBM User Technologies © 2005, 2010 IBM Corporation http://w3.ibm.com/ibm/presentations Getting started with DITA: Information modeling with DITA maps Ian Larner User Technologies, IBM Hursley Lab, England [email protected]
16

IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

Dec 19, 2015

Download

Documents

Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM User Technologies

© 2005, 2010 IBM Corporation

Getting started with DITA: Information modeling with DITA maps

Ian LarnerUser Technologies, IBM Hursley Lab, [email protected]

Page 2: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation2

IAWB Roles and Goals modelling

Page 3: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation3

IAWB: Task-based UA model (DITA)

Page 4: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation4

Open maps

Outline

Tasks

File | New DITA map

Reference

Concepts

Metadataproperties

Node assistantRelationship

table editorTopic file status

manager

Relationship table

browser

Properties table

Topic type

picker

Visualization

Page 5: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation5

Modeling with maps [<5] In IAWB, create a project

[<5] Create a map

[10] Add a simple topic reference

– Nest topic references (inherent hierarchical relationships/linking)

[10] Work with properties and metadata

[10] Work with topic files (generate stub files)

[10] Work with relationship tables (extra related linking)

Summary (+get the complete sample if you want!)

Page 6: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation6

Have a go…

Page 7: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM User Technologies

© 2005, 2010 IBM Corporation

Recap / summary

Page 8: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation8

DITA modelling (Maps and topic sets) Model(define) user tasks and need for supporting topics … in DITA

maps

Include model aspects of users, artifacts, ... as metadata (and topics?)

User goals and task topics,

Hierarchy, continuum (sequence, prereq task)

Supporting topics (concept, reference)

Topic hierarchy = hierarchy of references to topics

Metadata for user characteristics, artifacts, ...

Extra relationships between topics

Semantics and vocabulary

Stub templates for topics

... Topics and maps for information development & delivery

Page 9: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation9

Welcome

Example scenario

SelectBlend

Selectadditives

Summary& Serve

2

1

3

4

Tea Maker / Coffee Maker

T C

Tg

T

To

R

CSH CSH CSH CSH

“I want to get a custom blend of coffee”

“I need to install the Tea Maker”

“I want to get a tea, English Breakfast, milk, & 2 sugars”

Page 10: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation10

Task model (roles and goals) for Beverage Maker

Page 11: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation11

DITA map common to all products

Page 12: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation12

Adapted info for Tea Maker and Coffee Maker

Page 13: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation13

Adapting information when presented to the user

Page 14: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation14

Making the information adaptable Defined adaptability In a DITA map

– Information type (task, concept, ...) ... and its specialization/generalization

– Topic metadata attributes - @audience, @platform, @product, @othermeta, @your_props

– Topic metadata elements - audience, category, keywords, (Eclipse help criteria), ...

– Topic set metadata - topic/@collection-type, map/topicmetadata

– Relationships - Relationship tables, topicgroups, ... In a DITA topic

– Information type (task, concept, ...) ... and its specialization/generalization

– Topic metadata attributes - @audience, @platform, @product, @othermeta, @your_props

– Topic metadata elements - audience, category, keywords, (Eclipse help criteria), ...

– Topic structure (prereq, context, steps, result)

– Semantic elements

– Element metadata attributes - @audience, @platform, @product, @othermeta, @your_props

– Relationships - xrefs, related-links, conrefs, keyrefs...

Page 15: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation15

Where to get more

DITA articles:http://xml.coverpages.org/dita.html

http://dita.xml.org/

OASIS DITA Technical Committee:http://www.oasis-open.org/committees/dita

DITA Open Toolkit:http://dita-ot.sourceforge.net

Task Modeler (IAWB)http://www.alphaworks.ibm.com/tech/taskmodeler

Page 16: IBM User Technologies © 2005, 2010 IBM Corporation Presentation subtitle: 20pt Arial Regular, teal R045 | G182 | B179 Recommended maximum length: 2 lines.

IBM Information Development

Getting started with DITA: Information modeling with DITA maps © 2005, 2010 IBM Corporation16

Where to get more

"Design Patterns for Information Architecture with DITA Map Domains. Defining a Type for Collections of Topics." By Erik Hennum (Advisory Software Engineer, IBM), Don Day (Lead DITA Architect, IBM), John Hunt (User Assistance Architect, IBM), and Dave A. Schell (Chief Strategist and Tools Lead, IBM).

http://www-106.ibm.com/developerworks/xml/library/x-dita7/

"Using DITA for Information Architecture." By Michael Priestley (IBM User Technologies). Presented at WritersUA 2005 Conference

http://xml.coverpages.org/DITA-PriestleyWinUA2005.ppt

“IBM Task Modeler basics” reuse of a presentation by John Hunt, on the Web site of the Silicon Valley DITA Interest Group

http://svdig.ditamap.com/