Getting started (Was: Documentation)

[Joachim Noreiko <jnoreiko yahoo com>]

--- Steve Willoughby <swilloughby1970 gmail com>
wrote:
> 
> Thanks for the welcome and heads up. I've not worked
> with DocBook, however I
> am comfortable working with both XML and HTML.
> 
> My only experience with CVS has been installation of
> a few apps on my linux
> box, usually following instructions contained in
> text files or via the web.
> I have however built Gnome using jhbuild.

more than I've ever managed! ;)
 
>  As for projects, I am open to working on just about
> anything, though since
> it's been some time since I've been involved in a
> doc project, it may be
> easier if you assigned me some tasks, until I get
> reaquanted with the whole
> process.

Ok. DocBook is fairly evil, but it's just XML with a
scary hat on. Paragraphs are <PARA>, sections are
<SECT1> and so on, and most other things are either
obvious or evil and can be ignored ;) -- or you can
wave and ask for help.

I've filed a simple bug to get you started:

http://bugzilla.gnome.org/show_bug.cgi?id=371042

Here's what you need to do. Any problems, yell, either
here, on the bug, or on IRC.

To get started on this, you'll need to get the source.

http://live.gnome.org/AnonymousCVS has some easy
instructions. (I'm not a fan of the terminal and it's
what I use to remind myself.)

The module is evince, but you can checkout just the
help folder.

Drill down and find evince/help/C/evince.xml. (C is
for the English version of the manual; the others are
the translations.)

Opening this from Nautilus should launch Yelp and
display the manual as a user would see it.
You'll need to also open it in a text editor. Gedit is
fine for this.

I find it's easiest to select few words of the section
title in Yelp and search for it in gedit to quickly
get to where I need to be -- scrolling past all the
evil header crud takes ages and it's hard on the eye
to spot things.

You need to make the changes, save in gedit, then
reload in Yelp (CTRL+R) to see it looks ok.

When you're happy with your changes, make a patch
(http://live.gnome.org/GnomeLove/SubmittingPatches)

And then attach it to the bug on bugzilla.

Hope that's enough to get you started. :)

PS. Remember to do 'reply to all' so the list gets the
email.


Send instant messages to your online friends http://uk.messenger.yahoo.com