History | Edit

Oxygen XML Editor includes support for defining your own profiling attributes, or modifying existing ones, for each particular document type (framework). You can then apply the profiling attributes to content in Author mode to see how the profiling will affect the output.

Create Profiling Attributes

To create custom profiling attributes for a specific document type, follow these steps:
  1. Make sure the attribute is already defined in the document DTD or schema before continuing with the procedure.
  2. Open the Preferences dialog box (Options > Preferences) and go to Editor > Edit modes > Author > Profiling/Conditional Text .
  3. In the Profiling Attributes section, press the New button.

    Step Result: The Profiling Attribute configuration dialog box is opened.

    Figure: Profiling Attribute Dialog Box

  4. Configure your profiling attributes as desired. The following options are available in this dialog box:
    Document type
    Select the document type (framework) for which you have defined profiling attributes.
    Tip: You can use the * or ? wildcards in this combo box. For example, DITA* would match any document type that starts with "DITA". You can also specify multiple document types by using commas to separate them.
    Attribute name
    The name of the new profiling attribute.
    Display name
    This optional field is used for descriptive rendering in profiling dialog boxes.
    Attribute Values Table
    This table displays the values for the profiling attribute and allows you to configure them by using the following buttons at the bottom of the table:
    New
    Opens a dialog box that allows you to insert a new value. The fields that can be configured in this dialog box correspond to the columns in the table and are as follows:
    Edit
    Use this button or double-click an attribute value to modify it.
    Delete
    Removes the selected attributed value.
    Single value
    Select this option if you want the attribute to only accept a single value.
    Multiple values separated by
    Select this option if you want the attribute to accept multiple values, and you can choose the type of delimiter to use. You can choose between space, comma, and semicolon, or you can enter a custom delimiter in the text field. A custom delimiter must be supported by the specified document type. For example, the DITA document type only accepts spaces as delimiters for attribute values.
  5. Click OK to confirm your selections and close the Profiling Attributes configuration dialog box.
  6. Click Apply to save the profiling attribute.

Editing Existing Profiling Attributes

To modify an existing profiling attribute or its values, follow these steps:
  1. Open the Preferences dialog box (Options > Preferences) and go to Editor > Edit modes > Author > Profiling/Conditional Text.
  2. In the Profiling Attributes section, press the Edit button to modify an existing profiling attribute (you can also use Delete button to remove a profiling attribute or the Up and Down buttons to change their priority).

    Step Result: If you use the Edit button, the Profiling Attributes configuration dialog box is opened:

  3. Modify your profiling attribute as desired.
  4. To add or modify attribute values, use the New, Edit, or Delete buttons under the attribute values table.
  5. Click OK to confirm your selections and close the Profiling Attributes configuration dialog box.
  6. Click Apply to save your modifications.

Adding or Editing Profiling Attribute Values

There are several ways to add values to existing profiling attributes.
  • Use the procedure in the Editing Existing Profiling Attributes section to edit an existing attribute and use the Profiling Attribute configuration dialog box to add, edit, or delete values for existing profiling attributes.
  • You can add values directly to the existing profiling attributes in a document using the In-Place Attributes Editor in Author mode, the Attributes view, or in the source code in Text mode. However, this just adds them to the document and does not change the conditional text configuration. If you invoke the Edit Profiling Attributes action (from the contextual menu in Author mode) on the new value, the Profiling Values Conflict dialog box will appear and it includes an Add these values to the configuration action that will automatically add the new value to the particular profiling attribute. It also includes an Edit the configuration action that opens the Profiling / Conditional Text preferences page where you can edit the profiling configuration.
    Note: If the Allow contributing extra profiling attribute values option is not selected in the Profiling / Conditional Text preferences page, the Profiling Values Conflict dialog box will never appear, so this second method will not be possible.

    Figure: Profiling Values Conflict Dialog Box

Sharing Profiling Attribute Configurations

Your profiling configuration can be shared with other users through a project file. If you select Project Options at the bottom of the Profiling/Conditional Text preferences page, your configuration is stored in the project file and can be shared with others. For instance, if your project file is saved on a version control system (such as SVN, CVS, or Source Safe) or in a shared folder, your team will have the same option configuration that you stored in the project file.

For more information about sharing project files, see Sharing a Project - Team Collaboration.