 |
» |
|
|
|
HP Help supports five types of hyperlinks:
Traditional hypertext to "jump" to another help topic. By default the new topic is displayed in the same window, but you may request that the new topic be displayed in a new window.
Definition links to display a topic in a simple pop-up help window. Most frequently, definition links are used to access the definition of a new term or phrase used within a sentence.
Man page links to display any man page installed on the system.
Execution links to execute a shell command or program. This greatly expands the possibilities for what happens when the user activates a hyperlink.
Application-defined links to create custom links that the application interprets. This provides facilities for communication between the help system and the application.
To create a "jump" link | |
To jump to a topic within the same volume, use the <link> element as
shown:
Where id is an ID declared somewhere in the help volume, and text is the portion of your help text that is underlined to indicate it is an active hyperlink.
Or, to jump to a topic (within the same volume) that has a pre-defined ID, use the <link> element as shown:
<link hyperlink="id">text<\link>
|
All the predefined IDs start with an underscore character _), so this makes it necessary to use the hyperlink="id" form.
Or, to jump to a topic in another help volume:
<link hyperlink="volume id" JumpNewView>text<\link>
|
If the other volume is "registered," the volume parameter is just the base name of the volume file. If the volume is not registered, you must
include a complete path to the volume's volume.hv file.
The JumpNewView parameter is recommended for links to other volumes so
that the readers realize that they have jumped into another volume.
The previous view remains displayed so they can see where they came from.
Or, if you are linking to an element with a title, use the <xref> element as shown:
When you use <xref> to create a link, the title of the topic with the ID of id is inserted in place of the <xref> element and becomes
the active hyperlink.
Also, <xref> always creates a standard "jump" link; other types of links must be created using the <link> element.
| | | |  | NOTE: You cannot use <xref> to jump to topics that have built-in IDs (such as <hometopic> or <glossary>). To create a hyperlink to any of those elements, you must use the <link> element.
| | | | |
Examples. Here's a simple hyperlink to the topic with the ID "Welcome." (Notice that
capitalization of the ID is not significant.)
This is a <link welcome>simple jump<\link> link.
|
Here's the same link, but the title of the Welcome topic is inserted
using an <xref>:
Refer to the <xref welcome> topic.
|
Here's a link to the same topic, but this one requests a new window:
This is a <link welcome JumpNewView>new-view jump<\link> link.
|
This link jumps to the home topic of the current volume:
Return to <link hyperlink="_hometopic">Introduction<\link>.
|
This link jumps to the home topic of the Vuefile help volume:
Return to <link hyperlink="Vuefile _hometopic">Introduction<\link>.
|
See Also.
To create a definition link | |
If you are linking to a term in the Glossary, use the <term> element as shown:
Or, use the shorthand form:
Whenever you use the <term> element, be sure you include the
corresponding definition in the Glossary.
Or, if you are linking to a topic within the same help volume, use the
<link> element as shown:
<link id Definition>text<\link>
|
Where id is a topic ID (or the ID of an element within the topic) and
text is the portion of your help text that you want to be the active
hyperlink. The Definition keyword specifies that the link should
pop-up a quick help dialog.
Or, if you are linking to a topic in another help volume, use the
<link> element as shown:
<link hyperlink="volume id" Definition>text<\link>
|
If the other volume is "registered," the volume parameter is just the base name of the volume file. If the volume is not registered, you must include a complete path to the volume's volume.hv file.
Example. The following link creates a definition link that displays the copyright
topic in the meta information:
<link hyperlink="_copyright" type=Definition>Version Information<\link>
|
The phrase "Version Information" becomes the (underlined) hyperlink text.
See Also.
To create a man page link | |
Use the <link> element as shown:
<link manpage Man>text<\link>
|
To request a man page from a particular "section," use the hyperlink parameter like this:
<link hyperlink="section manpage" Man>text<\link>
|
For man page links, the hyperlink parameter is the same string you
would enter if executing the man command by hand.
| | | | | NOTE: If you are writing help for an application and you include any man page links, your application must include special support for man pages. See “To display a man page”. (The Helpview application includes support for man page links.)
| | | | |
Example. Here's a link that displays the man page for the grep command:
Refer to the <link grep Man>grep(1)<\link> command.
|
"Man" is a keyword for the <link> element,
so if you want to create a link that displays the
man page for the man command, you must use the hyperlink parameter:
Refer to the <link hyperlink="man" Man>man(1)<\link> command.
|
To display a man page in a particular section, precede the man page name
with the section number. The following link displays the "mkdir" man page
from section 2 (which is different than the man page of the same name in
section 1):
Refer to the <link hyperlink="2 mkdir" Man>mkdir(2)<\link> command.
|
See Also.
To create an application-defined link | |
Use the <link> element with the AppDefined parameter as shown:
<link hyperlink="data" AppDefined>text<\link>
|
Where data is a text string passed to the application when the link is
invoked, and text is the underlined hyperlink text.
Example. Suppose you are writing help for an application that prints three styles of
reports. You might create three hyperlinks like this:
Choose a report type:
<list plain tight>
* <link hyperlink="Report-Daily" AppDefined>Daily Report<\link>
* <link hyperlink="Report-Month-To-Date" AppDefined>MTD Report<\link>
* <link hyperlink="Report-Year-To-Date" AppDefined>YTD Report<\link>
<\list>
|
If your application is prepared to handle these special links and interpret
the hyperlink strings, it could generate the appropriate report based on
the hyperlink chosen by the user.
To link to a meta information topic | |
Use the <link> element as shown:
<link hyperlink="_id">text<\link>
|
Where id is the pre-defined ID associated with the element you want to
link to and text is the word or phrase that you want to be the active
hyperlink.
Most topics within the meta information section have pre-defined IDs,
so they do not allow author-defined IDs. The pre-defined IDs
consist of the element name preceded by an underscore character.
For example, the ID for the <copyright>
topic is _copyright. (Case is not significant).
Topics entered with the <otherfront> element can be linked to just like any normal topic in the topic hierarchy.
See Also.
|
Printable version
