Using yelp as a help viewer - Revision history

Rjmyst3 at 23:28, 28 April 2007

2007-04-28T23:28:50Z

Rjmyst3: /* Get the Yelp launching/searching script */

2007-04-28T23:28:04Z

Get the Yelp launching/searching script

Rjmyst3: /* Install the wxWidgets Documentation and integrate into Yelp */

2007-04-28T23:24:25Z

Install the wxWidgets Documentation and integrate into Yelp

Rjmyst3: /* Install the wxWidgets Documentation and integrate into Yelp */

2007-04-28T23:22:20Z

Install the wxWidgets Documentation and integrate into Yelp

Rjmyst3: Using yelp as a wxWidgets help viewer

2007-03-22T00:19:52Z

Using yelp as a wxWidgets help viewer

New page

I wanted to use Gnome's [http://live.gnome.org/Yelp Yelp] as my wxWidgets help viewer with Code::Blocks, so I installed the wxWidgets docs debian package and wrote a shell script to launch yelp to the page for the class under the cursor when I hit F1.

If you'd like to set this up for yourself, follow the steps below:

This applies to [http://www.ubuntulinux.org Ubuntu], and possibly others.

== Install the wxWidgets Documentation and integrate into Yelp ==
Add the following repository to /etc/apt/sources.list:
<pre>
deb http://apt.tt-solutions.com/ubuntu/ dapper main
</pre>

Reload your repositories:
<pre>
sudo apt-get update
</pre>

Install the documentation package:
<pre>
sudo apt-get install wx2.8-doc
</pre>

The wxWidgets docs are now installed and integrated into Yelp.

== Get the Yelp launching/searching script ==
Copy the following script into a file named wxyelpsearcher.sh
<pre>
#!/bin/sh
# wxyelpsearcher.sh
# Launch yelp with a wxWidgets class to search for it

helproot=/usr/share/doc/wx2.8-doc/wx-manual.html/
prefix=wx2.8-manual_
defaultpath=${prefix}classref.html#classref

# If there is no argument, lauch yelp at the wxWidgets alphabetical class reference
if [ ! -n "$1" ]
then
yelp file://$helproot$defaultpath &
exit
fi

# Convert first argument to lowercase, this is the class name
classname=$(echo "$1" | tr 'A-Z' 'a-z')

classpath=${prefix}${classname}.html

if [ -n "$2" ]
then
index=#${classname}$(echo "$2" | tr 'A-Z' 'a-z')
else
index=#${classname}
fi

if [ -e "$helproot$classpath" ]
then
yelp file://$helproot$classpath$index &
else
yelp file://$helproot$defaultpath &
fi

exit
</pre>

Make the script executable:
<pre>
sudo chmod +rx wxyelpsearcher.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 wxyelpsearcher.sh script that you just created.
*Add " $(keyword)" to the end of path. Example full path: /home/rrmulder/wxyelpsearcher.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 when you hit F1 while the cursor is over a wxWidgets class, yelp will be launched and will show the documentation for that class.

@@ Line 7: / Line 7: @@
 == Install the wxWidgets Documentation and integrate into Yelp ==
-Skip steps 1 and 2 if your distro includes the wxWidgets packages (like Ubuntu Fiesty)
+Skip steps 1 and 2 if your distro includes the wxWidgets packages (like Ubuntu Feisty)
 . Add the following repository to /etc/apt/sources.list:
@@ Line 26: / Line 26: @@
 == Get the Yelp launching/searching script ==
 Copy the following script into a file named wxyelpsearcher.sh
 Note that you may need to change the helproot and prefix variables for your distro
 <pre>

@@ Line 9: / Line 9: @@
 Skip steps 1 and 2 if your distro includes the wxWidgets packages (like Ubuntu Fiesty)
-# Add the following repository to /etc/apt/sources.list:
+. Add the following repository to /etc/apt/sources.list:
 <pre>
 deb http://apt.tt-solutions.com/ubuntu/ dapper main
 </pre>
+. Reload your repositories:
 <pre>
 sudo apt-get update
 </pre>
+. Install the documentation package:
 <pre>
 sudo apt-get install wx2.8-doc

@@ Line 26: / Line 26: @@
 == Get the Yelp launching/searching script ==
 Copy the following script into a file named wxyelpsearcher.sh
 <pre>
 #!/bin/sh
@@ Line 32: / Line 33: @@
 helproot=/usr/share/doc/wx2.8-doc/wx-manual.html/
-prefix=wx2.8-manual_
+prefix=wx_
 defaultpath=${prefix}classref.html#classref