Web Author Interface

Detailed description of the interface.

The interface of the Oxygen XML Web Author groups the available actions in the following functional areas:
Upper Toolbar
The upper toolbar includes the following:
  • Icon - Clicking the Oxygen XML Web Author icon at the top-left corner of the screen will open the Dashboard page.
  • Undo - Reverses previous editing actions.
  • Redo - Recreates previous editing actions that were undone.
  • Save - Saves changes in the current file. This action is replaced by Download if you do not have write access to the repository.
  • Search - Opens the Search side panel that allows you to search the current file and replace the search terms.
  • Show Validation Results - Displays a detailed list of validation errors.
  • Repository actions - If you have a Git or SharePoint repository configuration, the toolbar will include actions for committing or checking in/out files.
  • More drop-down menu - Includes the following additional actions:
    • Save as - Opens a dialog box that allows you to choose where to save the current file.
    • Download - Downloads the current file in your current web browser.
    • Print - Opens a print preview pane that allows you to configure printing options for the current document.
      Note: Review information (such as tracked changes and comments) is also included in the printed output.
    • Edit as XML - Opens the current document in a text editing mode where you can see and edit the XML source code.
    • Preferences - Opens a dialog box that allows you to configure the following options:
      • Tags Display Mode - Includes dedicated tag modes that allow you to control the amount of markup that is displayed. You can choose from the following tag modes: Full Tags with Attributes, Full Tags, Block Tags, Inline Tags, Partial Tags, or No Tags.
      • Enable automatic spell chekcing - Allows you to enable or disable the automatic spell checking feature.
      Note: Changes to these preferences apply to the current document, as well as the future ones that are opened in the current browser, but they do not affect other documents that are already opened.
    • Help - Opens a WebHelp version of the Oxygen XML Web Author user manual.
    • Report Problem - You can use this option to open a dialog box that allows you to write the description of a problem that was encountered while using the application. You can also select additional information to be sent to the technical support team in the various tabs.
  • File Name - Displays the name of the current file.
    Note: Some documents might be locked for editing. This means that you cannot alter their content or add comments to them. A document lock state is indicated by a padlock icon next to the file name.
  • User Name - Displays the current user name. This name comes from the account that is created for your particular type of file repository (such as Dropbox, Google Drive, SharePoint, GitHub, or WebDAV).
  • Toggle Side Panel - Toggles the display of the side panel that allows access to Review, Attributes, and Search views.
Some additional toolbar buttons will be present for certain types of repository connections (for example, SharePoint includes some additional check in/out actions).
On mobile devices, the upper toolbar also allows you to switch between the Edit and Review modes ().
Lower Toolbar
The lower toolbar includes the following groups of actions:
  • Review Actions - Includes actions such as Track Changes, Add Comment, and more.
  • Framework-Specific Actions - Includes actions that are specific for each document type. For example, for DITA documents, the DITA toolbar presents actions that are specific to the DITA framework.
Right Side Panel
The side panel on the right side of the application includes tabs to switch between the Review, Attributes, and Search views. If it is not displayed, use the Toggle Side Panel action on the upper toolbar.

Figure: Desktop Version of the Oxygen XML Web Author