OBO-Edit: Adding to the OBO-Edit help guide: Difference between revisions
(New page: If you would like to add a page to the OBO-Edit help guide then here are some hints. The formatting is easy; you just copy an existing page and add your text into it. You then need to...) |
No edit summary |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:OBO-Edit]] | |||
If you would like to add a page to the OBO-Edit help guide then here are some hints. | If you would like to add a page to the OBO-Edit help guide then here are some hints. | ||
Line 5: | Line 6: | ||
the page name to docs/OBO-Edit.jhm and docs/OBO-EditTOC.xml (and | the page name to docs/OBO-Edit.jhm and docs/OBO-EditTOC.xml (and | ||
indexer.cfg but I think that's just for the JavaHelp tool). Don't | indexer.cfg but I think that's just for the JavaHelp tool). Don't | ||
change toc.html; that is autogenerated by ant. | change toc.html; that is autogenerated by ant ("ant docindex"). | ||
When you | When you run "ant docindex", it creates a directory docs/JavaHelpSearch, which confuses svn the next time you | ||
directory docs/JavaHelpSearch, which confuses svn the next time you | |||
try to update: | try to update: | ||
svn: Directory 'docs/JavaHelpSearch/.svn' containing working copy | svn: Directory 'docs/JavaHelpSearch/.svn' containing working copy admin area is missing | ||
admin area is missing | |||
You can fix this by just removing that directory: | You can fix this by just removing that directory: | ||
Line 18: | Line 17: | ||
rm -rf docs/JavaHelpSearch/ | rm -rf docs/JavaHelpSearch/ | ||
Hooking up the '''?''' button to the appropriate help page is easy. In the | Hooking up the '''?''' button on a component titlebar to the appropriate help page is easy. In the | ||
factory, just override getHelpTopicID with the name of the help page | factory for that component, just override getHelpTopicID with the name of the help page | ||
(WITHOUT the .htm suffix). For example, ConfigurationManagerFactory | (WITHOUT the .htm suffix). For example, ConfigurationManagerFactory | ||
has: | has: |
Latest revision as of 15:23, 30 June 2014
If you would like to add a page to the OBO-Edit help guide then here are some hints.
The formatting is easy; you just copy an existing page and add your text into it. You then need to add the page name to docs/OBO-Edit.jhm and docs/OBO-EditTOC.xml (and indexer.cfg but I think that's just for the JavaHelp tool). Don't change toc.html; that is autogenerated by ant ("ant docindex").
When you run "ant docindex", it creates a directory docs/JavaHelpSearch, which confuses svn the next time you try to update:
svn: Directory 'docs/JavaHelpSearch/.svn' containing working copy admin area is missing
You can fix this by just removing that directory:
rm -rf docs/JavaHelpSearch/
Hooking up the ? button on a component titlebar to the appropriate help page is easy. In the factory for that component, just override getHelpTopicID with the name of the help page (WITHOUT the .htm suffix). For example, ConfigurationManagerFactory has:
@Override public String getHelpTopicID() { return "Configuration_Manager"; }