AgileApps Support Wiki Pre Release

Difference between revisions of "Help URL"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
The custom help URL is invoked when the object's Help icon ([[Image:helpicon.gif|link= ]]) is clicked.
The help URL is invoked when the clicks the ''Learn More'' link in the Gear menu ([[File:GearIcon.png]]).


If this field is empty, the default Help Domain is used, as defined by the Service Provider. {{#if: {{ShowIsvInfo}} {{ShowMspInfo}} | (Under ''Basic Service Configuration'', use Service Provider Settings (or MSP Settings).)}}
If this field is empty, the default Help Domain is used, as defined by the Service Provider.


If this field is not empty, and contains a valid URL, it overrides the default help URL for the object. Either an absolute or relative URL can be specified.
If this field is not empty, and contains a valid URL, it overrides the default help URL for the object. Either an absolute or relative URL can be specified.


The format for an absolute URL is: '''<tt><nowiki>http://www.examplehelp.com</nowiki></tt>''' or '''<tt><nowiki>http://www.examplehelp.com/objectname</nowiki></tt>''').  
The format for an absolute URL is: '''<tt><nowiki>http://www.examplehelp.com</nowiki></tt>''' or '''<tt><nowiki>http://www.examplehelp.com/objectname</nowiki></tt>'''.  


A relative URL does not begin with "http://". That kind of URL is relative to the Help Domain defined by the Service Provider.
A relative URL does not begin with "http://". That kind of URL is relative to the Help Domain defined by the Service Provider.
{{#if: {{ShowIsvInfo}} {{ShowMspInfo}} |
''Learn more:'' [[Custom Help Domain]]
}}

Latest revision as of 22:51, 11 July 2013

The help URL is invoked when the clicks the Learn More link in the Gear menu (GearIcon.png).

If this field is empty, the default Help Domain is used, as defined by the Service Provider.

If this field is not empty, and contains a valid URL, it overrides the default help URL for the object. Either an absolute or relative URL can be specified.

The format for an absolute URL is: http://www.examplehelp.com or http://www.examplehelp.com/objectname.

A relative URL does not begin with "http://". That kind of URL is relative to the Help Domain defined by the Service Provider.