• R/O
  • SSH
  • HTTPS

tortoisesvn: Dateibaum


Name Größe Rev. Zeit Autor Log Message
logo r13068 2008-06-01 00:32:29 stefankueng Add Photoshop template for the instal...
source r16125 2009-04-10 01:02:54 stefankueng Merge r16124 from trunk: * Compare ag...
UploadDocs.bat 1.22 k r14272 2008-10-12 15:40:09 stefankueng Do not upload the pdf and chm files.
doc.build 20.59 k r14835 2008-12-14 10:06:16 simonlarge Change the build script for the doc s...
issuetrackers.txt 9.78 k r12792 2008-04-27 17:06:07 stefankueng Extend the issue tracker integration ...
images r16077 2009-04-07 06:58:05 miloradspopovic Serbian translation.
xsl r16014 2009-04-03 01:50:08 stefankueng Ignore generated files.
AutolistDoc.txt 2.01 k r10770 2007-09-28 16:30:21 klenin Log time spent building autocompletio...
xml2po.py 24.24 k r15550 2009-03-03 19:44:37 stefankueng Don't print line references for the d...
API r11715 2007-12-31 03:52:12 stefankueng Fix the tsvn:autoprops property: the ...
readme.txt 3.81 k r12612 2008-04-11 05:04:01 jeanmarc Use a bit more real estate for images...
build-zh_CN.txt 7.89 k r9599 2007-05-29 21:07:25 dongsheng.song Update Simplified Chinese translation...
po r16125 2009-04-10 01:02:54 stefankueng Merge r16124 from trunk: * Compare ag...
Screenshots.txt 12.39 k r15748 2009-03-18 05:28:04 kgr Merged r15744-15745 from /trunk * r1...
test r15562 2009-03-05 06:38:40 simonlarge Update the doc test generator followi...
Aspell r15678 2009-03-14 08:30:31 simonlarge Minor corrections to the iBugtraqProv...
doc.build.include 12.41 k r14867 2008-12-16 23:51:06 luebbe.tortoisesvn Forgot to remove comments before comm...
xml2po-modes r11715 2007-12-31 03:52:12 stefankueng Fix the tsvn:autoprops property: the ...
doc.build.user.tmpl 1.62 k r10228 2007-07-25 23:47:28 stannic Doc build system: - "Version" on titl...
backup-TortoiseSVN.net.bat 883 r15543 2009-03-03 17:32:20 stefankueng Add backup script for the website.
MailingListAnswers.txt 4.51 k r6599 2006-05-26 07:45:07 stefan.fuhrmann.1974 fix a typo (may embarrass us in *that...
templates r11715 2007-12-31 03:52:12 stefankueng Fix the tsvn:autoprops property: the ...

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.

Tools needed:
=============

There are some tools for processing the XML input that you need to build the docs.
Scripts and dtd are included, but the executables (formatting processor, microsoft
help compiler, translation tools) have to be installed separately.
You will also need to have a Java Runtime Environment version 1.3.x or above.

tools\fop\		- the fop processor
tools\xsl\		- the docbook xsl files from sourceforge
tools\			- xsl processor, hhc.exe, ...

you can download all the required tools as a zip package from our website:
http://tortoisesvn.tigris.org/servlets/ProjectDocumentList?folderID=616

Note that building the documentation for TSVN version 1.5 and later, you need the
Tools-1.5.zip.

Currently you can build the docs using NAnt. Download a current release from:
http://sourceforge.net/project/showfiles.php?group_id=31650

Please note that having spaces in your directory path will (for the time being)
cause the documentation build process to fail.

To build only the english docs, that's all you need. If you want to build translated
docs as well, you need:
- A Python runtime environment
  (http://www.python.org)
- The Python libxml2 bindings
  (http://users.skynet.be/sbi/libxml-python/)
- Aspell (optional) for spell checking translations
  (ftp://ftp.gnu.org/gnu/aspell/w32/)

For Chm docs you need:
- Microsofts makehm.exe, Part of visual studio, sources available on msdn
- Microsofts html workshop, Binaries available on msdn


Structure:
==========
The most important directories for you are:
source\en - contains the english XML text source.
images\en - contains the base (english) images for the docs. If you don't localize 
	    your screenshots, these will be used instead.
images\*  - contains the localized screenshots for other languages.
po\*      - contains the translations for each language. Best edited with poEdit.
xsl\	  - contains the stylesheets for the doc creation
dtd\      - 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 dtd in place, so the source stays 
            compatible between TSVN doc developers.
            
Building the docs:
==================

NAnt Build:
-----------
A NAnt build script has been provided to build the docs. When doc.build is run for
the first time, the template doc.build.include.template is copied to doc.build.include.

For local customisations, copy the doc.build.user.tmpl file to doc.build.user and
modify that copy to point to the location of the tools on your system.

If you want to build the Japanese docs, you have to copy xsl\ja\userconfig.template.xml
to xsl\ja\userconfig.xml and adjust the path settings to the japanese fonts.

Currently nant supports three targets "all", "clean" and "potfile".
- "all" builds all the docs that are out of date. Runs the target "potfile" too.
- "clean" cleans only the output directory
- "potfile" updates the po template from the source document.

All other parameters are defined in doc.build.include. You can override all settings
in doc.build.user or via the NAnt command line.

Translate:
==========
If you want to translate the docs into a new language (assume french), just go ahead
and copy po\doc.pot to po\fr.po. Start to translate phrases and test your translation
with "TranslateDoc fr" and "makedoc tortoisesvn fr".

Place localized screenshots in images\fr. The file "screenshots.txt" contains some 
instructions on how/where the images have been captured. 

Now go ahead and translate the rest.

Cheers
-Lübbe
Show on old repository browser