Add hypertext commands to documents

To add hypertext commands to a document, you need to first Define an active area in a document and then Associate a hypertext command with an active area.

Define an active area in a document

You can associate hypertext commands to text or images in a document. When a user clicks on the active area, the area is highlighted after which the command is executed.

Create a text active area in a document

You can define a word, phrase, paragraph, or multiple adjacent words as active areas. To identify a text active area, FrameMaker uses the character format of the text. This implies that the character format of the text active area must be different from that of the surrounding text. If the character format is the same as the surrounding text, the entire text in the paragraph is set as active.

Define an active area for a word or phrase

1)Select the word or phrase.

You need to change the character format of selected the word or phrase.

2)In the Format menu, go to the Characters sub-menu.

3)In the Characters sub-menu, you can choose from the list of default character formats available in the current document catalog.

Alternatively, open the Character Designer catalog and apply a custom character format.

note:    The following character format changes cannot be used to define a text active area: pairkerning, spread, stretch, change bars, language, and case.

tip:   If you do not want the text in active area to display differently from the surrounding text, use a different character format that has the identical formats as the surrounding text. You can save the character format of the surrounding text with a different name and then apply that character format to the active area.

Define an active area for a paragraph

Ensure that the same character format is applied to the entire paragraph.

Define separate active areas for adjacent words or phrases

You can assign different hypertext commands to adjacent words or phrases in a paragraph by applying by different or the same character format to the words or phrases. However, you need to ensure that the character formats of the words or phrases are not the same as that of the surrounding paragraph text. See Define an active area for a word or phrase. After this you can associate a hyper­text command with each of the adjacent words or phrases. For details, see Insert hypertext command marker.

Define an image active area

You can define an active area on an image in a document. When a user clicks the image, the associ­ated hypertext command is executed.

1)Draw a text frame to cover the image in the document.

Make sure that the graphic is not set to have text run around it.

To place a text frame over the image:

a)Open the Graphics tool bar (View > Toolbars > Graphics Toolbar).

b)Click Text Frame in the Graphics Toolbar and draw the text frame to cover the image.

2)Set the text frame fill and pen patterns to None.

To set the text frame properties:

a)Right-click the text frame and choose Object Properties.

In the Anchored Frame Properties dialog:

b)Go to the Stroke tab and uncheck the Pen Pattern option.

c)Go to the Fill tab and uncheck the Pattern option.

3)Ensure that the text frame is placed above the image.

If you place the image after placing the text frame, choose Graphics > Bring To Front to place the text frame in front of the graphic.

Create an active area on multiple pages in a document

If you create an active area on the master page of a document, the area will be active on all pages of the document. For example, you can add text to the document header and create an active area in the text in the header.

Associate a hypertext command with an active area

After you Define an active area in a document, you need to associate a hypertext command to the area. When a reader clicks the active area in your document, the hypertext command is executed.

View-only FrameMaker documents support all FrameMaker hypertext commands, PDF and HTML outputs of hypertext documents, have limited support. For details, see PDF and HTML: Hypertext command support.

Insert hypertext command marker

1)Place the insertion point in the active area.

Word or phrase

At the start of the word or phrase. See Define an active area for a word or phrase.

Paragraph

At the start of the paragraph. See Define an active area for a paragraph.

Multiple adjacent words or phrases

At the start of each separate word of phase. See Define separate active areas for adjacent words or phrases.

Image

In the enclosing text frame. See Define an image active area.

2)Open the Hypertext dialog. Special > Hypertext.

3)Use the Hypertext dialog to:

Element Tag

If you are adding a hypertext command in a structured document, select the required hypertext element tag.

note:    This will depend on the structured application that you are using to create your structured documents.

Command

Select the hypertext command to execute when a user click the active area to which the current hypertext command is associated.

See the current set of Available hypertext commands.

Command syntax text box

Enter the command parameters.

Hypertext commands must always appear in lowercase. The parameters can be uppercase or lowercase, but they are case-sensitive. The entire command can be up to 255 characters long. (Each character in a Japanese font counts as two characters.)

note:    If you enter a filename parameter for a file that is not in the same folder as the current document, specify a path to the document.

note:    Hypertext markers support the Unicode text encoding standard.

See the current set of Available hypertext commands.

Validate Command upon Insertion

FrameMaker will validate the syntax as soon as you insert the command in the document.

Make View-Only

Make the current document view-only.

You can also use this option to text the hypertext commands that you insert in a document.

4)Click New Hypertext Marker.

A hypertext marker is inserted in the document.

note:    To insert a hypertext command in a text inset, insert the command in the text inset source docu­ment.

note:    If a cross-reference is present in the same text area as a hypertext command, the cross-reference takes precedence over the hypertext command.


September 30, 2016

Legal Notices | Online Privacy Policy