Viewing the Frame ID in the UPK Player
By John Zaums on Dec 28, 2011
Frame IDs are unique identifiers for the frames within a single UPK topic. These are used internally by UPK and have been available in the topic editor for many releases. In the topic editor, you can view the frame ID on the "Topic Navigation and View" toolbar and when pointing to a frame in the "Frame Structure" pane.You can also use these IDs to navigate to a specific frame in a topic. Use the "Go To / Specific Frame" menu.
Locate a published UPK Player package. From the root of the package open config.js in a text editor like Notepad. Locate the following line and change it from:
Save the file and launch the player. When you launch a topic in any mode other than "Print It!" the player will show the Frame ID in the upper left corner. You can also configure the option such that the ID only appears when a specific key combination is pressed. For example, if you wanted the ID to appear when pressing Shift + F1, you could set the ShowFrameID value to "ShiftF1". More information can be found in the topic titled Display Frame ID in Topic Player in the UPK Master Documentation Library.
This option can be useful for performing content reviews. The reviewers can provide feedback by returning the name of the topic and the ID of the frame to which their comment applies. You might consider having the Frame ID only appear when a specific key combination is used for all of your UPK content. When users have feedback or difficulty with a step, you can use the Frame ID to locate the problematic material.
Since UPK 3.5, you've also been able to add the Frame ID to print styles by customizing them with the FrameID bookmark. See the topic titled Bookmark Reference in the UPK Master Documentation Library for more information.
We'd appreciate your thoughts and feedback on how you're using this new feature.
Senior Director, Product Development
User Productivity Kit