Embedding Content in a Doclet

Now that Excel- and Management Reporting-based reference doclets are added to a Word-based report package, report content has been created and named ranges defined, and available content has been identified, this content can be embedded. You can embed content in Word doclets. For example, among the available content in the report package, there may be a chart or grid that an author wants to add to a doclet.

Note:

Before you begin, ensure that the doclet author phase is initiated.

To embed content in a doclet:

  1. Open the doclet and check it out.
    We'll call the doclet our "target" doclet.
  2. Place the cursor at the point in the target doclet where the embedded content should be inserted.

    In Figure 18-16, the solid green arrow shows the insertion point for the embedded content.

    Figure 18-16 Example Target Doclet with Cursor at Insertion Point

    A portion of a Word doclet, showing the cursor with an arrow pointing at it. This is where the content will be embedded.
  3. From the target doclet, click the Embed button in the Performance Reporting ribbon.
    embed button in the Performance Reporting ribbon

    The Embed Contents dialog box is launched.

  4. In Embed Contents, select the range to embed.
    In the example in Figure 18-17, we see both Excel- and Management Reporting-based content in the list. We'll select MyRange, which happens to be Excel-based content.

    Figure 18-17 Embed Contents Dialog Box

    The Embed Contents dialog box with MyRange selected.
  5. Click OK.

    The selected range is inserted, or embedded, into the Word doclet, as shown in Figure 18-18. This figure assumes that in the Home ribbon in Word, the Show/Hide button in the Paragraph group is enabled.

    Figure 18-18 Example Target Doclet After Embedding a Range

    The doclet after range is embedded. An extra paragraph marker exists between the last line of text and the embedded content.

    Note the blank paragraph marker before the embedded content. You can delete the marker to give the doclet a more polished look, as shown in Figure 18-19

    Figure 18-19 Example Target Doclet with Extra Paragraph Marker Removed

    The doclet with the extra paragraph marker removed.
  6. Repeat the steps above for all content you want to embed in the currently opened and checked-out target doclet.

    Note:

    Embedded content must not overlay or overlap other instances of embedded content.

  7. When your work is completed in the current doclet, upload it, and then check it in.
  8. You may want to refresh embedded content