GNOME Bugzilla – Bug 329584
No documentation
Last modified: 2009-01-20 17:36:56 UTC
Documentation Section: There is no documentation. There is no documentation to speak of. It would be great to have even a small something to start with. Some suggestions :- Correct version: 1. How to work Gparted with screenshots. 2. Use-case scenarios like :- a. How to make new extended partitions & add it to existing partitions. b. Common mistakes users do & how to avoid them. 3. Authors & contact things Other information:
Well... as stated on the website, you are free to create some. Just start small with one usecase. possible scenarios: - create new partition (with/without filesystem) - resize existing partition - copy partition etc..
+ we need a native english speaker to correct our text :)
I have given Larry access to http://gparted.sourceforge.net/larry/ As soon as these docs mature and Larry is comfortable with the infrastructure we can make them known to the public. By then we can slowly add more usecases until we cover any thinkable situation :)
I think u can safely close it as Larry has made some documentation although don't know if u guys would be bundling his documentation or not. That would be cool.
Created attachment 66705 [details] [review] GParted help using GNOME Yelp (gnome_help_display)
Bart (plors) I've sended you a mail (to gparted@users.sourceforge.net) containing a patch that enables GParted help using GNOME Yelp, but mail.sourceforge.net says: A message that you sent has not yet been delivered to one or more of its recipients after more than 10 hours on the queue on mail.sourceforge.net I attach the patch here and the mail text follows: -------- Hi: I've done an small patch (15KB) that enables GParted help using GNOME Yelp, and an initial version of gparted.omf (for ScrollKeeper) and gparted.xml in C locale (more locales can be done easy). Al of this in a "help" subdir. With the patch, GParted need to depend in libgnomeui-2.0 for the gnome_program_init and gnome_help_display functions (the dependency is already added in the patch), but I think that one dependency isn't a problem and there's no another way to use Yelp. I hope that you find this useful :) (Sorry for my bad english) -------
I'm not very good at reading patches, but as far as I can tell, this isn't using the latest gnome-doc-utils stuff. For example, legal.xml should be an xinclude rather than an xml entity.
I did the patch 4 months ago and the main developer ignored it. Now the patch need a small update but I still think that it is a good begining, considering that at the moment there isn't any type of documentation (in Menu Help->Help I mean).
Hi there, sorry, no ignoring, i simply missed it till today. Somehow i never got any bugmail about this. Atm i'm finishing my studies and am quite busy, but i'll try to look into this asap.
In response to this bug, I have added manual page documentation and committed it to the GNOME repository. In-program documentation is still on the TODO list.
Thank you Diego for the patch. Unfortunately I had forgotten about it until I just came back to update this bug. In my web surfing, I came across the following documentation on "Migrating to GNOME Documentation Build Utilities": http://library.gnome.org/devel/gnome-doc-make/0.12/migrating.html.en I followed these steps to add the appropriate code to GParted to handle DocBook style help. After reviewing your patch, it appears that your patch code did essentially what the above link suggested. Ah well, I'm sure it will not be the last time that code is "re-invented". To remove the dependency on the libnomeui library, I took a cue from the file-roller project. They wrote a show_help_dialog function that does not require this dependency. Now the next step is to create the documentation. Laurent de Trogoff (GParted Project Leader) is going to see if he can migrate his GParted web site documentation to the new DocBook format.
A new application help manual has been written. This new GParted manual and updated Linux man page have been committed to the Gnome SVN repository for inclusion in the next release of GParted (0.4.2). The application help manual can be found on the GParted web site at: http://gparted.sourceforge.net/documentation.php Closing this bug.