Hyperlink
Delimits text or an inline <graphic> to be used as a hyperlink.
Syntax.
<link hyperlink [type] ["description"]>text<\link>
|
Or,
<link hyperlink="hyperlink" [type=type] [description="description"]>
|
The hyperlink attribute, which is required, is a value that identifies
the destination or the behavior for the link. For a standard "jump" link,
hyperlink is the ID of the element you want to jump to.
The type parameter can have the following values:
- Jump
(Default.) Jumps to the topic that contains the ID hyperlink.
- JumpNewView
Jumps to the topic that contains the ID hyperlink,
but requests that the hosting application display the
topic in a new window.
- Definition
Displays, in a temporary definition window, the topic
which contains the ID hyperlink.
- Execute
Executes the hyperlink string as a command.
- Man
Displays a man page using the hyperlink string as the
parameter(s) to the man command.
- AppDefined
Sends the hyperlink string to the hosting
application for special processing.
The text between the begin and end tags becomes the "hot spot" that the
user will choose to invoke the link.
Capitalization is not significant for the hyperlink and type values.
Notes.
Avoid using the type keywords (listed above) as values for
hyperlink. If you must do so, explicitly identify the
parameters as shown in the second syntax line above.
The <link> element is not needed in a cross-reference that uses the
<xref> element because a hyperlink is automatically created
where the <xref> element is used.
Examples.
The following markup defines a simple hyperlink to the topic with the
ID Welcome. Notice that capitalization of the ID is not significant.
Refer to the <link welcome>Welcome<\link> topic.
|
The following markup defines the same hyperlink jump as
in the previous example but the <link> element is not used because a
cross-reference (<xref...>) is automatically a hyperlink.
In this case, the title of the Welcome topic is automatically
supplied by HelpTag.
Refer to the <xref welcome> topic.
|
The following markup defines a hyperlink that is activated when the
inline graphic is chosen. A new window is opened to display the
referenced help information.
The <link clockInfo JumpNewView>
<graphic entity=ClockIcon><\link> icon ...
|
The following markup creates a link that displays the man page for the
grep command:
For more details, refer to the
<link grep Man>grep man page<\link>.
|
See Also.
Printable version
