DITA Preview and XML Tab Toolbar


Review the toolbar options provided in the DITA Preview and XML tabs. Use them to run preview transformations and to review preview logs.

This topic includes:

  1. Preview Button

  2. Content Screen

  3. Log Screen

  4. Actions Menu

1. Preview Button

For the DITA Preview tab, use the Preview button to generate a visual preview of the DITA item's content. See Previewing DITA Content Views for details to configure and run DITA preview transformations.

For the XML tab, use the Preview button to generate a preview of the DITA item's raw XML. See Previewing DITA XML Content for details to configure and run preview transformations for raw XML.

2. Content Screen

For the DITA Preview tab, select the Content option to display the visual preview of the DITA item's content in the main pane. Use the Content screen's device emulation settings and advanced preview settings to apply additional configurations.

For the XML tab, select the Content option to display the preview of the of the DITA item's raw XML in the main pane.

Device Emulation Settings

Note

Only the DITA Preview tab provides these settings.

Use the device emulation settings in the toolbar to preview how the DITA views will display on individual hardware devices.

See Previewing Devices for details.

Advanced Preview Settings

Note

Only the DITA Preview tab provides these settings.

Select the Configure Preview Settings (gear) button in the toolbar to set advanced preview settings.

Options include:

Site

Select a site preview option from the drop-down list.

Device

Select a device emulation mode from the drop-down list to preview how the DITA views will display on individual hardware devices.

See Previewing Devices for details.

Publishing Target

Select a publishing target from the drop-down list. DITA Preview will load the content based on the selected publishing target's views and configurations.

Options

Select an output option from the drop-down list for the preview content. The option you choose alters the preview display. Options include:

  • Default. Displays the preview via the default output settings.

  • Force HTML Transform. Displays the preview with a forced HTML transformation.

  • Preview without Stylesheet. Displays the preview without applying the preview stylesheet.

  • Raw XML. Displays the preview of the DITA content's raw XML output.

Query Strings

Enter query string values to include. The preview emulates search filters based on the provided parameters.

Form

Enter form values to emulate post fields.

Cookies

Enter values to emulate current cookies.

Important

Select the Include browser cookies checkbox to include browser cookies in the preview.

Server Entries

Enter values to emulate server entries.

Show all pages checkbox

If selected, this option returns all DITA content in the preview, including unmarked DITA content.

Important

If selected, this option includes unconfirmed DITA dependencies in the preview. See DITA "Depends On" Properties for details about confirmed and unconfirmed dependencies.

Include browser cookies

If selected, this option includes browser cookies in the preview.

3. Log Screen

Select the Log option to display the log details of the DITA-OT transformation process associated with the DITA visual preview or raw XML preview in the main pane. Users can review the log information at any time during or after the transformation process.

Log Tools

Use the log tools to review details about the most recently executed transformation process.

Toolbar options include:

Go to Error

If the log contains errors, use the toolbar Error arrows to navigate to error entries. Select the left arrow to navigate to the previous error, and select the right arrow to navigate to the next error.

Download Log

If the system ran the DITA-OT transformation process instead of using an existing cache for preview generation, select Download Log to download a .txt file of the log details.

Note

To view the log files for previously executed DITA preview transformations, access the Post Processing Status Console in Administration > Publishing Monitor. See Accessing DITA Logs for details.

4. Actions Menu

Access the Actions drop-down menu for CMS authoring tools in the DITA Preview or XML tab.

Drop-down menu options include:

Check In/Check Out

Check in or check out the DITA content. See Checking Pages In or Out for details.

Refresh

Reload the preview for the DITA content.

Assign to

Assign the DITA content to a user account or user group. See Assigning Assets for details.

Add to Workflow/Advance in Workflow

Add or advance the DITA content within a CMS workflow. See Adding Assets to Workflow for details.

Mark/Unmark for Publish

Mark or unmark the DITA content for a publishing target. See Marking Assets for Publish or Unmarking Assets for Publish for details.

Publish

Publish the DITA content to one or multiple publishing targets via the DITA publishing pipeline. See Publishing DITA Assets for details.