Home > Tools > Report Writer > Templates: Inserting Bookmarks

Templates: Inserting Bookmarks

When authoring a Report Writer Template, you can insert Word Bookmarks in the Template Document (*.doc, .docx) where you want to give users the option to:

While this is an optional step, it is highly recommended because it makes the template document much more flexible. This article describes how to do this.

Sections

The Template Document should mark Report Sections with Word Bookmarks starting with the prefix “RS_”. Sections let users include or exclude portions of the template when publishing their report. For example, you may want give users the option to exclude a cover page, glossary, or other section in the report.

To mark a Section:

  1. Select (highlight) a portion of the document

  2. On the Insert menu, click Bookmark.

  3. Enter a Bookmark name start with the prefix “RS_”

You can nest Sections. For example, you could have a Section “RS_Glossary” that contains multiple Sections such as “RS_ABO”, “RS_ActuarialAssumptions”, “RS_ActuarialCostMethod”, etc.

Text Substitutions

The Template Document should mark Text Substitutions with Word Bookmarks starting with the prefix “TS_”. Text Substitutions let users incorporate content from other documents. For example, you might incorporate the entire contents of “plan provisions.doc”, replacing the Bookmark (and any content it encompasses) “TS_Plan_Provisions” in the template. Or, you might incorporate just the “Projected_Unit_Credit” portion (marked by a bookmark) of the document “cost methods.doc”, replacing the Bookmark “TS_CostMethod” in the template. (The Template Document should mark portions of the report which are eligible for text substitutions with Word Bookmarks starting with the prefix “TS_”.)

To mark Text Substitutions:

  1. Select (highlight) a portion of the document, or click where you want to insert a Text Substitution

  2. On the Insert menu, click Bookmark.

  3. Enter a Bookmark name start with the prefix “TS_”

To see a list of all the TS_xxx bookmarks in your template document, click the Text Substitutions button (within a Report Definition of the Report Writer).

See also: Templates: Validating Bookmarks and Form Fields