Configuring App-Specific Help
You can configure the app’s companion file so that when the user clicks the Help link in the web client they are directed to help relating to the app rather than Xpress Insight.
This only applies when the user is on the app page.
To enable app specific help, you need to add a line to the app’s companion file.
External URL example:
<?xml version="1.0"?> <model-companion xmlns=”http://www.fico.com/xpress/optimization-modeler/model-companion” version="3.0"> <help-url>https://my.external.help.url</help-url> ...
|
Note A link is treated as absolute if it contains a scheme (such as
https://). Otherwise it is treated as relative to
client_resources.
|
Relative URL example:
<?xml version="1.0"?> <model-companion xmlns=”http://www.fico.com/xpress/optimization-modeler/model-companion” version="3.0"> <help-url>path/relative/to/client_resources</help-url> ...
|
|
Note Use this link to point to the documentation generated by the
moseldoc facility from annotations added to the Mosel source files. For more on
moseldoc, see
Documenting models using annotations.
|