|
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@61
|
9 Each directory contains the documentation for a different translation.
|
|
joachim99@61
|
10 The textual information is in the index.docbook of every subdirectory.
|
|
joachim99@61
|
11
|
|
joachim99@61
|
12 I wrote the English version in en/index.docbook. The other translations
|
|
joachim99@61
|
13 were done by the KDE-Internationalization-Team. They are doing a great
|
|
joachim99@61
|
14 job!
|
|
joachim99@61
|
15
|
|
joachim99@61
|
16
|
|
joachim99@61
|
17 The command meinproc (which is part of KDE) can be used to convert this
|
|
joachim99@61
|
18 file into HTML.
|
|
joachim99@61
|
19
|
|
joachim99@61
|
20 meinproc index.docbook
|
|
joachim99@61
|
21
|
|
joachim99@61
|
22 During normal installation on KDE a compressed file is generated.
|
|
joachim99@61
|
23
|
|
joachim99@61
|
24 meinproc --check --cache index.cache.bz2 index.docbook
|
|
joachim99@61
|
25
|
|
joachim99@61
|
26
|
|
joachim99@61
|
27 As a service for non-KDE-users the en-directory also contains the
|
|
joachim99@61
|
28 HTML-version of the English documentation.
|
|
joachim99@61
|
29
|
|
joachim99@61
|
30 After running meinproc the HTML-files contain some references to files
|
|
joachim99@61
|
31 in help:/common/ which contains stylesheets and KDE-graphics which make
|
|
joachim99@61
|
32 the result look much prettier. Because on non-KDE-systems this is not
|
|
joachim99@61
|
33 available, I placed a copy of these files in doc/en/common.
|
|
joachim99@61
|
34 To correct the references, I run the following command, which removes
|
|
joachim99@61
|
35 the "help:/"-part of the references, and only the "common/"-part remains.
|
|
joachim99@61
|
36
|
|
joachim99@61
|
37 for i in *.html; do sed -i "s/help:\///g" $i; done
|
|
joachim99@61
|
38
|
|
joachim99@61
|
39 (sed-option "-i" means in-place, "s/orig/repl/" is the replacement-command,
|
|
joachim99@61
|
40 "g" replaces every occurance in the line, not only the first.)
|
|
joachim99@61
|
41
|
|
joachim99@61
|
42 The screenshots were made with the English KDE-version and therefore are
|
|
joachim99@61
|
43 placed in the en-directory. But since for the other translations no new
|
|
joachim99@61
|
44 screenshots were made yet, they only contain links to the English
|
|
joachim99@61
|
45 screenshots. These links are created en-bloc with this command. (But
|
|
joachim99@61
|
46 first you must cd into each subdirectory.)
|
|
joachim99@61
|
47
|
|
joachim99@61
|
48 for i in `ls ../en | grep png`; do ln -s ../en/$i $i; done
|
|
joachim99@61
|
49
|
|
joachim99@66
|
50 Command to retrieve other translations from cvs:
|
|
joachim99@66
|
51
|
|
joachim99@66
|
52 cvs co kde-i18n/subdirs
|
|
joachim99@66
|
53 for i in `cat kde-i18n/subdirs`; do cvs co kde-i18n/$i/docs/kdeextragear-1/kdiff3/index.docbook; done |
