Table of Contents
Tutorials
Getting Started with easyDITA
Getting Started with easyDITA

Overview

Learn the basics of using easyDITA to author, manage, and publish content. 
The Getting Started with easyDITA will walk you through creating your first concept and task topic. You’ll also learn how to create, manage, and publish a map. Let’s get started!

First steps

Before writing content in easyDITA, you’ll need to log in to your account. Then you’ll create your own testing area for the content you’ll create in this tutorial.

Note:Currently, easyDITA is only compatible with Firefox. Chrome compatibility will be available in the future.
  1. Log in to easyDITA with the credentials provided to you. If you don’t have an account, ask your account administrator to set one up for you.  

    Step Information

  2. Once logged in, the first screen you’ll see is the Dashboard interface. We’re going to skip the Dashboard in this tutorial and click Author to go to the Authoring interface.

    Step Information

  3. Click the Documentation root folder and then click the Testing folder.

    Step Information

    Note:If there is no testing folder, create one using the same procedure in step 4.

  4. Before creating any topics, you need to create your own testing area for this tutorial. Click the Folder icon to create a new folder. This will be your personal testing space, so use your name as the folder name.

    Step Information

Great! Now that you’ve created a personal testing folder, you’re ready to Create a concept topic !

Create a concept topic

In your personal testing folder, you’ll create your first concept topic.
  1. Click Create New and then select Default Concept.

    Step Information

  2. Enter “Introduction” for the Title. The File name will be automatically created based on the Title.

    Step Information

  3. Click Create.

    Expected Result
    Your new concept topic displays in the file listing.

  4. With your first concept topic created, click Edit to open the topic for editing.

    Step Information

    Tip:You can also double-click a file or hover over a file and click the Pencil icon open it.
    Expected Result
    A new tab opens displaying the Introduction concept topic in the Topic Editor.

  5. Type content into the topic.

    Example

  6. You can access all sorts of functions using the Topic Editor toolbar. Click on these areas to do the following:

    Step Information
    123456

    1. Add a list
    2. Add an image
    3. Add a table
    4. Insert an element from a list
    5. Remove an element
    6. Add a review comment
    Step Information
    Tip:You can use the Quick Action Menu to quickly perform an action. Press Meta+Shift to access the menu, and then press the appropriate letter for the action you want to perform.

    • Mac users: press and hold Cmd+Shift

    • Window users: press and hold Ctrl+Shift

    For example, as a Mac user I would press Cmd+Shift+I to insert an element.

  7. When you’re done editing the topic, click Save and then Close.
Congratulations! You created your first concept topic and added some content to it. Now, let’s Create a task topic.

Create a task topic

The process for creating a task topic is similar to creating a concept topic, so let’s get to it.
  1. Click Create New and then select Default Task.

    Step Information
  2. Enter “First Procedure” for the Title.

    Step Information
  3. Click Create & Edit to create your topic and open it in the Topic Editor.

    Expected Result
    A new tab opens displaying the First Procedure task topic in the Topic Editor.
    123
    The body of a Default Task topic has 3 major parts:
    1. Context
    2. Steps
    3. Result
    Note:Not all organizations will use a Context and Result, consult your Information Architect for your organization’s best practice.
  4. Enter some content in the Steps.
  5. You can add visuals to your steps to assist the reader. First, you need to insert an Information element to hold the image. Place your cursor in a step and then click +info.

    Step Information
    Expected Result
    An Information element is inserted below the step.
  6. Click the Image icon. You can either navigate to and select an existing image or upload a new image.

    Step Information
    Expected Result
  7. At this point, if your image is too large you may want to resize it. Do the following:

    Step Information
    12
    1. Click the image.
    2. Click Properties.
    3. In the Width field, enter 420px.
    Step Information
    3
  8. When you’re done editing the topic, click Save and then Close.
Now that you created a concept and task topic, let’s Create a map to organize your content for publish.

Create a map

You created your first DITA topics. Now, you’ll create a map to organize your topics into.
  1. First, you need to create the file. Click Create New and then select Default Map.

    Step Information
  2. Enter a map name for the Title.

    Step Information
  3. Click Create & Edit to create and open the map for editing.  

    Expected Result
    The Map Editor displays with your map in the Map Editor Pane.
  4. Now that you’ve created a map, you’re going to add the concept and task topics you created to it. To add the Introduction topic to the map, click and drag introduction.dita from the file listing to the Map Editor Pane.

    Step Information
    Expected Result
  5. Repeat step 4 to add first_procedure.dita to the map.

    Step Information
    Tip:If you drop a topic ontop of another topic in the Map Editor Pane, it will add the topic as a child. This is how you can build hierarchy in a map.
  6. Now that you’re done editing the map, click Save.
You created your first map and added some topics to it. Now, you can Publish a map.

Publish a map

Now that you have a simple map built, it’s time to test out publishing to PDF using the DITA Open Toolkit.
  1. Let’s start by opening the Publishing interface. Click Publish. This is where you’ll select a publishing engine.

    Step Information
    Expected Result
  2. You’re going to use the DITA Open Toolkit to publish to PDF, so click DITA Open Toolkit.

    Step Information
    The Publish Through DITA Open Toolkit screen displays. Here you’ll see past publishes of the map. But because this is a new map, there aren’t any past publishes.
  3. Click New Publish to open the New Publishing Job Interface and select the output format for your first publish.
  4. Complete in the following fields:

    Step Information
    1. Click Basic 1.5.3.
    2. Enter a description. This will display once the publish is complete.
    3. In the Transtype drop-down menu, select PDF.
  5. Click Publish to start the publishing job. 

    Step Information
  6. Once the publishing job completes, click the description and then click Download.

    Step Information
    The PDF in the downloaded ZIP folder will be very plain if your organization hasn’t done any work on output styling.
Congratulations! You’ve created several topics, added them to a map, and publishing your first PDF. You’re now ready to create your own content in easyDITA.