Apple Help URLs

Table B-1 lists the help-specific URLs supported by Help Viewer. Use these URLs in your help book to link to other help topics and additional help resources. Arguments to help-specific URLs can either be enclosed in single quotes or can use standard URL encoding; for example the book name “SurfWriter Help” would be specified as SurfWriter%20Help. See Using Help URLs in Your Help Book for some examples of use of these URLs.

Table B-1  Help URLs

URL

Syntax

Action

Cross reference

help:anchor

help:anchor=anchor_name

bookID=help_book_id

Opens Help Viewer to the location in a help book identified by the given anchor.

Creating a Link to an Anchor Location

help://full/path.html

help://path/to/page.html

Opens the specified file in Help Viewer.

Providing Your Own Online Support Articles

help:openbook

help:openbook=help_book_id

Opens the specified help book in Help Viewer.

Opening Other Help Books

help:search

help:search='search_string'

bookID='help_book_id'

Initiates a search of a help book using the specified search criteria. Help Viewer then displays the search results.

Initiating a Search from Your Help Book



Copyright © 2003, 2013 Apple Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2013-01-28