Re: Cheese Manual

["Joshua Henderson" <joshhendo gmail com>]

Thanks for your reply.

I have joined the cheese-list :).

I have started to edit the DocBook XML document downloaded from SVN. Attached is a bit of what I have done (I just copied the first bit of what I have done to it to see how it works). How would I convert it to something where I can see what it would look like what the end user would see? I have used docbook2odf to see if it works in ODT, and it seemes to work fine what I have done so far, so I will continue with that.

Once it is all in, I will work on editing it, cleaning it up, getting rid of stuff that isn't needed and making it more consistant with how manuals are written in GNOME, and then I will submit the task to the location specified on the issue page.

Any feedback would be great. Thanks, Josh.

On Jan 11, 2008 12:59 PM, Jaap A. Haitsma <jaap haitsma org> wrote:

Hi Joshua,

Thanks I think it's a very good start what you've done. In SVN you can
find of empty manual of cheese that's the format you should use. A tip
I have for you is also to look at manuals of other programs like eog
or gnome-power-manager. You can see how docbook works and also how
manuals in GNOME are usually made

Concerning the text you have now. The section on how to install cheese
should not be in the manual, because
1) it's distro specific
2) in general you won't have the manual installed if you don't have
cheese installed.

Jaap

BTW I cc'd the cheese list. Please join the list and ask any questions
you might have about cheese

On Jan 11, 2008 2:22 AM, Joshua Henderson <joshhendo gmail com> wrote:
> Hi Jaap,
>
> I am just emailing about the task on GHOP:
> http://code.google.com/p/google-highly-open-participation-gnome/issues/detail?id=81
> ; I have attached a copy of the manual that I have made so far. Currently,
> it is only in a text document, but once I have finished writing it, I will
> put it in Doc Book (would you be able to let me know what kind of DocBook
> file, for example, Book or Article?).
>
> Currently what I have as well just documents version 0.2.1, as that is what
> I had installed, but I am compiling the most recent version from svn right
> now and will adjust the manual to suit that.
>
> Would you be able to go through it and let me know how I am going? For
> example, I just want to know if I am going completely wrong and should
> really start again; it is ok, but many things need to be changed or if only
> small changes need to be made? I am hoping the the middle one, because I am
> not entirely sure how to set out everything that is covered.
>
> Thanks for your help,
> Josh
>

Attachment: CheeseDoc - 20080113.tar.gz
Description: GNU Zip compressed data