Table of Contents
User Guide
Using the Topic Editor
Structured Authoring Environment
The Topic Editor is a structured authoring environment that enables you to edit topics.
Moving an Element Inside a Topic
Move elements in a topic to reorder them.
Copying an Element in a Topic
Copy and paste an element in a topic to a new location in the topic or to a new topic.  
Removing an Element in a Topic
Quickly remove all the content in an element by removing the element itself.
Inserting an Image
Add media to a topic and set its properties.
Inserting a Menu Cascade
Insert a menu cascade to document a sequence of menu choices.
Inserting a Link to a File
You can create an inline link to a topic or map in the Content Library by using a cross-reference (XRef) link. Cross-references are direct links that lead you to supplementary information.
Inserting a Link to a Website or PDF
Cross-references (XRef) are inline links that lead you to supplementary information. Create a cross-reference link to an external source like a website or PDF.
Inserting Character Symbols
Add special characters from the Symbol Menu to your topic.
Using Spell Check
Use the Topic Editor to run a spell check on the content in a topic.
Structured Authoring Environment

The Topic Editor is a structured authoring environment that enables you to edit topics.
The Topic Editor manages the structure of your DITA content as you work, ensuring that it remains valid at all times by preventing you from creating invalid content. The editor shows the currently selected DITA element in gray text to the left of the document.
When inserting an element, easyDITA will position it in the proper location in the DITA structure. Also, the drop down list for Inserting elements will only show elements that can be inserted at the current cursor location.

Likewise, when you remove elements, easyDITA will ask which element you want to remove. In the example below, you can remove the List Item, the Unordered List, or the Body of the DITA document. The flying arrow points to the element you are removing, and it is highlighted in red to confirm this is the element you want to remove.
You can inspect where you are in the DITA XML structure by hovering over the structure status bar at the bottom of the screen. In this example, the List Item is highlighted and the flying arrow connects the text to the structure status bar element.
You can edit DITA properties by clicking Properties in the right margin. This expands the Properties Pane. When you place the cursor in a property field to set an attribute, the arrow connects the attribute to the element in the document pane. In the example below, the Properties Pane displays properties for the selected paragraph.
Moving an Element Inside a Topic

Move elements in a topic to reorder them.
  1. In the Content Manager, open a topic and right-click the element you want to move.
  2. Select Move Up or Move Down .

    Expected Result
    Elements that are available to be moved display in the context menu.
  3. Select the element you want to move.
result
The element is moved to a new location in the topic.
Copying an Element in a Topic

Copy and paste an element in a topic to a new location in the topic or to a new topic.  
  1. In the Content Manager, open a topic and right-click anywhere in the element that you want to copy.

    Expected Result
    The context menu displays.

  2. Click Copy and select the element you want to copy to your clipboard.

    Step Information
    Note:Hover over an element in the context menu to highlight its location in the topic.
  3. In the same topic or in a new topic, right-click an element and select Paste .
result

You pasted your copied element to a new location.

Removing an Element in a Topic

Quickly remove all the content in an element by removing the element itself.
  1. In the Content Manager, open a topic and place your cursor in the element you want to remove.
  2. Click the Remove Menu.

    Expected Result
    The elements that can be removed are listed.
    Note:Hover over an element in the context menu to highlight its location in the topic.
  3. Select the element you want to remove.
result

You remove the element from the topic.

Inserting an Image

Add media to a topic and set its properties.
  1. In the Content Manager, open a topic and place your cursor where you want to insert the image.
  2. Click the Image icon in the toolbar.

    Step Information

    Expected Result
    A blank image element is inserted.

  3. Select the image element and click Change .

    Expected Result
    The Select Image window displays.

  4. Do one of the following:

    • To insert an existing image, navigate to the thumbnail, and then click Select .
    • To upload and insert a new image, click the Upload and then click Select files to upload to locate the file on your computer. Click Upload . Select the thumbnail and click Select .

  5. (Optional) Select the image and use the Media toolbar to align the image within your document

    Step Information

  6. (Optional) Select the image and click Properties to set the image attributes. 

    Example
    If your image is too large, you can set the width to a smaller size. Enter 420px in the Width field.

    Expected Result
    The Properties Pane displays.

result

A reference to the image is inserted into your topic. 

Inserting a Menu Cascade

Insert a menu cascade to document a sequence of menu choices.
  1. In the Content Manager, open a topic and place your cursor where you want to insert a Menu Cascade element.
  2. Click Insert -> Menu Cascade .

    Expected Result
    The UI Control element is inserted.
  3. With your cursor in the UI Control , click Insert -> UI Control .

    Expected Result
    An arrow and UI Control element are inserted.
result

You inserted a Menu Cascade element that contains two UI Control elements. Use UI Control to separate menu items.

Inserting a Link to a File

You can create an inline link to a topic or map in the Content Library by using a cross-reference (XRef) link. Cross-references are direct links that lead you to supplementary information.
Tip:We recommend using key references (keyrefs) instead of using cross-references to create a link to a topic. For more information, see Key References. If you’re trying to link to an external source, see Inserting a Link to a Website or PDF.

  1. In the Content Manager, open a topic and place your cursor where you want to insert a link.

    Step Information
    Note:By default, when you insert a XRef link, the topic’s title is used as the link text. This is rendered by easyDITA, so you don’t need to enter any text for the link.

  2. Click Link -> Xref .

    Expected Result
    An empty link element is inserted. The text is underlined and blue.
  3. Click Edit.

    Expected Result
    The Select Link window displays.
  4. Navigate to and select the file, and then click Select .

    Expected Result
    The link is inserted and the “XRef Link” placeholder is replaced with the topic’s title.
result

You inserted a direct link to another topic.

Note:You can change the link text by placing your cursor in the Xref link and entering new text. We do not recommend doing this because it makes link management difficult and tedious (E.g. the topic name changes). Custom link texts need to be maintained and modified each time the content changes and the link text is no longer relevant. This same change also has to be made every where the link is used.
Inserting a Link to a Website or PDF

Cross-references (XRef) are inline links that lead you to supplementary information. Create a cross-reference link to an external source like a website or PDF.
  1. In the Content Manager, open a topic and place your cursor where you want to insert a link.
  2. Click Link -> Xref .

    Expected Result
    An empty link element is inserted. The text is underlined and blue.
  3. Click Properties .

    Expected Result
    The Properties Pane displays. The properties for the XRef link display at the top.

  4. In the Source (href) field, enter the URL for the external source.

    Step Information
    The URL must contain http://. For example, http://www.google.com

    Source (href) field

  5. In the Scope drop-down menu, select external.
  6. In the Format field, enter the format of file expected at the link. For example, html or pdf.
  7. In the XRef Link element, enter text for the link.

    Example

result

You inserted a link to an external source.

Inserting Character Symbols

Add special characters from the Symbol Menu to your topic.
  1. In the Content Manager, open a topic and place your cursor where you want to insert a symbol.
  2. Click the Symbol Menu and select the symbol you want.

    Step Information

result

The selected symbol is inserted into the topic.

Using Spell Check

Use the Topic Editor to run a spell check on the content in a topic.
  1. In the Content Manager, open a topic and click the Spell Check icon.

    Step Information

result

Words that do not match the installed dictionary are indicated with a red underline. Dictionaries for any language can be installed.