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_name`	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_name`	Opens the specified help book in Help Viewer.	“Opening Other Help Books”
`help:runscript`	`help:runscript=help_folder_name/` `subfolder/scriptname string=` `'optional_string_parameter'`	Runs the specified script. The `string` argument is an optional argument that is passed to the script.	“Automating Help Tasks with AppleScript”
`help:search`	`help:search='search_string'` `bookID='help_book_name'`	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”
`help:topic_list`	`help:topic_list=anchor_ID` `bookID=book_ID` `template=path_to_XQuery_template` `stylesheet=path_to_CSS` `Other=item_name`	Generates a list of the help pages that include `anchor_ID`.	“Generating Lists from Anchors”

< Previous PageNext Page >

Hide TOC

Did this document help you?
Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.