Creating hotspot links in the editor
You can use the Contenta Hotspot Manager tool in Arbortext Editor or Oxygen XML Author to create hotspot links in a CGM or SVG graphic to text elements within the DM. The tool includes all the required markup for the internal reference based on the applicable S1000D issue and streamlines the process for creating a graphics legend.
Before you begin
- To use the Contenta Hotspot Manager tool, the DM with which you are working must contain at least one CGM or SVG graphic with hotspot areas defined, which must be checked out with the DM. When opening the DM, if prompted, be sure to select Export Graphics. If prompting for exporting graphics in not enabled, the
{Global} user/Settings/Graphics exportReferencedGraphicsAppData key must be set to yes. - SVG images created by converters using CSS styling (such as Larson Convert CGM to Vector) may not render correctly in the viewer within the DM. Such an image may appear in the viewer as a white block with no lines, text, or other SVG objects.
Procedure
- In the editor, open the DM containing one or more CGM or SVG graphics for which you want to create hotspot links.
- Do one of the following.
- In Arbortext Editor, select Contenta > Manage Hotspots to display the Manage Hotspots panel.
- In Oxygen XML Author, select the Contenta S1000D tool panel Hotspot tab.
- From the drop down at the top of the Contenta Hotspot Manager dialog, select the graphic with which you want to work.
The upper panel of the dialog displays the selected graphic and the lower panel displays a list of existing
hotspotelements in the DM (if any) that correspond to the hotspots defined in the graphic.Note: For each hotspot in the graphic that will be referenced, a correspondinghotspotelement must be created, either manually or using the Hotspot Manager tool. - To generate a
hotspotelement corresponding to each hotspot in the graphic, click Add hotspots to XML.The Hotspot Manager tool adds ahotspotelement corresponding to each defined hotspot for which one did not previously exist, updates the list of hotspot elements in the lower panel of the dialog, and displays a confirmation message. - Optionally, edit each
hotspotelement to add appropriate attributes. - To add an internal reference in the DM to a
hotspotelement, do the following.- Navigate to the place in the DM where you want to create the internal reference.
Note: This must be a location where an
xreforinternalRefelement is allowed. - In the lower panel of the Contenta Hotspot Manager dialog, select the
hotspotelement you want to be the target of the internal reference. - Click Add cross-reference to this hotspot.
The tool adds the required markup for the internal reference. - Navigate to the place in the DM where you want to create the internal reference.
- Optionally, to add an internal reference from a
hotspotelement to an element in the DM, do the following.- In the lower panel of the Contenta Hotspot Manager dialog, select the
hotspotelement from which you want to add a reference. - Click Add cross-reference from this hotspot.
The tool displays a dialog with the following message.
Insert a CSNREF (Yes) instead of an XREF? - Click No.
The Manage Internal References tool launches, displaying a dialog listing the elements to which you can refer.Note: The list of potential target elements is determined by the default configuration file named xref_targets_dflt_xxx.txt (where xxx represents the S1000D spec issue with which you are working). The spec issue is included in the file name in three digits without decimals; for example,
420represents issue 4.2. To populate the list, the tool searches the DM for each element type listed in the applicable default configuration file and lists each such element found. You can control which elements are included in the search by editing the default configuration file.An element ID is shown for each potential internal reference target. If an element has not already been assigned an ID, the tool generates one (based on values specified in the xref_target_fmt.xml file) and shows it marked with an asterisk (*). In such a case, the ID will be assigned to the target element when you click the Select Xref target or Assign Pending IDs button.
- Optionally, use the Hide/Show IDs button to toggle display of the IDs associated with each potential internal reference target.
- Optionally, use the Filter drop down to filter the list by element type. The drop down shows each applicable target element type with the number of instances found in the DM in parentheses. If the dialog contains a long list of potential internal reference targets, filtering the list can make finding the desired target easier.
- Optionally, assign an ID to each of the elements visible in the list with a pending ID.
Note: If you plan to insert multiple internal references in a single session, assigning all the pending IDs first can save time by eliminating the need for the tool to assign an ID each time a reference is added.
- Select the target element and click Select Xref target.
The tool does the following.- inserts the required markup for the internal reference
- assigns an ID to the reference target (if one does not already exist)
- closes the dialog
- In the lower panel of the Contenta Hotspot Manager dialog, select the
- Optionally, to add reference from a
hotspotelement to an item in an Illustrated Parts Data (IPD) DM, do the following.- In the lower panel of the Contenta Hotspot Manager dialog, select the
hotspotelement from which you want to add a reference. - Click Add cross-reference from this hotspot.
The tool displays a dialog with the following message.
Insert a CSNREF (Yes) instead of an XREF? - Click Yes.
The Select CSN target dialog launches.
- From the drop down at the top of the dialog, select the IPD DM containing the item to which you want to link.
After an IPD DM has been selected, the lower panel of the dialog displays a list of the potential reference targets in the DM.
- Select the item to which you want to link and click Select CSN target.
The tool inserts the required markup for the link and closes the dialog. - In the lower panel of the Contenta Hotspot Manager dialog, select the
- To build a figure legend for the hotspots in the graphic, click Build fig legend from hotspots.
The tool inserts the required markup for the legend and displays a confirmation message. Each legend item comprises a Definition List item containing a
termand adefinition. Thetermis a cross-reference to the hotspot, and thedefinitiondisplays the hotspot title. If a hotspot does not contain a title, the system displays the following summary message.The following hotspot(s) have no title. This will impact display when the DM is published.