How to Use easyDITA

1. What is DITA?
Darwin Information Typing Architecture (DITA) is an open-source standard that defines how
information is categorized and provides a framework for content structure. Structure involves breaking
content down into small units called Topics that can be modified and repurposed in many different
ways.

1.1 What is Content Reuse?

Content Reuse is the practice of using existing Topics in different contexts. This means that when
something changes, you can edit the relevant Topic(s) to update the entire project. This allows you to
place individual Topics into DITA Maps and publish them however you see fit. You can further customize
output formats (e.g. PDF, HTML) by creating Styles during the Publication process.

1.2 What is a Concept, Task, and Reference?

There are three main Topic Types in DITA: Concept, Task, and Reference. A Concept is used to explain,
describe, or provide context for information. A Reference is used to provide data and examples that are
associated with a Task or Concept. A Task is used to document a procedure.

1.3 What is a Map?

A Map organizes topics for the creation of different outputs and archives. There are two basic forms of
Map: DITA Maps and Bookmaps. DITA Maps can link to Topics and other DITA Maps, provide holders
for metadata, and create relationship tables that link outside the content of individual Topics.

Bookmaps are specialized DITA Maps that provide specific tools for creating book-centric markup.
These tools include frontmatter and backmatter; fronts, chapters, and appendices; and book metadata.

2. Overview of easyDITA
easyDITA is a single-source repository for DITA-based content. The system runs in a native XML
(Extensible Markup Language) database that is hosted on either your personal servers or in the cloud.
You can create individual Repositories for each project and organize them in files and folders like you
would on a MAC or PC. As a Component Content Management System (CCMS), easyDITA helps you
manage content by searching for and modifying files without breaking links. It also facilitates version
control, check in/check out, and importing/exporting content. This tutorial will guide you through the
process of using easyDITA: logging in, creating and organizing Topics, and building and publishing final
Deliverables.

3. Logging in
easyDITA is a software as a service that is accessed through the Firefox Web Browser. You have opened
Firefox and want to log in to easyDITA.

1. Input your easyDITA URL (usually yourorgname.easydita.com) and hit Enter.

2. Input your Username (usually your email address) and Password and Sign In.

You are now logged into the easyDITA Start Dashboard.

Note: If you have forgotten your Password, select “Can’t access your account?”. Type in your Email
Address and you will receive instructions to reset your Password.

4. Create a new folder

easyDITA uses a directory of files and folders like those you would find on your own computer. You are
in the Content Library and want to create a New Folder.

1. Select the Click New drop-down menu.

2. Select Folder and enter a name in the Folder Name field.

You have created a New Folder in easyDITA.

5. Create a new Concept

There are three main Topic Types in DITA: Concept, Task, and Reference. A Concept is used to explain,
describe, or provide context for information. You are in the Content Library and you want to create a
new Concept.

1. From the Create New menu, select Concept.

2. Input a file name and select Create.
3. If you would like to edit your new concept immediately, select Create and Open New
Document.

5.1 Show code view

You can switch between standard text and XML view by selecting the </>
Icon in the upper righthand corner of the Concept Editor, as seen in
figure 1.

5.2 Create a new Title

There are two ways to create a new Title for an existing Concept. Figure 1 The code view icon.

From the Content Library:

1. Right-click the file name and select Rename.

2. Type the new name in the File Name Field.

From within the Concept:

1. If there is a preexisting Title, delete it.

2. Type in your new Title.
You have created a New Title for your Concept.

5.3 Create a Short Description

By default, a Concept is made up of a Title, Short Description, and Body. You have opened a file in the
Editor and would like to write a Short Description.

1. Click in the different Sections to make their names appear on the left.
2. Click just below the Title to edit the content of a Short Description.

You have created a Short Description for your Concept.

5.4 Create a Paragraph

You have opened a file in the Editor and would like to write a new Paragraph.

1. Click in the different Sections to make their names appear on the left.

2. Click in the Body to edit the file’s content.

3. Hit Enter to create a new Paragraph.

You have created a new Paragraph for your Concept.

5.5 Create a Figure with a Caption and an Image

You are editing a Concept and would like to create a Figure with an Image and a Caption.

1. Move your cursor to where you would like to create an Image.

2. Select the Insert Image Icon in the toolbar (fig 2). The Select File
window will appear (fig 3).
3. Navigate to the folder where your Images are stored and select the Figure 2: The Insert Image Icon
desired Image.
4. If your Image is not in the
easyDITA repository, select
Upload in the Select File
window to open the Upload
dialog. Select Files to Upload Figure 3: The Select File window
to locate the desired file on
your desktop. After you have uploaded the Image, you can select and place it in the document.
5. Select the Image to display the Image Control Bar beneath it.
6. Select Annotate Image to open the Edit Source window.
7. Select the Text Tool, then click and drag in the desired location to add a Text Box.
8. Type in the desired Caption. Note that it cannot contain any numbers or spaces.
9. Select the Image, then select Properties in the right margin slider panel to display the Image or
change its attributes.

You have added a Figure to your document with a Caption and an Image.

5.6 Create a Definition List (with Term and Definition)

You have opened a Concept in the Editor and would like to create a Definition List.

1. Click in the Body to edit the file’s content.

2. Click the + Icon to open the Create Menu.
3. Enter Definition List
in the Choose Bar or
scroll down until
you find Definition
List in the menu.
4. Select Definition
List.
5. If you wish to add Figure 4: A Definition List
another Definition
Term to the list, select + Definition Entry or hit Enter.

You have added a Definition List (fig. 4) to your document and can now edit its content.

5.7 Create an Unordered List with two First-Level Bullets and two Second-
Level Bullets

You have opened a Concept in the Editor and would like to create an Unordered List with two First-
Level Bullets and two Second-Level Bullets. You can create an Unordered List using either the Create
Menu or Editor Toolbar.

Create Menu

1. Click in the Body to edit the file’s content.

2. Click the + Icon to open the Create Menu.
3. Enter Unordered List in the Choose Bar or scroll down
until you find Unordered List in the menu (fig. 5).
4. Select Unordered List to create a new First-Level Bullet.
5. Click next to the First-Level Bullet to create content.
6. Hit the Tab key to create a Second-Level Bullet.
7. After adding content to the Second-Level Bullet, hit Shift
+ Tab to create a new First-Level Bullet.
8. Add content to this Bullet Point, then hit the Tab key to
create a Second-Level Bullet.
Figure 5: Selecting Unordered List from the
Toolbar drop-down menu

1. Select the Unordered List Icon to create a new First-Level

Bullet (fig. 6).
2. Click next to the First-Level Bullet to create content.
3. Hit the Tab key to create a Second-Level Bullet.
4. After adding content to the Second-Level Bullet, hit Shift +
Tab to create a new First-Level Bullet. Figure 6: The Unordered List Icon
5. Add content to this Bullet Point, then hit the Tab key to
create a Second-Level Bullet.
You have created an Unordered List with two First-Level
Bullets and two Second-Level Bullets (fig 7).

5.8 Create a Simple Table with three rows

and three columns

You have opened a Concept in the Editor and would like

to create a Simple Table with three rows and three
columns.

1. Select the Simple Table Icon to open the Create Figure 7: An Unordered List
Table dialog box.
2. By default, Create Table is set to 3 rows and 3 columns. Create a Title and Header if you wish,
then save the Table.

You have created a Simple Table with three rows and three columns (fig. 8)

Figure 8: A Simple Table

5.9 Save the Concept

easyDITA will automatically save your concept as you create or modify content. You can also go to code
view (see step 4.1) and save your work there.

6. Create a new Reference

There are three main topic types in DITA: Concept, Task, and Reference. A Reference is used to provide
data and examples that are associated with a task or concept. You are in the Content Library and you
want to create a new Reference.

1. From the Create New menu, select Reference.

2. Input a file name and select Create.
3. If you would like to edit your new Reference immediately, select Create and Open New
Document.

You have created a new Reference.

6.1 Show code view

You can switch between standard text and XML view by selecting the </> Icon in the upper righthand
corner of the concept editor.
6.2 Create a new Title

There are two ways to create a new Title for an existing Reference.

From the Content Library:

1. Right-click the file name and select Rename.

2. Input the new name in the File Name Field.

From within the Reference:

1. Delete the preexisting Title if necessary.

2. Type in your new Title.

You have created a new Title for your Reference.

6.3 Create a Short Description

By default, a Reference is made up of a Title and Short Description. You have opened a Reference in the
Editor and would like to write a Short Description.

1. Click in the different Sections to make their names appear on the left.
2. Click just below the Title to edit the content of a Short Description.

You have created a Short Description for your Reference.

6.4 Create a Section

You are editing a Reference and would like to create a new Section.

1. Click in the different Sections to make their names appear on the left.
2. Select the + Icon on the left or hit the Return key to open the Create Menu.
3. Select the type of section you wish to create or type it into the Choose Bar.

You have added a new section to your Reference.

6.5 Create a new Section title

You are editing a Reference and would like to create a new Section Title.

1. Click in the different Sections to make their names appear on the left.
2. Select the + Icon on the left or hit the return key to open the Create Menu.
3. Type Section into the Choose Bar or scroll down until you reach Section.
4. Select Section.
5. Click Title to create new content.

You have created a new Section Title for your Section.

6.6 Create a Properties Table (in easyDITA menu called Properties

Reference), with a Prop Type, Prop Value, and Prop Description
You are editing a Reference and would like to Create a Properties Table with a Prop Type, Prop Value,
and Prop Description.

1. Select the + Icon on the left.

2. Type Properties into the Choose Bar or scroll down until you reach Properties.
3. Select Properties.

You have created a Properties Table with a Prop Value and Prop Description (fig. 9). Next you will
create a Prop Type.

Figure 9: A Properties Table with a Prop Value and Prop Description

1. Select the + Icon.

2. Input Property Type into the choose bar or scroll down until you reach Property Type.
3. Select Property Type.

Your Properties Table now has a Prop Type, Prop Value, and Prop Description (fig. 10).

Figure 10: A Properties Table with a newly added Prop Description.

6.7 Save the Reference

easyDITA will automatically save your Reference as you create or modify content. You can also go to
code view (see step 4.1) and save your work there.

7. Create a new Task

There are three main Topic Types in DITA: Concept, Task, and Reference. A Task is used to document a
procedure. You are in the Content Library and you want to create a new Task.

1. From the Create New menu, select Task.

2. Input a file name and select Create.
 3. If you would like to edit your new Task immediately, select Create and Open New Document.

You have created a new Task.

7.1 Show code view

You can switch between standard text and XML view by selecting the </> Icon in the upper righthand
corner of the Task Editor.

7.2 Create a new Title

There are two ways to create a new Title for an existing Task.

From the Content Library:

1. Right-click the file name and select Rename.

2. Input the new name in the File Name Field.

From within the Task:

1. Delete the preexisting Title if necessary.

2. Type in your new Title.

You have created a new Title for your Task topic.

7.3 Create a Short Description

By default, a Task is made up of a Title, Short Description, Context, Command, and Result. You have
opened a Task in the Editor and would like to write a Short Description.

1. Click in the different Sections to make their names appear on the left.
2. Click just below the Title to edit the content of a Short Description.

You have created a Short Description for your Task topic.

7.4 Create a Context

You are editing a Task and would like to create a Context.

1. Click in the different Sections to make their names appear on the left.
2. Select the + Icon.
3. Input Context into the Choose Bar or scroll down until you reach
Context.
4. Select Context.

You have added a Context (fig. 11) to your Task.

Figure 11: Context
7.5 Create two Steps, each with a Command

You are editing a Task and would like to create two Steps, each with a Command.

1. Click in any Section to make the + Icon appear.

2. Select the + Icon.
 3. Type Step into the Choose Bar or scroll down until you reach Step.
4. Select Step.
5. Hit Return to create another Step.

You have added two Steps, each with a Command, to your Task (fig. 12).

Figure 12: A Context section with two Steps and two Commands

7.6 After the second Command, create an Info Element and a Note.

You have just created two Steps, each with a Command. You would like to add an Info Element and a
Note after the second Command.

1. Click the second Command to make the + Icon appear.

2. Select the + Icon.
3. Type Info into the Choose Bar or scroll
down until you reach Info.
4. Select Info.
5. Select the + Icon again.
6. Type Note into the choose bar or scroll
down until you reach Note.
7. Select Note.

You have added an Info Element (fig. 13) and

Figure 13: A Command with an Info Element. Figure 14: A Command with a Note.
a Note (fig. 14) to a Command.

7.7 Create a Choice Table after the Info Element with 2 Choice Rows

You have just added an Info element and a Note to a Command. You would like to create a Choice Table
with two Choice Rows.

1. Click the Info Element to make the + icon appear.

2. Select the + Icon.
3. Type Choice Table into the Choose Bar or scroll down until you reach Choice Table.
 4. Select Choice Table.
5. To create a new Choice Row, right-click on the Choice Table.
6. Select either Create Before or Create After to bring up the Input Dialogue.
7. Type Choice Table Row into the Choose Bar or scroll down until you reach Choice Table Row.

You have added a Choice Table with two Choice Rows (fig. 15) to your Task.

Figure 15: A Choice Table with two Choice Rows.

7.8 Create a Result

1. Click on any Section to make the + Icon appear.

2. Select the + Icon.
3. Type Result into the Choose Bar or scroll down until you reach Result.
4. Select Result.

You have added a Result to your Task.

7.9 Save the Task

easyDITA will automatically save your Task as you create or modify content. You can also go to code
view (see step 4.1) and save your work there.

8. Delete a Topic
You are in the Content Library and wish to delete a Topic.

1. Right-click anywhere on the Topic you wish to delete.

2. Select Move to Trash to bring up the Move to Trash dialog.
3. Select Move to Trash in the bottom right hand corner.

You have deleted a Topic from the Content Library.

9. Create a DITA Map

You are in the Content Library and wish to create a DITA Map.

1. Select Create New.

2. Select Map.
3. Enter a Title if you wish, then click Create.

You have created a DITA Map.

9.1 Link a Concept, Reference, and Task to the Map

You have just created a DITA Map and you want to link a Concept, Reference, and Task.

1. Place your cursor anywhere on the DITA Map.

2. Select Dock. The DITA Map
directory will appear on the
left.
3. Click and drag your Concept
over to the DITA Map
directory. An Insert dialog
will appear (fig. 16).
4. Click Create.
5. Repeat steps 3 and 4 for your Figure 16: Linking an item to a DITA Map.
Reference and Task.

You have linked a Concept, Reference, and Task to your DITA Map (fig.
17).

9.2 Save the map

easyDITA will automatically save your Map as you create or modify

elements.

10. Publish Figure 17: A DITA Map with linked

Concept, Reference, and Task.
easyDITA allows you to publish files in multiple outputs. The instructions
below will teach you how to create and download both PDF and HTML outputs.

10.1 Publish HTML

You are in the Content Library and would like to publish an output in HTML format.

1. Locate the DITA map you wish to publish in the Content Library.
2. Click the map to access it in the Resource Viewer.
3. Click the Publishing tab to access the Output Manager. You will see a listed publication history if
the map has previously been published.
4. Under Publish Engine, select DITA Open Toolkit (DITA OT).
5. Open the Map in the Map Editor.
6. Select the Publish tab to open the Publication Manager.
7. Select a Publishing Scenario. The default Publishing Scenarios are Basic 1.5.2 and Basic 1.5.3.
1.5.2 and 1.5.3 refer to specific versions of the DITA OT.
8. Set the Transformation Type (Transtype) to XHTML.
9. Enter a Description if you like.
10. Click Publish. The Publication Manager screen will display the status of the current Publication
Job at the top of the Publication History.
11. When the Publication is complete, click on the item to open up the Publishing Record. The
Publishing Record will show any errors messages generated by the DITA OT.

You have Published an output in HTML format.

10.2 Publish PDF

You are in the Content Library and would like to publish an output in PDF format.

1. Locate the DITA Map you wish to publish in the Content Library.
2. Click the Map to access it in the Resource Viewer.
3. Click the Publishing tab to access the Output Manager. You will see a listed Publication History
if the Map has previously been Published.
4. Under Publish Engine, select DITA Open Toolkit (DITA OT).
5. Open the Map in the Map Editor.
6. Select the Publish tab to open the Publication Manager.
7. Select a Publishing Scenario. The default Publishing Scenarios are Basic 1.5.2 and Basic 1.5.3.
1.5.2 and 1.5.3 refer to specific versions of the DITA OT.
8. Set the Transformation Type (Transtype) to PDF.
9. Enter a description if you like.
10. Click Publish. The Publication Manager screen will display the status of the current Publication
Job at the top of the Publication History.
11. When the Publication is complete, click on the item to open up the Publishing Record. The
Publishing Record will show any errors messages generated by the DITA OT.

You have Published an output in PDF format.

10.3 Download HTML or PDF

1. Locate the DITA Map you wish to Download in the Content Library.
2. Click Output to access the Output Manager.
3. Place your cursor on the output you wish to Download.
4. Select the Download Icon.

Alternate method

1. From the Output Manager, click the Output you wish to download. A dialog box will appear.
2. Select Download.

You have downloaded an output in either HTML or PDF format.

11. How to Download a ZIP of a Map and all its

Dependencies
You are in the Content Library and would like to Download a ZIP File of a Map and all its Dependencies.

1. Right-click the desired Map.

2. Click Download + Dependencies.
3. Check Save File.
4. Click Ok.

You have Downloaded a ZIP File of a Map and all its Dependencies.