Edit online

Content Completion in DITA

Oxygen XML Author includes an intelligent Content Completion Assistant that offers proposals for inserting structured language elements, attributes, and attribute values that are valid in the current editing context. The functionality of the feature is slightly difference for each editing mode:
In addition to the general functionality and types of proposals that are offered in the Content Completion Assistant (as described in the two topics listed above), some DITA-specific actions are offered as proposals in the content completion when using the feature in DITA documents. These actions include:
  • keyref - Opens a pop-up window that allows you to choose a key from a list all the keys that are gathered from the context DITA map (except for those that point to resource-only topics). If the chosen key defines a keyword, the @keyref attribute is inserted inside a <ph> element, while if the chosen key points to a resource, the @keyref attribute is inserted inside an <xref> element.
  • conref - Opens a pop-up window that allows you to choose reusable content from a list all the reusable components (elements with IDs in topics that are referenced as resource-only in the context DITA map). For each element, a preview of the content is shown in the documentation panel to the right of the pop-up. Once an element is chosen, a @conref or @conkeyref is inserted, depending on the defined component.
  • xref (cross reference) - Opens the dialog box that allows you to insert a link to a specified target DITA resource at the current location within a document. The target resource can be the location of a file or a key that is already defined in your DITA map structure. Once the target resource has been selected, you can also target specific elements within that resource. The action inserts an <xref> element with an @href or @keyref attribute that points to the target.
  • xref (web link) - Opens a dialog box that allows you to insert a link to a target web-related resource at the current location within a document. The target resource can be a URL or a key that is already defined in your DITA map structure. It inserts an <xref> element with either an @href attribute or a @keyref attribute.
  • simpletable - Opens a dialog box that allows you to configure and insert a table. You can generate a header and footer, set the number of rows and columns of the table, and decide how the table is framed.