[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [TSVN] Submitting Documentation Patch

From: SteveKing <steveking_at_gmx.ch>
Date: 2004-09-09 18:15:09 CEST

David CM Weber wrote:
> Hello all, I'm wanting to submit some documentation patches, and before I
> get started, I wanted to know which documentation file I should work from.
> E.g.: The single-page html file, multi-page html file, other.
>
> I just want to reduce the total amount of work for anyone involved.

Neither of them. Our docs are written in docbook format which we then
can transform into single-page html, multipage html, pdf, htmlhelp, ...

(if you're now scared thinking you don't know docbook at all, don't
worry: it's easier than html! Just look at the xml files and you'll know
what I mean)

So if you want to help us with the docs, check out a working copy of at
least
http://svn.collab.net/repos/tortoisesvn/trunk/doc/

Once you have a working copy of that, you will find some files in there
which explain how you can build the docs yourself and how you should
work on them.
Read first the build.txt file, then the readme.txt.
After that, you can look at the files inside the /source folder which
contains the docs for english(en) and german(de). Edit the files in
those folders with a normal text editor, but make sure that it can
handle UTF8 files (the xml files are UTF8 encoded) and also writes the
BOM's correctly.
Then, after you've edited the files, use TortoiseSVN to create a patch
("create patch") and send that to patches@tortoisesvn.tigris.org where
Lübbe will take it off and apply it.

Stefan

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org
Received on Sat Sep 11 20:18:45 2004

This is an archived mail posted to the TortoiseSVN Dev mailing list.