This page lists how you can update the help sections of your InterMine.
To add help links to the top of your website, add an entry to
web.properties listing the links:
Then specify the URLs:
For example, see FlyMine's web.properties file:
The tour link is set in
project.helpLocation property in your mine.properties file. If you don't have help pages set up, link to FlyMine's pages:
Contextual help, the
? on each page#
On each page is a ? that links to help pages. Specify the main URL that this question mark should link to by setting the
project.helpLocation property in your mine.properties file.
If you don't have help pages set up, link to FlyMine's pages:
If the user is on a webpage defined in the properties file, then when they click the help link they will be forwarded to the help section for the page they were viewing.
If the page they are on is not specified in the properties file, they will be forwarded to the first page of the help document.
The context is determined by parsing the URL and taking the name of the current webpage, minus the
.do. For example, go to FlyMine and click on the 'templates' tab, this is the URL:
http://www.flymine.org/query/templates.do. The parsed name of that webpage is "templates".
Below are the mappings from parsed webpage name to anchor names on
the help page.
Your mine's web.properties file is merged with this web.properties file, so the entries you add to web.properties will overwrite the values listed above.
Update these in the classDescriptions.properties file.