joachim99@61
|
1 README for the Documentation
|
joachim99@61
|
2 ============================
|
joachim99@61
|
3 Author: Joachim Eibl, 2004-02-22
|
joachim99@61
|
4
|
joachim99@61
|
5 The following text contains some info about how the docs are created.
|
joachim99@61
|
6 It helps me remember certain details. Most users probably aren't
|
joachim99@61
|
7 interested in these things.
|
joachim99@61
|
8
|
joachim99@69
|
9 Docbook references:
|
joachim99@69
|
10 http://i18n.kde.org/doc/markup/index.html
|
joachim99@69
|
11 http://opensource.bureau-cornavin.com/crash-course/index.html
|
joachim99@69
|
12
|
joachim99@61
|
13 Each directory contains the documentation for a different translation.
|
joachim99@61
|
14 The textual information is in the index.docbook of every subdirectory.
|
joachim99@61
|
15
|
joachim99@61
|
16 I wrote the English version in en/index.docbook. The other translations
|
joachim99@61
|
17 were done by the KDE-Internationalization-Team. They are doing a great
|
joachim99@61
|
18 job!
|
joachim99@61
|
19
|
joachim99@61
|
20
|
joachim99@61
|
21 The command meinproc (which is part of KDE) can be used to convert this
|
joachim99@61
|
22 file into HTML.
|
joachim99@61
|
23
|
joachim99@61
|
24 meinproc index.docbook
|
joachim99@61
|
25
|
joachim99@69
|
26 If you prefer everything in one big HTML/Postscript/PDF-file:
|
joachim99@69
|
27 LANG=de_DE meinproc --check index.docbook --stylesheet /opt/kde3/share/apps/ksgmltools2/customization/kde-nochunk.xsl
|
joachim99@69
|
28 (The LANG=de_DE prevents that meinproc writes the file in UTF-8 encoding, which isn't understood by html2ps.)
|
joachim99@69
|
29 Create ps-file:
|
joachim99@69
|
30 html2ps -D -u -n index.html >index.ps
|
joachim99@69
|
31 (For the -D to work add the line "Ghostscript: 1;" in the "package"-section of file /usr/lib/html2ps/html2psrc.)
|
joachim99@69
|
32 Create pdf-file:
|
joachim99@69
|
33 ps2pdf index.ps index.pdf
|
joachim99@61
|
34
|
joachim99@69
|
35 The script createpdfdoc does these steps for all subdirectories.
|
joachim99@69
|
36
|
joachim99@69
|
37 During normal installation on KDE a compressed file is generated:
|
joachim99@61
|
38 meinproc --check --cache index.cache.bz2 index.docbook
|
joachim99@61
|
39
|
joachim99@61
|
40
|
joachim99@61
|
41 As a service for non-KDE-users the en-directory also contains the
|
joachim99@61
|
42 HTML-version of the English documentation.
|
joachim99@61
|
43
|
joachim99@61
|
44 After running meinproc the HTML-files contain some references to files
|
joachim99@61
|
45 in help:/common/ which contains stylesheets and KDE-graphics which make
|
joachim99@61
|
46 the result look much prettier. Because on non-KDE-systems this is not
|
joachim99@61
|
47 available, I placed a copy of these files in doc/en/common.
|
joachim99@61
|
48 To correct the references, I run the following command, which removes
|
joachim99@61
|
49 the "help:/"-part of the references, and only the "common/"-part remains.
|
joachim99@61
|
50
|
joachim99@61
|
51 for i in *.html; do sed -i "s/help:\///g" $i; done
|
joachim99@61
|
52
|
joachim99@61
|
53 (sed-option "-i" means in-place, "s/orig/repl/" is the replacement-command,
|
joachim99@61
|
54 "g" replaces every occurance in the line, not only the first.)
|
joachim99@61
|
55
|
joachim99@61
|
56 The screenshots were made with the English KDE-version and therefore are
|
joachim99@61
|
57 placed in the en-directory. But since for the other translations no new
|
joachim99@61
|
58 screenshots were made yet, they only contain links to the English
|
joachim99@61
|
59 screenshots. These links are created en-bloc with this command. (But
|
joachim99@61
|
60 first you must cd into each subdirectory.)
|
joachim99@61
|
61
|
joachim99@61
|
62 for i in `ls ../en | grep png`; do ln -s ../en/$i $i; done
|
joachim99@61
|
63
|
joachim99@66
|
64 Command to retrieve other translations from cvs:
|
joachim99@66
|
65
|
joachim99@66
|
66 cvs co kde-i18n/subdirs
|
joachim99@73
|
67 #for i in `cat kde-i18n/subdirs`; do cvs co kde-i18n/$i/docs/kdeextragear-1/kdiff3/index.docbook; done
|
joachim99@73
|
68 for i in `cat subdirs`; do wget http://websvn.kde.org/*checkout*/trunk/l10n/$i/docs/extragear-utils/kdiff3/index.docbook -O $i.docbook; done
|
joachim99@69
|
69
|
joachim99@69
|
70 If a new translation is available,
|
joachim99@69
|
71 - create a new directory,
|
joachim99@69
|
72 - copy the index.docbook file there,
|
joachim99@69
|
73 - copy a Makefile.am there and correct it,
|
joachim99@69
|
74 - edit the doc/Makefile.am to include the new subdir,
|
joachim99@69
|
75 - create the links for the graphics,
|
joachim99@69
|
76 - and don't forget to run make -f Makefile.cvs in the top directory.
|
joachim99@69
|
77
|
joachim99@69
|
78
|
joachim99@69
|
79
|
joachim99@69
|
80
|