Using devhelp as a help viewer

2007-12-18T18:46:41Z

Franks: New page: Inspired by Using yelp as a help viewer I wanted to do the same using devhelp [http://developer.imendio.com/projects/devhelp] wxWidgets documentation (and any other document in CHM o...

Inspired by [[Using yelp as a help viewer]] I wanted to do the same using devhelp [http://developer.imendio.com/projects/devhelp]

wxWidgets documentation (and any other document in CHM or HTB format) can be converted to devhelp format using pyhtmlhelp [http://developer.berlios.de/projects/htmlhelp/]

== Get the devhelp launching/searching script ==
Copy the following script into a file named devhelp.sh

<pre>
#!/bin/sh

# Help using Devhelp

if [ ! -n "$1" ]
then
devhelp &
exit
else
devhelp -s $1 &
fi

exit
</pre>

Make the script executable:
<pre>
sudo chmod +rx devhelp.sh
</pre>

== Setup the Help Plugin in Code::Blocks ==
*In Code::Blocks, goto Settings->Environment->Help Files
*Click "Add" and name your new help entry.
*Choose "Yes" when prompted to browse for a help file.
*Browse for the devhelp.sh script that you just created.
*Add " $(keyword)" to the end of path. Example full path: /home/user/devhelps.sh $(keyword)
*Check the boxes for "This is the default help file (shortcut: F1) and "This line represents a full command to be executed"
*Click "Ok"

Now hitting F1 will open up devhelp looking for the word under the cursor.

Help plugin

2007-12-18T18:46:32Z

Franks:

[[Category:Code::Blocks Contrib Plugins]]
{{Infobox_Plugin|
name = Help |
logo = [[Image:help-plugin.png]] |
developer = [[User:Ceniza|Paúl Andrés Jiménez]] |
maintainer = Paúl Andrés Jiménez |
version =
}}

[[Using yelp as a help viewer]]

[[Using devhelp as a help viewer]]

In recent nightly snapshots the help plugin has been greatly enhanced to support MAN pages, too. On Linux they are usually installed anyway, for Windows you might want to download them e.g. from here: http://www.win.tue.nl/~aeb/linux/man

Code::Blocks - User contributions [en]

Using devhelp as a help viewer

Help plugin