Bookmarks on the Word Custom Toolbar

From UPK wiki
Jump to: navigation, search

Contents

Overview

Much of the content of the Word-based output types is controlled through the use of standard Word Bookmarks, which are then replaced by the actual content when UPK generates the output document. Each of the Word printed output document templates PrintTemplate.docm contains a predefined set of bookmarks, which generate the appropriate content for that document type. However, UPK (from version 9.x) provides the ability to include additional content by inserting the relevant bookmark at the required point. Bookmarks can be inserted via the Custom Toolbar (which is available in all of the Printtemplate.docm files) or you can just use standard Word functionality to insert them manually.

Accessing the Custom Toolbar

To access the Custom Toolbar (it doesn't have a better name), in Word select the Add-Ins option on the ribbon, and you should see a new section called Custom Toolbars. This has a set of menus that can be expanded to show the individual items that you can insert.

Available Bookmarks

The table below lists the menu options, the boookmarks they insert, and the content that this will be expanded to include, at document generation time.

Outline menu

Option Sub-option Bookmark Content
Outline name OutlineName The Name of the highest-level Outline Element published (this is the equivalent of the Title)
Modules and Sections Module and Section ForEeachModuleSection_Begin

ForEachChildOutlineItem_Begin
ForEachChildOutlineItem_End
ForEachModuleSection_End

Indented list of the full Outline leading to this element
Name, with Style Defined in Template ModuleSectionName Module and Section names
Name, with Style Referenced to Outline Level OLModuleSectionName Module and Section names
Concept ModuleSectionConcept_Begin_x

UrlType_Begin_x
Url
UrlType_End_x
Placeholder for image from a package
Webpage_Begin_x
PubOptionWebpageText
Placeholder for image from a Web Page
Webpage_End_n
ModuleSectionConcept_End_7

Inserts the contents of the Web Page used as the Concept Page of the document, including any images inserted directly into the Web Page or included via a Package. Note that this inly applies to Web Pages and not other document types used as Concept Pages.
Description Description Inserts outline Description
Table of Context IDs ForEachModuleSectionCtx_Begin_x

ContextName
ApplicationName
ContextIDs
ForEachModuleSectionCtx_End_x

Inserts a 3-column table of all of the Context IDs captured for the Frame.

(in progress)

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox