GNOME Bugzilla – Bug 349011
No mention of drag and drop for opening files in Yelp
Last modified: 2009-06-15 02:57:01 UTC
Here is a patch to add documentation of Yelp's ability to open files by dnd. This could be rather crude, it adds a section, this may not be good - just yell at me if this wants changing ;) Patch to follow. Love, Karderio
Created attachment 69773 [details] [review] add dnd doc
Karderio, thanks for the patch! I don't think I like adding another section as the section depth is already pretty deep at 4. Adding another section makes it 5 deep! Can we just put this section before the command line section? Also, please mention that a docbook file should be dragged - dragging any old XML file will not work. We should probably throw a decent error message if the document isn't docbook, but that's for another bug Other than that, looks good! feel free to commit
Actually, I think I'd shove it under 7.3.3.1. Open a Document, since it's so brief. That section could do with a little improvement too -- the number one way to open a document in yelp is to choose "Help -> Contents" in the application you want help with. Given that's now four ways to open documents, I'd suggest making a bullet list in that section.
Karderio, do you want to make the suggested changes to you patch, or shall I? Let's get this one committed :)
Created attachment 132159 [details] [review] add additional options to opening yelp I agreed with Joachim, and updated opening Yelp and put it in section 7.3.3.1, and did a listitem with the 4 different ways to open Yelp This patch was built against trunk as I did not see a 2.26 branch. Please review and commit as I do not have commit access. Thanks.
Hi Paul, Thanks for the patch. Here are some review comments: * Change "In the application, click" => "In an application, click". "the application" in this context looks like it's referring to the Yelp application. * The term "drag and drop" is discouraged from use in the Style Guide. Use "drag" instead. * "Use the <keycap>F1</keycap> key." Use "Press" instead of "Use" (see the Style Guide). Admittedly, these are just nitpicking, and the patch would be fine as it is.
I just noticed the paragraph below the list: "Alternatively, you may view a particular document by invoking Yelp Help Browser from the command line or dragging files to Yelp. See Opening Specific Documents or more on this." "Opening Specific Documents" covers dragging XML files into Yelp. Maybe that section can be removed now that we have this itemizedlist?
Thanks for the feedback, will update and attach a new patch
Created attachment 132671 [details] [review] Updated patch Per Phil's comments, here is another patch that fixes my errors. Thanks again for the feedback
Patch applied and committed