easyDITA Getting Started Guide

First Steps

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

Note: Currently, easyDITA is compatible with Chrome and Firefox. You can access your easyDITA account by navigating in either browser to the URL provided to you.
  1. Sign in to easyDITA with the credentials provided to you. If you don't have an account, ask your account manager to set one up for you.  

    Once logged in, the first screen you'll see is the Dashboard interface. We're going to skip the Dashboard in this tutorial.
  2. Click Author or Content Library to access your content library.
  3. In the Browse tab, click the My_Content folder.

  4. Click the New folder icon to create a new folder and use your name as the new folder's name

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. In your personal testing folder , click Create New and select Concept.

  2. In Title field, enter Introduction.

    The File name field will automatically populate based on what you enter in the Title field.

  3. Click Create & Edit to open the new topic in the topic editor.

    The Introduction topic opens in the topic editor.

    Tip: You can also click Create to generate the topic and have it show in file listing but not immediately open in the topic editor. You can double-click on a file in the lis t ing to open it in the topic editor.
  4. Place your cursor in any element placeholder (for example, the short description element) and insert some text.

  5. Insert new elements by clicking on the + icon.
    Note: The elements that show in the Insert Menu are context sensitive and only elements that are valid in your cursor location show.
  6. Do each of the following actions using the text editing toolbar:

    1. Insert a list
    2. Insert an image
    3. Insert a table
    4. Add a comment
    Tip: You can use keyboard shortcuts to quickly perform an action. Click the keyboard icon to see a list of available actions.
  7. When you're done editing the topic, click the X to exit the topic editor.
    easyDITA automatically saves your editing changes.
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. In the content library, click Create New and select Task.

  2. In the Title field, enter First Procedure

  3. Click Create & Edit .

  4. Place your cursor in the command element in the first step element and begin adding an instructions to your procedure.
    Tip: You can press Enter add a new step and command element.
  5. Insert additional elements by clicking the + icon, or using the Outline tab.

    Click Outline to open the Outline tab. Then, insert a step example element by clicking on stepxmp +. The Outline tab shows elements that are already in your topic and provides quick add buttons to insert expected elements based on the topic type.

    A step example element is added to your topic.

  6. Click the Image icon to add an image to your step example element.

    The Select File window opens. If you don't have an image in your content library yet, you can click the Upload icon to add one.

  7. If your image is too large, resize the image by doing the following:
    1. Click the image.
    2. Click Attributes to open the Attributes tab.
    3. In the Width field, enter 400.

Now that you've created a concept topic and a task topic, let's organize your content for publishing by Create a Map .

Create a Map

Learn to create a map to organize your topics and prepare a set of content for publishing.

  1. In the content library, click Create New and select Map.

  2. In the Title field, enter a map name.

  3. Click Create & Edit to create the map and open it in the map editor pane.  

    Now that you've created a map, you're going to add the concept and task topics you created to the map.
  4. To add the Introduction topic to the map, drag and drop introduction.dita from the file listing to the map editor pane.

  5. You'll be prompted to choose how you want to insert the topic. Leave topicref selected and click Insert.
  6. Repeat steps 4 through 5 to add first_procedure.dita to the map.
    Tip: If you drop a topic on top 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.
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 publish it to PDF using the PDF Generator.

  1. Open the map in the resource manager by clicking the Open button next to the map.
    The map opens in the resource manager.

  2. Click Publish and then from the drop-down list, select one of the default PDF Generator templates.
  3. Click Publish to generate a PDF.
  4. Click the Download to save the PDF to your computer.
Congratulations! You've created several topics, added them to a map, and published your first PDF. You're now ready to create your own content in easyDITA.

Upload Files to the Content Library

You can upload images and other allowed file types to the content library.

  • If you want to upload a large number of files, compress these files to a ZIP archive.
    Tip: Uploading files compressed to a single ZIP archive is quicker than uploading multiple files without compressing them first.

    By default, when you upload a ZIP archive to the content library, easyDITA unzips the archive retaining its folder structure. If needed, you can also upload a ZIP archive to the content library without unzipping it.

  1. In the content library, navigate to the folder where you want to upload your files and click the Upload icon.
  2. Click Select files to upload and select the files.
  3. If you selected any files that already exist in the content library folder and you don't want to overwrite them, clear the corresponding Overwrite files with the same names check box.
  4. If you selected any ZIP files that you do not want to be automatically unzipped, clear the corresponding Unzip check box.
  5. Click Upload Files.