Code::Blocks Forums

Developer forums (C::B DEVELOPMENT STRICTLY!) => Plugins development => Topic started by: yop on July 29, 2007, 09:55:19 pm

Title: Help plugin, default keyword and keyword case
Post by: yop on July 29, 2007, 09:55:19 pm

I 've uploaded Patch #2114 (https://developer.berlios.de/patch/index.php?func=detailpatch&patch_id=2114&group_id=5358) in Berlios that changes the handling of the keyword used in the help plugin:

• Added setting for selecting the case of the keyword when replacing
• Added a "default keyword" setting

So what is the reasoning behind all this:
In linux it is impossible to work with html help files using the keyword substitution in a situation where the "keyword" is in different case in the filename than in the code. Let's say in wxWidgets:
wxString -> (some path)/wx2.8-manual_wxstring.html#wxstring, so the keyword has to be turned to lower case. The same is true also for Qt.

As for the default keyword, let's say you want to have the keyword functionality but you also want to view the index/main page of your help files. Now you have to prepare two different inputs: one that is searchable through the keyword and one that points to the index page without any keywords. By adding the default keyword you can browse to your index page if you just have the caret in whitespace and press F1 in your default help file or select Locate in blah blah entry.

Hope you apply it...

Title: Re: Help plugin, default keyword and keyword case
Post by: Ceniza on July 30, 2007, 02:32:45 am

I was going to check it but Berlios won't let me do it.

Title: Re: Help plugin, default keyword and keyword case
Post by: yop on July 30, 2007, 09:10:26 am

Would you like me to upload it here? Berlios works for me now.