Hi Matt,

as an addendum for future readers:

Doxygen does not allow dots in identifiers, meaning the following identifiers 
will be considered to be the same:

org.somethingorother.a
org.somethingcompletelydifferent.b

Which is the original rationale for replacing the dots by underscores. Plugins 
created using the Plugingenerator should already have help files following this 
scheme.


In addition the logic for selecting which help page to display is as follows:

F1 is pressed
Check the id of the currently active view (lets say org.myplugin.view.a)
Is there a help page with the id org_mypluying_view_a ? If yes -> display it
If no, check the id of the plugin the view belongs to (lets say org.myplugin)
Is there a help page with the id org_myplugin ? If yes -> display it
If no, display default page

(This part is done by the berryHelpPluginActivator)

Best,
Caspar

Von: Clarkson, Matt [mailto:[email protected]]
Gesendet: Donnerstag, 29. Mai 2014 14:43
An: MITK
Betreff: Re: [mitk-users] Help Pages

Ah... sorted it.

For each plugin, I had UserManual doxygen pages that started with

\page something.separated.by.dots

when it should be

\page something_separated_by_underscores

Thanks

Matt

Begin forwarded message:


From: "Clarkson, Matt" <[email protected]<mailto:[email protected]>>
Subject: Help Pages
Date: 29 May 2014 10:38:07 BST
To: MITK 
<[email protected]<mailto:[email protected]>>

Hi there,

Hopefully an easy question....

When I click on the PointSet Interaction View, and hit F1, I get straight to 
the help page.
When I click on Command Line Modules View, and hit F1, I get an intermediate 
page, and then I have to click through two links ("Related Pages", and then 
"The Command Line Modules View" to get to the help page.

Any ideas what causes this inconsistency?

If I open Help Perspective, the Index page appears to correctly have "The 
Command Line Modules View" at the top level, which, when clicked, goes to the 
right page.

Thanks

Matt

------------------------------------------------------------------------------
Time is money. Stop wasting it! Get your web API in 5 minutes.
www.restlet.com/download
http://p.sf.net/sfu/restlet
_______________________________________________
mitk-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mitk-users

Reply via email to