The specific actions for DITA topic documents are:
Bold - Surrounds the
selected text with a b tag.
Italic - Surrounds the
selected text with an i tag.
Underline - Surrounds
the selected text with a u tag. Note:
Bold, Italic, and
Underline are toggle actions.
For all of the above actions, if there is no selection in the document, then a new
specific tag is inserted. These actions are available in any document context.
- Browse reference manual - Opens in your
web browser of choice a reference to the documentation of the XML element closest to the
caret position.
- Cross Reference - Inserts an xref element
with the value of attribute format set to dita.
The target of the xref is selected in a dialog which lists all the
IDs available in a file selected by the user.
Insert a cross reference in a DITA document
- Key Reference - Inserts a user specified element with the
value of attribute keyref attribute set to a specific key name. As
stated in the DITA 1.2 specification keys can be defined at map level which can be
then referenced. The target of the keyref is selected in a dialog
which lists all the keys available in the current opened map from the DITA Maps
Manager.
You can also reference elements at sub-topic level by pressing the
Sub-topic button and choosing the target.
Important: All keys which are presented in the dialog are gathered from
the current opened DITA map. Elements which have the keyref
attribute set are displayed as links. The current opened DITA map is also used
to resolve references when navigating keyref links in the
Author mode. Image elements which use key references are rendered as
images.
- File Reference - Inserts an xref element
with the value of attribute format set to
xml.
- Web Link - Inserts an xref element with the
value of attribute format set to html, and
scope set to external.
- Related Link to Topic - Inserts a link
element inside a related-links parent.
- Related Link to File - Inserts a link
element with the format attribute set to xml
inside a related-links parent.
- Related Link to Web Page - Inserts a link
element with the attribute format set to html and
scope set to external inside a
related-links parent.
Note: The actions for inserting references
described above are grouped inside link toolbar actions
group.
- Paste as Link (available on the contextual menu of Author
editor for any topic file) - Inserts a link element or an
xref one (depending on the location of the paste) that points
to the DITA XML element from the clipboard. An entire DITA XML element with an ID
attribute must be present in the clipboard when the action is invoked. The
href attribute of link/href
will point to this ID value.
- Paste as Content Reference (available on the contextual menu
of Author editor for any topic file) - Inserts a content reference (a DITA element
with a conref attribute) to the DITA XML element from the
clipboard. An entire DITA XML element with an ID attribute must be present in the
clipboard when the action is invoked. The conref attribute will
point to this ID value.
Insert Section /
Step - Inserts a new section / step in the document, depending on
the current context. A new section will be inserted in either one of the following contexts:
- section context, when the value of class attribute of the
current element or one of its ancestors contains topic or
section.
- topic's body context, when the value of class attribute of
the current element contains topic/body.
A new step will be inserted in either one of the following contexts:
- task step context, when the value of class attribute of the
current element or one of its ancestors contains
task/step.
- task steps context, when the value of class attribute of
the current element contains task/steps.
Insert
Paragraph - Inserts a new paragraph depending on the current
context. If current context is a paragraph context (the value of
class attribute of the current element or one of its ancestors
contains topic/p) then a new paragraph will be inserted after this
paragraph. Otherwise a new paragraph is inserted at caret position.
Insert
Concept - Inserts a new concept. Concepts provide background
information that users must know before they can successfully work with a product or
interface. This action is available in one of the following contexts:
- concept context, one of the current element ancestors is a
concept. In this case an empty concept
will be inserted after the current concept.
- concept or DITA context, current element is a concept or
dita. In this case an empty concept
will be inserted at current caret position.
- DITA topic context, current element is a topic child of a
dita element. In this case an empty
concept will be inserted at current caret
position.
- DITA topic context, one of the current element ancestors is a DITA
topic. In this case an empty concept
will be inserted after the first topic ancestor.
Insert Task -
Inserts a new task. Tasks are the main building blocks for task-oriented user
assistance. They generally provide step-by-step instructions that will enable a user
to perform a task. This action is available in one of the following contexts:
- task context, one of the current element ancestors is a
task. In this case an empty task will
be inserted after the last child of the first concept's
ancestor.
- task context, the current element is a task. In this case
an empty task will be inserted at current caret
position.
- topic context, the current element is a dita
topic. An empty task will be inserted at
current caret position.
- topic context, one of the current element ancestors is a
dita
topic. An empty task will be inserted
after the last child of the first ancestor that is a
topic.
Insert Reference
- Inserts a new reference in the document. A reference is a top-level container for
a reference topic. This action is available in one of the following contexts:
- reference context - one of the current element ancestors is a
reference. In this case an empty
reference will be inserted after the last child of the
first ancestor that is a reference.
- reference or dita context - the current
element is either a dita or a reference.
An empty reference will be inserted at caret position.
- topic context - the current element is topic descendant of
dita element. An empty reference will
be inserted at caret position.
- topic context - the current element is descendant of dita
element and descendant of topic element. An empty
reference will be inserted after the last child of the
first ancestor that is a topic.
Insert Image
Reference - Inserts a graphic object at the caret position.
Depending on the current context, an image-type DITA element is inserted. The
following graphical formats are supported: GIF, JPG, JPEG, BMP, PNG, SVG. Also you
can use this action to refer MathML files.
-
Insert Content
Reference - Inserts a content reference at the caret
position.
The DITA conref attribute provides a mechanism for reuse of
content fragments. The conref attribute stores a reference to another element
and is processed to replace the referencing element with the referenced element.
The element containing the content reference acts as a placeholder for the
referenced element. The identifier for the referenced element must be either
absolute or resolvable in the context of the referencing element. See here for more details.
Oxygen XML Editor plugin
will display the referred
content of a DITA conref if it can resolve it to a
valid resource. If you have URI's instead of local paths in the XML documents
and your DITA OT transformation needs an XML catalog to map the URI's to local
paths you have add the catalog to
Oxygen XML Editor plugin
.
If the URI's can be resolved the referred content will be displayed in Author
mode and in the transformation output.
A content reference is inserted with the action Insert a DITA Content
Reference available on the toolbar Author custom
actions and on the menu .
Insert Content Reference Dialog
In the URL chooser you set the URL of the file from which you want to reuse
content. Depending on the Target type filter you will see
a tree of elements which can be referred (which have ID's). For each element the
XML content is shown in the preview area. The Conref
value is computed automatically for the selected tree element. After pressing
OK an element with the same name as the target
element and having the attribute conref with the value
specified in the Conref value field will be inserted at
caret position.
According to the DITA 1.2 specification the conrefend attribute
can be used to specify content reference ranges. This is a very useful feature
when referencing multiple consecutive steps or list items. If you use multiple
contiguous sibling selection the conrefend value will also be
set to the value of the last selected ID path.
Oxygen XML Editor plugin
will present
the entire referenced range as read-only content.
Insert Content Key
Reference - Inserts a content key reference at the caret
position.As stated in the DITA 1.2 specification the
conkeyref attribute provides a mechanism for reuse of
content fragments similar with the conref mechanism. Keys are
defined at map level which can be referenced using conkeyref.
The conkeyref attribute contains a key reference to another
element and is processed to replace the referencing element with the referenced
element. The element containing the content key reference acts as a placeholder
for the referenced element. The identifier for the referenced element must be
either absolute or resolvable in the context of the referencing
element.
Oxygen XML Editor plugin
will display the key referred
content of a DITA conkeyref if it can resolve it to
a valid resource in the context of the current opened DITA map.
A content
key reference is inserted with the action Insert a DITA Content Key
Reference available on the toolbar Author custom
actions and on the menu .
Insert Content Key Reference Dialog
To reference target elements at sub-topic level just press the
Sub-topic button and choose the
target.
According to the DITA 1.2 specification the
conrefend attribute can be used to specify content
reference ranges. This is a very useful feature when referencing multiple
consecutive steps or list items. If you use multiple contiguous sibling
selection for IDs at sub-topic level the
conrefend value will
also be set to the value of the last selected ID path.
Oxygen XML Editor plugin
will present
the entire referenced range as read-only content.
Important: All keys
which are presented in the dialog are gathered from the current opened DITA
map. Elements which have the conkeyref attribute set are
displayed by default with the target content expanded. The current opened
DITA map is also used to resolve references when navigating
conkeyref links in the Author mode.
- Replace conref / conkeyref reference with content - Replaces
the content reference fragment or the conkeyref at caret position
with the referenced content. This action is useful when you want to make changes to
the content but decide to keep the referenced fragment unchanged.
- Insert Equation - Allows you to insert an MathML equation.
.
- Create Reusable Component - Creates a reusable component from
a selected fragment of text. For more information, see Reusing
Content.
- Insert Reusable Component - Inserts a reusable component at
cursor location. For more information, see Reusing
Content.
- Remove Content Reference - Removes the
conref attribute of an element. For more information, see Reusing
Content.
- Add/Edit Content Reference - Add or edit the
conref attribute of an element. For more information, see Reusing
Content.
Paste as Content
Reference - Pastes the content of the clipboard as a content
reference. Note that the copied element must have the id attribute
set.
Paste as Link -
Pastes the content of the clipboard as a link. Note that the copied element must
have the id attribute set.
Insert Ordered
List - Inserts an ordered list with one list item.
Insert Unordered
List - Inserts an unordered list with one list item.
Insert List
Item - Inserts a new list item for in any of the above two list
types.
Insert Table -
Opens a dialog that allows you to configure the table to be inserted. The dialog
allows the user to configure:
- the number of rows and columns of the table
- if the header will be generated
- if the title will be added
- how the table will be framed
Insert Row
- Inserts a new table row with empty cells. The action is available when the caret
position is inside a table.
Insert
Column - Inserts a new table column with empty cells after the
current column. The action is available when the caret position is inside a
table.
Insert
Cell - Inserts a new empty cell depending on the current context. If
the caret is positioned between two cells, a new one will be inserted at caret's
position. If the caret is inside a cell, then the new one will be created after the
current cell.
Delete
Column - Deletes the table column where the caret is located.
Delete Row -
Deletes the table row where the caret is located.
Join Row
Cells - Joins the content of the selected cells. The operation is
available if the selected cells are from the same row and they have the same row
span. The action is also available when the selection is missing, but the caret is
positioned between two cells.
Join Cell
Above - Joins the content of cell from current caret position with
that of the cell above it. Note that this action works only if both cells have the
same column span.
Join Cell
Below - Joins the content of cell from current caret position with
that of the cell below it. Note that this action works only if both cells have the
same column span.
Split Cell To The
Left - Splits the cell from current caret position in two, inserting
a new empty table cell to the left. Note that this action works only if the current
cell spans over more than one column. The column span of the source cell will be
decreased with one.
Split Cell To The
Right - Splits the cell from current caret position in two,
inserting a new empty table cell to the right. Note that this action works only if
the current cell spans over more than one column. The column span of the source cell
will be decreased with one.
Split Cell
Above - Splits the cell from current caret position in two,
inserting a new empty table cell above. Note that this action works only if the
current cell spans over more than one row. The row span of the source cell will be
decreased with one.
-
Split Cell Below
- splits the cell from current caret position in two, inserting a new empty
table cell below. Note that this action works only if the current cell spans
over more than one row. The row span of the source cell will be decreased with
one.
Note: DITA supports the CALS table model similar with DocBook document type in addition to
the simpletable element specific for DITA.
CAUTION:
Column specifications are required for table actions to work
properly.
- Generate IDs - Available in the
contextual menu only, this action allows you to generate an unique ID for the
element at caret position. If the element already has an id set, it is
preserved. Further options are offered in the ID
Options dialog, available in the DITA main
menu. Here you can specify the elements for which
Oxygen XML Editor plugin
generates an ID
if the Auto generate ID's for elements is enabled. If you
want to keep already set element id's when copying content in the same document,
make sure the Remove ID's when copying content in the same
document option is not checked.
- Search References - Finds the references to the id
attribute value of the selected element in all the topics from the current DITA map (opened
in the DITA Maps Manager view). The default shortcut of the action is
Ctrl+Shift+G and can be changed in the
DITA Topic document type.
All actions described above are available in the contextual menu, the
DITA submenu of the main menu or in the Author custom
actions toolbar.
A drag and drop with a file from
the
Project view or from the DITA
Maps Manager view to a DITA topic document that is edited in
Author mode will create a link to the dragged file (the xref DITA
element with the href attribute) at the drop location. A drag and
drop with an image file from the default file system application (Windows Explorer on
Windows, Finder on Mac OS X, etc) will insert an image element (the
image DITA element with the href attribute) with
the location of the dragged file at the drop location, like the Insert
Graphic toolbar action.