NetHelp-supported Parameters
Here is an example of a URL for NetHelp context-sensitive Help.
http://mysite.com/target/index.html?tab=1&topiconly=true#!documents/topic.htmlHere, the section after ? is called "query" and the part after # is called "hash," according to the common URL terminology (see http://en.wikipedia.org/wiki/Url#Syntax). Any URL has the following structure.
scheme://domain:port/path?query_string#hash_fragment)
QUERY Parameters
topiconly=true
All NetHelp elements will be hidden. Only the topic text will be shown and a css-class "topic-only" will be applied to the <body> element.
tab=0|toc|1|index|2|search
This parameter specifies the tab (by index or name) that will be shown when NetHelp is loaded. If any other value is specified, the parameter will be ignored.
HASH parameters
#!url
"url" is a path to a topic, either relative to the root NetHelp folder or absolute.
#?query
"query" is a key-value pair that defines a context sensitive query in the following format: "key=value." Key can be one of the following values: "keyword," "group," "id" and "search."
Examples
Example
Open NetHelp with Search tab active.
http://mysite.com/target/index.html?tab=2or
http://mysite.com/target/index.html?tab=searchOpen NetHelp and specified topic.
http://mysite.com/target/index.html#!documents/topic.htmlOpen NetHelp and specified topic and scroll topic to the "bookmark."
http://mysite.com/target/index.html#!documents/topic.html#bookmarkIf the keyword "sports" is assigned only to one topic, this topic will be displayed. If the keyword is assigned to several topics, the list of topics will be displayed. Otherwise, if no topics are associated with the keyword, "No topics found" will be displayed.
http://mysite.com/target/index.html#?keyword=sportsIf the group "sports" is assigned only to one topic, this topic will be displayed. If the group is assigned to several topics, the list of topics will be displayed. Otherwise, if no topics are associated with the group, "No topics found" will be displayed.
http://mysite.com/target/index.html#?group=sportsDisplays topic for search query "sports."
http://mysite.com/target/index.html#?search=sportsOpen topic with context ID "10." If there are no topics for the specified context ID, "No topics found" will be displayed.
http://mysite.com/target/index.html#?id=10Example — Query/Hash Parameters at Same Time
The following show how can use the Query and Hash parameters at the same time.
Open topic with hidden NetHelp elements (no tabs, header, toolbars).
http://mysite.com/target/index.html?topiconly=true#!documents/topic.htmlOpen specified topic and tab Index.
http://mysite.com/target/index.html?tab=index#!documents/topic.htmlSearch for "sports" and open search tab.
http://mysite.com/target/index.html?tab=search#?search=sportsSearch for "sports" and display results in topic only mode.
http://mysite.com/target/index.html?topiconly=true#?search=sports