Adding or Deleting Excel Based Available Content from a Reference Doclet

A Reference doclet author can add or delete existing doclet content in a Reference doclet. The Reference doclet author can make additional doclet content available to use for doclet authors. A Reference doclet author can also choose to delete Reference doclet content that is no longer being used. However, if there is another doclet author that is using that doclet content in their doclet, the link in the consuming doclet is going to be broken when you check in the Reference doclet. Remapping Available Content within a Reference Doclet or File.

Note:

It’s recommended to limit the number of available contents defined within one reference doclet or reference file to 30 or less. If a doclet contains more than 30 available contents, then you may encounter extended processing time while checking in doclet, and it is possible that the doclet may fail to check-in.

Note:

If an Excel Reference Doclet has multiple charts defined, you must ensure that the chart names are unique by worksheet. Two charts can have the same name so long as they are on different worksheets.

Note:

To enable the "Repeat as header row" option within embedded Microsoft Word Tables, Edit the Excel Name Range and add the following syntax within the comment field: NR_Headings=#.

For example, if there are three rows within the name range which represent the table header, then add the following within the Name range comment: NR_Headings=3

To add or delete available content in a Reference doclet:

  1. Select the Reference doclet in the report package and select the doclet actions arrow and then Act on Content and select Check Out.
  2. Select the doclet actions arrow and select Act on Content and then select Inspect Available Content. The Inspect dialog opens for the Reference doclet and the Available Content tab is displayed by default with a list of available content that has been previously added. As shown in this example:
    embedded content dialog used to add and delete embedded content
  3. To add available content, select add. An Add Report Contents dialog is displayed for adding Excel content objects with a list of available source objects that you can add from the associated Microsoft Office Excel workbook.
  4. Select an available source object and select OK. The source object is displayed in the available content list of the Available Content tab.
  5. Optional: You can provide a user friendly name and description for the embedded content that other doclet authors can see when they add the embedded content. The given name must be unique throughout the report package.
  6. Optional: Clear the Automatically Resize Table Contents checkbox if you want to disable it. By default, this option is enabled for the available content.
    This option is applicable to embedded Word tables. When enabled, the embedded Word table resizes the rows and columns which may introduce slight differences from the source table or grid.
  7. To delete available content, select delete to the right of the available content or select the available content from the list and select the delete next to the source object.
  8. Select Close.
  9. Select Act on Content and select Check In or if changes were made that you would like to discard, select Undo Check Out to cancel any changes you made.
    Whenever a Reference doclet is checked in, all doclets that consume the associated embedded content are automatically refreshed. If available content is deleted from the Reference doclet, it does cause broken links in the doclet using that content. See Remapping Available Content within a Reference Doclet or File.