Contextual Menu Actions in Author Mode

Oxygen XML Author Eclipse plugin includes powerful support for editing XML documents through actions included in the contextual menu. When editing XML documents in Author mode, the contextual menu includes general actions that are available for all of the recognized document types and framework-specific actions that are configured for each document type.

General Contextual Menu Actions in Author Mode

The general actions that are available in the contextual menu (some of them are also available in the submenus of the Document menu) for all built-in document types include the following:

Quick Fix (Alt + 1 (Command + Option + 1 on macOS))

This action is available when the contextual menu is invoked on a validation error where Oxygen XML Author Eclipse plugin can provide a Quick Fix. It displays a list of quick fix suggestions that are detected for the particular validation issue. Any detected quick fixes for the currently highlighted validation issue are also available by right-clicking the status bar at the bottom of the editor.

Apply all default quick fix proposals

This action is available when the contextual menu is invoked on a document that has one or more quick fix proposals detected for reported validation errors. It can be used to apply quick fix proposals for all reported validation errors in the document. If multiple quick fixes are available for the same validation error, the default quick fix defined in the Schematron validation schema using the sqf:default-fix attribute is automatically selected to be applied. If no default quick fix is explicitly specified, the first quick fix proposal in the list is considered. All quick fix proposals are then automatically executed in bulk, one after the other.

Important Notes to Consider:

To maintain the accuracy of the initially calculated error validation ranges, the quick fix proposals are applied in the reverse order of their selection.
If two or more quick fixes act on the same "area" within the document, only one is applied (no changes can be made to changes already made).
Quick fixes that involve "user-entered values" that normally present a dialog box to facilitate data entry will not be executed (the automatic process of applying all selected quick fixes cannot be interrupted by the presence of the respective dialog boxes).

Once the analysis of the impact of applying the quick fixes on the content is complete, a preview dialog box is presented that provides an overview of the content changes that will be made, according to the quick fixes that will be applied. If you agree with the changes presented, click Apply to trigger the quick fixes and update the content.

Tip: This action is also available in the contextual menu when right-clicking the status bar at the bottom of the editor (if the currently highlighted validation issue has at least one detected quick fix suggestion available). Specific quick fix suggestions that are defined for the particular validation issue are also available in this menu.

Open Image

Available when the contextual menu is invoked on an image. This action allows you to open an image in a default system application associated with the current image type.

Show in Explorer (Show in Finder on macOS)

Available when the contextual menu is invoked on an image. This action allows you to open the parent directory of an image in the system file explorer, and it selects the image file.

Save image as

Available when the contextual menu is invoked on a local, external, or embedded image. This action opens a dialog box where you can choose a location in the local file system where the image will be saved. It also includes an option (Update the reference to the image) that can be toggled to choose whether or not to update the path in existing references to the image.

Track Changes Actions

Available when the Track Changes feature is enabled and the contextual menu is invoked on a change. The following options are available:

Accept Change(s): Accepts the Tracked Change located at the cursor position or all of the changes in a selection. If you select a part of a deletion or insertion change, only the selected content is accepted. If you select multiple changes, all of them are accepted. For an insertion change, it keeps the inserted text and for a deletion change, it removes the content from the document.
Reject Change(s): Rejects the Tracked Change located at the cursor position or all of the changes in a selection. If you select a part of a deletion or insertion change, only the selected content is rejected. If you select multiple changes, all of them are rejected. For an insertion change, it removes the inserted text and for a deletion change, it preserves the original content.
Comment Change: Opens a dialog box that allows you to add a comment to an existing Tracked Change. The comment will appear in a callout and a tooltip when hovering over the change. If the action is selected on an existing commented change, the dialog box will allow you to edit the comment.

Author Callout Actions

Available when the contextual menu is invoked on a callout. If the corresponding options in the Show review callouts section are selected in the Callouts preferences page, the callouts are displayed in Author mode for comments, tracked insertions, or tracked deletions.

Insertion or Deletion Callout Actions

The following actions are available in the contextual menu when invoked on an insertion or deletion callout box:

Reply: Opens a dialog box that allows you to add a reply to a comment or Tracked Changes. When replying to a comment, the dialog box shows the entire conversation in the comment thread, starting with the first comment added in the particular thread, followed by all the replies. After replies are added to a comment thread, they are displayed with an indentation in the callouts and Review view.
Mark as Done: A toggle action that marks or unmarks a comment or comment thread as being done. It is also available for Tracked Changes that are displayed in a callout. When a comment or change is marked as done, the callout is grayed out and cannot be edited unless the action is toggled to the unmarked state. The action applies to the particular comment and all of its descendents. This is useful for marking comments or changes that have been addressed, leaving only those that still need some attention.
Accept Change(s): Accepts the Tracked Change located at the cursor position or all of the changes in a selection. If you select a part of a deletion or insertion change, only the selected content is accepted. If you select multiple changes, all of them are accepted. For an insertion change, it keeps the inserted text and for a deletion change, it removes the content from the document.
Reject Change(s): Rejects the Tracked Change located at the cursor position or all of the changes in a selection. If you select a part of a deletion or insertion change, only the selected content is rejected. If you select multiple changes, all of them are rejected. For an insertion change, it removes the inserted text and for a deletion change, it preserves the original content.
Comment Change: Opens a dialog box that allows you to add a comment to an existing Tracked Change. The comment will appear in a callout and a tooltip when hovering over the change. If the action is selected on an existing commented change, the dialog box will allow you to edit the comment.
Edit Reference: If the fragment that contains a callout is a reference, use this option to go to the reference and edit the callout.
Callouts Options: Select this option to open the Callouts preference page where you can configure various callout options.

Comment Callout Actions

The following actions are available in the contextual menu when invoked on a comment callout box:

Reply: Opens a dialog box that allows you to add a reply to a comment or Tracked Changes. When replying to a comment, the dialog box shows the entire conversation in the comment thread, starting with the first comment added in the particular thread, followed by all the replies. After replies are added to a comment thread, they are displayed with an indentation in the callouts and Review view.
Mark as Done: A toggle action that marks or unmarks a comment or comment thread as being done. It is also available for Tracked Changes that are displayed in a callout. When a comment or change is marked as done, the callout is grayed out and cannot be edited unless the action is toggled to the unmarked state. The action applies to the particular comment and all of its descendents. This is useful for marking comments or changes that have been addressed, leaving only those that still need some attention.
Show/Edit Comment: Opens a dialog box that displays the discussion thread and allows the current user to edit comments that do not have replies. If you are not the author who inserted the original comment, the dialog box just displays the comment without the possibility of editing it.
Remove Comment: Removes a selected comment. If you remove a comment that contains replies, all of the replies will also be removed.
Callouts Options: Select this option to open the Callouts preference page where you can configure various callout options.

Edit Attributes

Displays an in-place attributes editor that allows you to manage the attributes of an element.

Edit Profiling Attributes

Allows you to change the profiling attributes defined on all selected elements.

Insert submenu

This submenu includes insert actions that are specific to each framework, along with the following general action:

Insert Entity

Allows you to insert a predefined entity or character entity. Surrogate character entities (range #x10000 to #x10FFFF) are also accepted. Character entities can be entered in one of the following forms:

#<decimal value> - e. g. #65
&#<decimal value>; - e. g. &#65
#x<hexadecimal value> - e. g. #x41
&#x<hexadecimal value>; - e. g. &#x41

Cut (Ctrl + X (Command + X on macOS))

Removes the currently selected content from the document and places it in the clipboard.

Copy (Ctrl + C (Command + C on macOS))

Places a copy of the currently selected content in the clipboard.

The clipboard contains the precise node structure that is preserved when pasting to another place within the same document or to another document opened in the Author mode. The copied content also contains a plain Text flavor that attempts to convert the copied content to Markdown when the content gets pasted into a plain text area and also an HTML flavor that attempts to convert the copied structure to plain HTML, which can be useful for preserving the styles when pasting into editors such as MS Word.

Paste (Ctrl + V (Command + V on macOS))

Inserts the current clipboard content into the document at the cursor position.

Paste special submenu

This submenu includes special paste actions that are specific to each framework, as well as the following general paste actions:

Paste As XML: Pastes clipboard content that is considered to be XML, preserving its XML structure.
Paste As Text (Ctrl + Shift + V (Command + Shift + V on macOS)): Pastes clipboard content, ignoring any structure or styling markup.

Select submenu

This submenu allows you to select the following:

Element: Selects the entire element at the current cursor position.
Content: Selects the entire content of the element at the current cursor position, excluding the start and end tag. Performing this action repeatedly will result in the selection of the content of the ancestor of the currently selected element content.
Parent: Selects the entire parent element at the current cursor position.

Text submenu

This submenu contains the following actions:

To Lower Case

Converts the selected content to lower case characters.

To Upper Case

Converts the selected content to upper case characters.

Capitalize Sentences

Converts to upper case the first character of every selected sentence.

Capitalize Words

Converts to upper case the first character of every selected word. 0034

Count Words

Counts the number of words and characters (no spaces) in the entire document or in the selection for regular content and read-only content.

Note: The content marked as deleted with change tracking is ignored when counting words.

Convert Hexadecimal Sequence to Character (Ctrl + Shift + H (Command + Shift + H on macOS))

Converts a sequence of hexadecimal characters to the corresponding Unicode character. The action can be invoked if there is a selection containing a valid hexadecimal sequence or if the cursor is placed at the right side of a valid hexadecimal sequence. A valid hexadecimal sequence can be composed of 2 to 4 hexadecimal characters and may or may not be preceded by the 0x or 0X prefix. Examples of valid sequences and the characters they will be converted to:

0x0045 will be converted to E
0X0125 to ĥ
265 to ɥ
2190 to ←
Note: For more information about finding the hexadecimal value of a character, see Finding the Decimal, Hexadecimal, or Character Entity Equivalent.

Refactoring submenu

Contains a series of actions designed to alter the XML structure of the document:

Toggle Comment

Encloses the currently selected text in a comment, or removes the comment if it is commented.

Move Up (Alt + UpArrow (Option + UpArrow on macOS))

Moves the current node or selected nodes in front of the previous node.

Move Down (Alt + DownArrow (Option + DownArrow on macOS))

Moves the current node or selected nodes after the subsequent node.

Split Element

Splits the content of the closest element that contains the position of the cursor. Thus, if the cursor is positioned at the beginning or at the end of the element, the newly created sibling will be empty.

Join Elements

Joins two adjacent block elements that have the same name. The action is available only when the cursor position is between the two adjacent block elements. Also, joining two block elements can be done by pressing the Delete or Backspace keys and the cursor is positioned between the boundaries of these two elements.

Surround with Tags (Alt + Shift + E)

Allows you to choose a tag to enclose a selected portion of content. If there is no selection, the start and end tags are inserted at the cursor position.

If the Position cursor between tags option is selected in the Content Completion preferences page, the cursor is placed between the start and end tag.
If the Position cursor between tags option is not selected in the Content Completion preferences page, the cursor is placed at the end of the start tag, in an insert-attribute position.

Surround with '[tag]' (Alt + Shift + ForwardSlash)

Surround the selected content with the last tag used.

Rename Element

The element from the cursor position, and any elements with the same name, can be renamed according with the options from the Rename dialog box.

Delete Element Tags

Deletes the tags of the closest element that contains the position of the cursor. This operation is also executed if the start or end tags of an element are deleted by pressing the Delete or Backspace keys.

Remove All Markup

Removes all the XML markup inside the selected block of content and keeps only the text content.

Remove Text

Removes the text content of the selected block of content and keeps the markup intact with empty elements.

DITA-related Refactoring Actions

A variety of built-in XML refactoring operations that pertain to DITA documents with some of the information preconfigured based upon the current context.

Change Topic ID to File Name: Use this operation to change the ID of a topic to be the same as its file name.
Convert CALS Tables to Simple Tables: Use this operation to convert DITA CALS tables to simple tables. If you invoke this operation from a nested table (a table inside a table), only the nested table will be affected. If it is invoked on a parent table that contains nested tables, all of the contained tables will be converted.
Convert conrefs to conkeyrefs: Use this operation to convert @conref attributes to @conkeyref attributes.
Convert Simple Tables to CALS Tables: Use this operation to convert DITA simple tables to CALS tables. If you invoke this operation from a nested table (a table inside a table), only the nested table will be affected. If it is invoked on a parent table that contains nested tables, all of the contained tables will be converted.
Convert to Concept: Use this operation to convert a DITA topic (of any type) to a DITA Concept topic type (for example, Topic to Concept).
Convert to General Task: Use this operation to convert a DITA topic (of any type) to a DITA General Task topic type (for example, Task to General Task). A DITA General Task is a less restrictive alternative to the Strict Task information type.
Convert to Reference: Use this operation to convert a DITA topic (of any type) to a DITA Reference topic type (for example, Topic to Reference).
Convert to Task: Use this operation to convert a DITA topic (of any type) to a DITA Task topic type (for example, Topic to Task).
Convert to Topic: Use this operation to convert a DITA topic (of any type) to a DITA Topic (for example, Task to Topic).
Convert to Troubleshooting: Use this operation to convert a DITA topic (of any type) to a DITA Troubleshooting topic type (for example, Topic to Troubleshooting).
Rename Key: Available when invoked on a key, and can be used to quickly rename a key. It also updates all references to it. Note that it does not work on DITA 1.3 key scopes.
Generate IDs: Use this operation to automatically generate unique IDs for elements.

Attributes Refactoring Actions

Contains built-in XML refactoring operations that pertain to attributes with some of the information preconfigured based upon the current context.

Add/Change attribute: Allows you to change the value of an attribute or insert a new one.
Convert attribute to element: Allows you to change an attribute into an element.
Delete attribute: Allows you to remove one or more attributes.
Rename attribute: Allows you to rename an attribute.
Replace in attribute value: Allows you to search for a text fragment inside an attribute value and change the fragment to a new value.

Comments Refactoring Actions

Contains built-in XML refactoring operations that pertain to comments with some of the information preconfigured based upon the current context.

Delete comments: Allows you to delete comments found inside one or more elements.

Elements Refactoring Actions

Contains built-in XML refactoring operations that pertain to elements with some of the information preconfigured based upon the current context.

Delete element: Allows you to delete elements.
Delete element content: Allows you to delete the content of elements.
Insert element: Allows you to insert new elements.
Rename element: Allows you to rename elements.
Unwrap element: Allows you to remove the surrounding tags of elements, while keeping the content unchanged.
Wrap element: Allows you to surround elements with element tags.
Wrap element content: Allows you to surround the content of elements with element tags.

Fragments Refactoring Actions

Contains built-in XML refactoring operations that pertain to XML fragments with some of the information preconfigured based upon the current context.

Insert XML fragment: Allows you to insert an XML fragment.
Replace element content with XML fragment: Allows you to replace the content of elements with an XML fragment.
Replace element with XML fragment: Allows you to replace elements with an XML fragment.

JATSKit Refactoring Actions

Available for JATS documents. Contains built-in XML refactoring operations that pertain to JATS documents with some of the information preconfigured based upon the current context.

Add BITS DOCTYPE - NLM/NCBI Book Interchange 2.0: Adds an NLM 'BITS' 2.0 DOCTYPE declaration.
Add Blue DOCTYPE - NISO JATS Publishing 1.1: Adds a JATS 'Blue' 1.1 DOCTYPE declaration.
Normalize IDs: Assigned IDs are normalized and IDs are assigned to some elements that are missing them.

Processing Instructions Refactoring Actions

Contains built-in XML refactoring operations that pertain to processing instructions.

Accept all tracked changes, remove all Oxygen-specific comments and highlights: Use this operation to accept all application-specific tracked changes (from elements and attributes) or remove all application-specific comments or highlights.
Delete processing instructions: Deletes the detected processing instructions.

Review submenu

This submenu includes the following actions:

Track Changes: Enables or disables the Track Changes support for the current document.
Accept Change(s) and Move to Next: Accepts the Tracked Change located at the cursor position or all of the changes in a selection and then moves to the next change. If you select a part of a deletion or insertion change, only the selected content is accepted.
Accept All Changes: Accepts all Tracked Changes in the current document.
Reject Change(s) and Move to Next: Rejects the Tracked Change located at the cursor position or all of the changes in a selection and then moves to the next change. If you select a part of a deletion or insertion change, only the selected content is rejected.
Reject All Changes: Rejects all Tracked Changes in the current document.
Comment Change: Opens a dialog box that allows you to add a comment to an existing Tracked Change. The comment will appear in a callout and a tooltip when hovering over the change. If the action is selected on an existing commented change, the dialog box will allow you to edit the comment.
Highlight: Enables the highlighting tool that allows you to mark text in your document.
Colors: Allows you to select the color for highlighting text.
Stop highlighting: Use this action to deactivate the highlighting tool.
Remove highlight(s): Use this action to remove highlighting from the document.
Add Comment: Inserts a comment at the cursor position. The comment appears in a callout box and a tooltip (when hovering over the change).
Show/Edit Comment: Opens a dialog box that displays the discussion thread and allows the current user to edit comments that do not have replies. If you are not the author who inserted the original comment, the dialog box just displays the comment without the possibility of editing it.
Remove Comment: Removes a selected comment. If you remove a comment that contains replies, all of the replies will also be removed.
Manage Reviews: Opens the Review view.

Manage IDs submenu

This submenu is available for XML documents that have an associated DTD, XML Schema, or Relax NG schema. It includes the following actions:

Rename in: Renames the ID and all its occurrences. Selecting this action opens the Rename XML ID dialog box. This dialog box lets you insert the new ID value and choose the scope of the rename operation.
Search References: Searches for the references of the ID. By default, the scope of this action is the current project. If you configure a scope using the Select the scope for the Search and Refactor operations dialog box, this scope will be used instead.
Search References in: Searches for the references of the ID. Selecting this action opens the Select the scope for the Search and Refactor operations.
Search Occurrences in file: Searches for the occurrences of the ID in the current document.

Folding submenu

This submenu includes the following actions:

Toggle Fold: Toggles the state of the current fold.
Collapse Other Folds: Folds all the elements except the current element.
Collapse Child Folds: Folds the elements indented with one level inside the current element.
Expand Child Folds (Ctrl + NumPad+ (Command + NumPad+ on macOS)): Unfolds all child elements of the currently selected element.
Expand All: Unfolds all elements in the current document.

Inspect Styles

Opens the CSS Inspector view that allows you to examine the CSS rules that match the currently selected element.

Options

Opens the Author mode preferences page.

Document Type-Specific Contextual Menu Actions in Author Mode

Other document type-specific actions are available in the contextual menu of Author mode for the following document types (click the links to see the default actions that are available for each specific document type):