Edit online

How to Perform Common Editing Tasks

This section describes how to perform some of the most common editing operations in Oxygen XML Web Author. For a more complete list of the editing actions available in Oxygen XML Web Author, see Toolbar, Contextual Menu, and Shortcut Actions.

Editing on Mobile Devices

When you initially open a document on a mobile device, the document is in a read-only review mode. To switch to edit mode, tap the Edit widget (or double-tap anywhere in the editing pane).

Input Text

  1. Tap or click to move the cursor into the selected document area.
  2. Type the text using the keyboard or screen.

Split a Paragraph

  1. Tap or click to move the cursor at the split position.
  2. Tap or press Enter to open the Content Completion Assistant.
  3. Choose Split p from the list of proposals.

Enter a New XML Element

  1. Tap or click to move the cursor into the document area where you want to enter the new element.
  2. Tap or press Enter to open the Content Completion Assistant.
  3. Select the element name.

Surround a Selection with an XML Element

  1. Tap or click to move the cursor into the selected document area and make a text selection.
  2. Tap or press Enter to open the Content Completion Assistant.
  3. Select the element name that you want the selection to be surrounded with.

Set an Attribute Value

  1. Expand the Attributes pane from the area on the right side of the screen. If the side panes are not displayed, click the arrow button () at the bottom of the side-pane stripe.

    Figure 1. Attributes Pane
  2. If the attribute is present in the attributes table (it already has a value), you can change its value by tapping or clicking its value. On a desktop system, you can also use Tab or Shift+Tab to cycle through the available attributes and the Enter key to select and modify attribute values.
  3. If the attribute is not present, use the Add Attribute button and tap or click the attribute to set its value. On a desktop system, you can also press Alt + Enter when the cursor is in the document and the focus will change to the Attributes tab with the Add Attribute form control automatically opened.

Remove an Attribute

  1. Expand the Attributes pane from the are on the right side of the screen. If the side panes are not displayed, click the arrow button () at the bottom of the side-pane stripe.
  2. Find the attribute in the table and tap or click its value.
  3. Use the Delete button (or use the Delete key) to remove the attribute.

Rename an Element or Delete a Required Element

If an element is required at its specific location within the XML structure and it is not the only child of the parent element, you cannot delete it using normal keyboard shortcuts (such as Delete or Backspace). Typically, you would not want to remove a required element, so this feature is in place to help prevent accidental deletes. If you do need to delete (or rename) such an element:
  1. Select and right-click the element in the Breadcrumb (or right-click the element in the editor).
  2. To replace the element with another, select the Rename Element action and select the new element.
  3. To delete the element, select the Delete Element (or Delete Element Tags) action.

Save a Modified XML Document

To save your changes, tap or click the Save button from the upper toolbar. Note that the save operation depends on the integration of Oxygen XML Web Author with a CMS or other storage mechanism.

Open Image

To open an image in a new browser tab, right-click the image and select Open Image. The new browser tab will contain a preview of the image and from there, you can perform the usual contextual menu actions that are available on images for the particular browser.

Insert an Image

  1. Tap or click the Insert Image action on the toolbar.
  2. Select the image from the file browsing dialog box that appears. If the image does not already exist in the file structure of your repository, you can use the Upload File action at the top-right corner of the dialog box to upload it to the repository before selecting it.
    Tip: You can also drag an image file from another document, web page, or application (such as a system file browser) and drop it into your document (in some browsers, you can also use copy/paste actions). Oxygen XML Web Author will insert it as a reference to the image file.

Inserting and Editing MathML Equations

  1. To insert a MathML equation, right-click at the location where you want to insert it and select Insert Equation from the Insert submenu.
  2. To edit the equation, tap or click the equation to open an editing dialog box.
  3. Edit the XML source of the equation.
  4. Tap or click OK to finish the editing process.

Editing SVG Graphics

Oxygen XML Web Author renders SVG graphics if they are present in the document. However, the only way to edit them is to switch to the text-based mode (select Edit as XML from the More drop-down menu).

Promote/Demote List Item Nodes

On a desktop device, you can easily promote or demote selected list item nodes within ordered lists or unordered lists by using the following keyboard shortcuts:
Promote (Shift + Tab)
Promotes an entirely selected list item node to be a sibling of its parent node (the list item is moved to the left). It also works for selections of multiple list item nodes as long as all the selected nodes are siblings (on the same hierarchical level).
Demote (Tab)
Demotes an entirely selected list item node (the list item is moved to the right). It also works for selections of multiple list item nodes as long as all the selected nodes are siblings (on the same hierarchical level).

Display XML Tags

Oxygen XML Web Author includes a Tags Display Mode option that you can use to display the XML tags directly in the document. The Tags Display Mode drop-down is located at the far-left side of the Breadcrumb bar (before the first element). You can choose from the following tag modes: Full Tags with Attributes, Full Tags, Block Tags, Inline Tags, Partial Tags, or No Tags.
Note: This option is also available in Preferences from the More drop-down menu.

Drag/Drop or Copy/Paste Tags, URLs, Images, and Static Text

If the Tags Display Mode option is set to Full Tags with Attributes, Full Tags, Block Tags, or Inline Tags, you can click on a tag, copy (Ctrl + C) it, and paste (Ctrl + V) it within the current document or another document. You can also use the mouse to drag XML tags and drop them within the current document.

If you copy/paste or drag/drop a valid URL string, Oxygen XML Web Author will automatically insert it as a linking element for the particular document type you are working with. For example, in DITA it would insert an <xref> element.

You can drag an image file from another document, web page, or application (such as a system file browser) and drop it into your document (in some browsers, you can also use copy/paste actions). Oxygen XML Web Author will insert it as a reference to the image file.

You can also select a block of text from another document or web page and drag/drop it in the current document (or copy/paste) and Oxygen XML Web Author will insert it as plain text or in some cases, HTML code.

Change Root DITA Map (For DITA Documents)

To change the root DITA map that is associated with the current document, follow these steps:
  1. With the document opened in Oxygen XML Web Author, select the Set the Root Map button on the DITA toolbar.
  2. Choose the URL of the DITA map that you want to be associated with the current document.
  3. To see which root map is currently associated with a document, expand the Validation side pane. The root map is listed at the top of the side pane.