workshop tasks

򔻐򗗠򙳰 Workshop

ii

Workshop

Contents Workshop . . . . . . . . . . . . . . 1 Introduction . . . . . . . . Getting started for DITA Modeling . Starting IAWB . . . . . . . Open DITA Modeling perspective Creating a project. . . . . . Creating a DITA map . . . . . Creating the DITA map 'Basics' . Creating a topic hierarchy in a map. Creating the root topic . . . . Adding subtasks . . . . . . Add more subtopics . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

1 1 1 2 2 3 3 4 4 6 6

Changing topic properties and metadata . . . Setting the collection type . . . . . . . Editing metadata . . . . . . . . . . Working with topic files . . . . . . . . Opening the DITA Topic File Manager . . . Reviewing topic file status . . . . . . Generating stub files . . . . . . . . Working with relationship tables . . . . . Creating a simple Relationship Table . . . Visualize relationships on the map diagram Summary . . . . . . . . . . . . .

. . . . . . . . . . .

. 7 . 7 . 8 . 9 . 9 . 10 . 10 . 11 . 12 . 13 . 13

iii

iv

Workshop

Workshop Introduction Use this tutorial to find out how to use IBM Information Architecture Workbench to create and manipulate DITA maps. The tutorial covers creating a map, working with topic files, and editing relationship tables. The content assumes that you are familiar with the DITA design process and IBM Information Architecture Workbench basics (such as covered in the Task Modeling tutorial of the IBM Information Architecture Workbench). You will create a simple DITA map of the basic operations performed on a text file, based on the following scenario: Peter Novak is authoring help documentation for a photo editing application. He is currently writing an exercise that introduces users to three basic file operations: (a) opening a file, (b) saving the file with a different extension in another folder, and (c) closing the file.

Getting started for DITA Modeling In the IBM Information Architecture Workbench, you start by opening the DITA Modeling perspective and creating a new project to collect your work. For DITA authoring, IBM Information Architecture Workbench defines a DITA Modeling perspective. This perspective structures the Eclipse environment to provide convenient access to useful DITA-specific tools such as the DITA topic file manager and the relationship table editor. In IBM Information Architecture Workbench, models and maps are held in Eclipse projects rather than in the main file system. You can either create a map or open an existing map stored in a project. You can also import a map from the file system into a project. Start IBM Information Architecture Workbench, ensure that the DITA modeling perspective is displayed, and create a new Eclipse project named Exercise. You will use this project to hold your new map and its associated topic files. Time required: 5 mins.

Starting IAWB IBM Information Architecture Workbench lets users create DITA maps graphically. When you start IBM Information Architecture Workbench, any previously opened models are opened so that you can edit them further. v Double-click the IBM Information Architecture Workbench icon on the desktop

1

v Select All Programs → IBM Information Architecture Workbench 7 → IBM Information Architecture Workbench 7

Open DITA Modeling perspective For DITA authoring, IBM Information Architecture Workbench defines a DITA Modeling perspective. This perspective structures the Eclipse environment to provide convenient access to useful DITA-specific tools such as the DITA topic file manager and the relationship table editor. When the DITA Modeling perspective is open, the top-right of the IBM Information Architecture Workbench desktop shows the DITA Modeling label on a white background:

The DITA Modeling perspective should be open by default when you start the IBM Information Architecture Workbench. If the perspective is not open, you can open it by one of several alternative methods. v Use the Open Perspective controls Using the controls in the top-right of the IAWB desktop, complete the following steps: 1. Click the Open Perspective icon 2. Click Other... 3. Click DITA Modeling v Use the Window menu item Click Window → Open Perspective → Other... → DITA Modeling The window layout is updated to include the DITA specific tools.

Creating a project In IBM Information Architecture Workbench, models and maps are held in Eclipse projects rather than in the main file system. You can either create a map or open an existing map stored in a project. You can also import a map from the file system into a project. Create a new Eclipse project named Exercise. 1. Click the New icon 2. Expand General then click Project 3. Click Next 4. In the Project name: field, type Exercise

2

Workshop

5. Click Finish

Creating a DITA map In IBM Information Architecture Workbench, models and maps are held in Eclipse projects rather than in the main file system. You can either create a map or open an existing map stored in a project. You can also import a map from the file system into a project. In the project Exercise, create a new DITA map with the file name Basics. The map is used to organize a set of DITA topics and specify properties and metadata for adaptable or dynamic processing of those topics. Time required: