• R/O
  • SSH
  • HTTPS

tortoisesvn: Dateibaum


Name Größe Rev. Zeit Autor Log Message
dtd r2422 2005-01-14 03:46:20 stefankueng Implement a new project property: tsv...
readme.txt 2.66 k r702 2004-02-04 17:43:26 luebbe.tortoisesvn Improved the doc generation scripts s...
MailingListAnswers.txt 3.5 k r2404 2005-01-12 01:21:48 simonlarge Minor changes to the List Answers.
build.txt 642 r1554 2004-08-17 14:00:15 stefankueng Mention problems when trying to build...
templates r2422 2005-01-14 03:46:20 stefankueng Implement a new project property: tsv...
logo r2422 2005-01-14 03:46:20 stefankueng Implement a new project property: tsv...
source r2500 2005-01-20 21:08:49 luebbe.tortoisesvn merged r2499 (German doc update)
GenDoc.bat 1004 r2243 2004-12-31 03:42:25 stefankueng Make the doxygen generated help files...
ImageStatus.txt 2.13 k r2498 2005-01-20 20:49:33 simonlarge Merge revision 2497
images r2498 2005-01-20 20:49:33 simonlarge Merge revision 2497
issuetrackers.txt 7.55 k r1976 2004-11-26 02:13:40 stefankueng Throw an error when trying to set the...
TortoiseAPI.bat 574 r2243 2004-12-31 03:42:25 stefankueng Make the doxygen generated help files...
API r2422 2005-01-14 03:46:20 stefankueng Implement a new project property: tsv...

readme.txt

HowTo build the docs
====================

Since you are already reading this, I assume that you have succeeded in checking 
out the TortoiseSVN or just the doc sources.

The docs are self contained which means that they contain (almost) everything you need 
(source, dtd, formatting processors, scripts) to build them from scratch.
Building the context sensitive chm help requires some tools from VS.Net to grab the
Help IDs from the source. These tools are not included. You can still build the help 
file to see what it looks like, but pressing F1 in TSVN will not "help" you :-)

Structure:
==========
The most important directories for you are:
source	- contains the XML text source and localized images for each language.
images	- contains the base (english) images for the docs. If you don't localize 
	  your screenshots, these will be used instead.
tools	- contains the tools and the dtd to validate and build the docs.
	  You might want to place your tools directory somewhere else on your 
	  harddisk, if you want to use it to build other docs too. This will 
	  however require tweaking the build scripts.
	  I'd recommend to leave tools\dtd in place, so the source stays 
	  compatible between TSVN doc developers.

source/en - contains the english xml sources.
source/de - contains the german xml sources. 
source/de/images - would contain localized screenshots

The scripts:
============
Two scripts are provided to build the documentation
gendoc.bat 	   - will loop over all known applications and every directory 
		     it finds inside source (so don't place any nonsense there).
source\makedoc.bat - is called from gendoc.bat and will generate html, pdf and chm 
		     docs for the given application and language.
		     makedoc.bat takes three or more parameters where
		     %1 = Target application to build docs for
		     %2 = Target language (as in source/en)
		     %3..%5 = any of [pdf chm html]

"makedoc tortoisesvn de pdf"      will build the pdf docs in directory source/de  
                                  (german) for tortoisesvn. Simple.
"makedoc tortoisesvn en chm html" will build the chm and html docs in directory 
                                  source/en (english)

Translate:
==========
If you want to translate the docs into a new language (assume french), just go ahead and copy the 
entire directory e.g. source/en to source/fr. Now open tortoisesvn.xml and change the line
<book id="tsvn" lang="en"> to <book id="tsvn" lang="fr"> and you're almost done :-)

now you can call "makedoc tortoisesvn fr" and you will see, that the navigation links are
already translated. This is done automatically by the xsl transformation.

Now go ahead and translate the rest.

Cheers
-Lübbe
Show on old repository browser