GNOME Bugzilla – Bug 331793
Documentation for Yelp
Last modified: 2006-03-01 04:36:45 UTC
Here is an initial patch I made to include a manual for Yelp. Shaun didn't like the idea of adding a manual to Yelp, but would rather have it in the user guide. Since a lot of the content follows the style of other manuals, I imagine this would have to be reworked to fit into the user guide. Here's the content from original email to gnome-doc-list: ========================================================= I've written a manual for Yelp that uses gnome-doc-utils. Please let me know if it works for you and if you think certain sections need addressed or additional topics need added. Apply the attached patch, and then mkdir yelp/help/C/figures/ and copy the figures there. You can find the figures at http://www.nextreality.net/~smitten/yelp-figures/ This should do the trick: wget http://www.nextreality.net/~smitten/yelp-figures/{yelp_add_bookmark.png,yelp_edit_bookmarks.png,yelp_preferences.png,yelp_window.png} I've also attached the docbook file and the legal stuff if you don't want to apply the patch against CVS HEAD yelp.
Created attachment 59718 [details] [review] Patch against yelp HEAD you need to get the figures in addition to this patch
Created attachment 59719 [details] Here's an archive of the document plus figures. Alternatively to the patch, here is a tar.gz archive of the document and the figures.
I've started working this into the User Guide, under 'Tools and Utilities', as discussed with Shaun on IRC. I've wrapped &app; in <application> tags, and turned the mailing list address into a link. The section on 'Joining the GNOME Documentation Project' is nice. But if we move the section on reporting bugs in GNOME from wherever it currently is into the UG, I think 'Joining the GNOME Documentation Project' should be moved to sit with that, in a general 'Helping GNOME' section. Complete this sentence, for the tiebreaker: "Yelp Help Browser relies on GNOME Documentation Utilities to perform conversion from DocBook to HTML which it uses to" ... ? (Section 5.2)
Yelp docs are in CVS, in the User Guide under 'Tools & Utilities'. Still needs that sentence completing though ;)
Thanks for merging this Joachim. I made some updates and finished the unfinished sentence :-) closing this for good... 2006-02-28 Brent Smith <gnome@nextreality.net> * gnome2-user-guide/C/ChangeLog: * gnome2-user-guide/C/gostools.xml: updates to Yelp section.