Home > Installation > URL Parameters
URL Parameters
Dynamic Help Console Parameters
|
Parameter
|
Description
|
|
Pageid
|
Displays the specified page when a help system is opened.
Syntax: default.aspx?pageid=<Page ID>
Example1: WebServer1/helpconsole2010/helpproject1/default.aspx?pageid=faq
Example2: http://www.company.com/help/helpproject1/default.aspx?pageid=faq
|
|
Skin
|
Applies the specified skin when a help system is opened.
Syntax: default.aspx?Skin=<SkinName>
Example1: WebServer1/helpconsole2010/helpproject1/default.aspx?skin=blue
Example2: http://www.company.com/help/helpproject1/default.aspx?skin=blue
|
|
Search
|
Lists pages matching the search text specified in the URL.
Syntax: default.aspx?Search=<SearchText>
Example: default.aspx?search=keyword
|
| Anchor |
Specifies the anchor to display when the page is loaded.
Example: default.aspx?pageid=Editor_Toolbar&anchor=undo
|
| Merge Pageid |
Displays a page within an embedded (or merged) project when a help system is opened.
Syntax: default.aspx?pageid=<Project>:<Page ID>
Example1: WebServer1/helpconsole2010/helpproject1/default.aspx?pageid=project1:faq
Example2: http://www.company.com/help/helpproject1/default.aspx?pageid=project1:faq
|
Note: Place a question mark (?) before the first parameter and an ampersand (&) before additional parameters.
Example - WebServer1/helpconsole2010/helpproject1/default.aspx?pageid=faq&skin=blue
Static Help Console Parameters
|
Parameter
|
Description
|
|
Page
|
Displays the specified page when the help system is opened.
Syntax: default.htm?<Page Filename>
Example1: WebServer1/helpconsole2010/helpproject/static/default.htm?faq.htm
Example2: WebServer1/MyApp/help/default.htm?faq.htm
* This assumes that your application is running under the virtual directory "MyApp" and the folder containing your help system is named "help"
Example3: http://www.company.com/help/default.htm?faq.htm
* This assumes that your application is running on the domain "company.com" and the folder containing your help system is named "help"
|
|
Anchor
|
Loads the specified page and positions the specified anchor at the top of the page.
Syntax: default.htm?<Page Filename>#<anchor>
Example1: WebServer1/helpconsole2010/helpproject/static/default.htm?faq.htm#anchor1
Example2: http://www.company.com/help/default.htm?faq.htm#anchor1
* This assumes that your application is running on the domain "company.com" and the folder containing your help system is named "help"
|
|
|
|
See also