| 1 | About: |
|---|
| 2 | ------ |
|---|
| 3 | |
|---|
| 4 | Yelp is the default help browser for the GNOME desktop. Yelp provides |
|---|
| 5 | a simple graphical interface for viewing DocBook, HTML, man, and info |
|---|
| 6 | formatted documentation. The name Yelp was suggested by Daniel Lundin. |
|---|
| 7 | Yelp is pronounced the same as the swedish word for 'help'. |
|---|
| 8 | |
|---|
| 9 | |
|---|
| 10 | Requirments: |
|---|
| 11 | ------------ |
|---|
| 12 | |
|---|
| 13 | * GNOME 2.0 ( >= 2.0.2 ) |
|---|
| 14 | * A working ScrollKeeper installation ( > 0.3.6 ) |
|---|
| 15 | * Version 4.1.2 of the DocBook XML DTD |
|---|
| 16 | |
|---|
| 17 | Note that Yelp does not require the DocBook XSLT stylesheets. Yelp |
|---|
| 18 | uses its own custom stylesheets, which are faster and allow better |
|---|
| 19 | integration with Yelp. |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | Reporting bugs: |
|---|
| 23 | --------------- |
|---|
| 24 | |
|---|
| 25 | Bugs should be reported to the GNOME bug tracking system |
|---|
| 26 | (http://bugzilla.gnome.org, product Yelp.) You will need to create an |
|---|
| 27 | account for yourself. |
|---|
| 28 | |
|---|
| 29 | |
|---|
| 30 | Sending patches: |
|---|
| 31 | ---------------- |
|---|
| 32 | |
|---|
| 33 | Please submit your patches to bugzilla.gnome.org. If the patch |
|---|
| 34 | fixes an existing bug, add the patch as an attachment to that bug |
|---|
| 35 | report. |
|---|
| 36 | |
|---|
| 37 | Otherwise, enter a new bug report that describes the patch, and attach |
|---|
| 38 | the patch to that bug report. |
|---|
| 39 | |
|---|
| 40 | Bug reports containing patches should include the PATCH keyword in their |
|---|
| 41 | keyword fields. If the patch adds to or changes the GTK programming |
|---|
| 42 | interface, the API keyword should also be included. |
|---|
| 43 | |
|---|
| 44 | Patches should be in unified diff form. (The -u option to GNU diff.) |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | Help on setting your system up: |
|---|
| 48 | ------------------------------- |
|---|
| 49 | |
|---|
| 50 | A brief note on how to get the docbook stuff to work. |
|---|
| 51 | |
|---|
| 52 | 1) Install Scrollkeeper 0.3.6: |
|---|
| 53 | http://prdownloads.sourceforge.net/scrollkeeper/scrollkeeper-0.3.6.tar.gz |
|---|
| 54 | |
|---|
| 55 | Edit /etc/scrollkeeper.conf to include your $(gnome2_prefix)/share/omf |
|---|
| 56 | directory. For best use in GNOME 2.0, remove all other directories. |
|---|
| 57 | |
|---|
| 58 | Run scrollkeeper-update. |
|---|
| 59 | |
|---|
