joachim99@61: README for the Documentation
joachim99@61: ============================
joachim99@61: Author: Joachim Eibl, 2004-02-22
joachim99@61: 
joachim99@61: The following text contains some info about how the docs are created.
joachim99@61: It helps me remember certain details. Most users probably aren't 
joachim99@61: interested in these things.
joachim99@61: 
joachim99@69: Docbook references:
joachim99@69: http://i18n.kde.org/doc/markup/index.html
joachim99@69: http://opensource.bureau-cornavin.com/crash-course/index.html
joachim99@69: 
joachim99@61: Each directory contains the documentation for a different translation.
joachim99@61: The textual information is in the index.docbook of every subdirectory.
joachim99@61: 
joachim99@61: I wrote the English version in en/index.docbook. The other translations
joachim99@61: were done by the KDE-Internationalization-Team. They are doing a great
joachim99@61: job!
joachim99@61: 
joachim99@61: 
joachim99@61: The command meinproc (which is part of KDE) can be used to convert this 
joachim99@61: file into HTML.
joachim99@61: 
joachim99@61: meinproc index.docbook
joachim99@61: 
joachim99@69: If you prefer everything in one big HTML/Postscript/PDF-file:
joachim99@69:    LANG=de_DE meinproc --check index.docbook --stylesheet /opt/kde3/share/apps/ksgmltools2/customization/kde-nochunk.xsl
joachim99@69:    (The LANG=de_DE prevents that meinproc writes the file in UTF-8 encoding, which isn't understood by html2ps.)
joachim99@69: Create ps-file:
joachim99@69:    html2ps -D -u -n index.html >index.ps
joachim99@69:       (For the -D to work add the line "Ghostscript: 1;" in the "package"-section of file /usr/lib/html2ps/html2psrc.)
joachim99@69: Create pdf-file:
joachim99@69:    ps2pdf index.ps index.pdf
joachim99@61: 
joachim99@69: The script createpdfdoc does these steps for all subdirectories.
joachim99@69: 
joachim99@69: During normal installation on KDE a compressed file is generated:
joachim99@61: meinproc --check --cache index.cache.bz2 index.docbook
joachim99@61: 
joachim99@61: 
joachim99@61: As a service for non-KDE-users the en-directory also contains the 
joachim99@61: HTML-version of the English documentation.
joachim99@61: 
joachim99@61: After running meinproc the HTML-files contain some references to files 
joachim99@61: in help:/common/ which contains stylesheets and KDE-graphics which make
joachim99@61: the result look much prettier. Because on non-KDE-systems this is not 
joachim99@61: available, I placed a copy of these files in doc/en/common. 
joachim99@61: To correct the references, I run the following command, which removes 
joachim99@61: the "help:/"-part of the references, and only the "common/"-part remains.
joachim99@61: 
joachim99@61: for i in *.html; do sed -i "s/help:\///g" $i; done
joachim99@61: 
joachim99@61: (sed-option "-i" means in-place, "s/orig/repl/" is the replacement-command,
joachim99@61: "g" replaces every occurance in the line, not only the first.)
joachim99@61: 
joachim99@61: The screenshots were made with the English KDE-version and therefore are
joachim99@61: placed in the en-directory. But since for the other translations no new
joachim99@61: screenshots were made yet, they only contain links to the English 
joachim99@61: screenshots. These links are created en-bloc with this command. (But
joachim99@61: first you must cd into each subdirectory.)
joachim99@61: 
joachim99@61: for i in `ls ../en | grep png`; do ln -s ../en/$i $i; done
joachim99@61: 
joachim99@66: Command to retrieve other translations from cvs:
joachim99@66: 
joachim99@66: cvs co kde-i18n/subdirs
joachim99@73: #for i in `cat kde-i18n/subdirs`; do  cvs co kde-i18n/$i/docs/kdeextragear-1/kdiff3/index.docbook; done
joachim99@73: 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: 
joachim99@69: If a new translation is available, 
joachim99@69: - create a new directory, 
joachim99@69: - copy the index.docbook file there,
joachim99@69: - copy a Makefile.am there and correct it, 
joachim99@69: - edit the doc/Makefile.am to include the new subdir,
joachim99@69: - create the links for the graphics,
joachim99@69: - and don't forget to run make -f Makefile.cvs in the top directory.
joachim99@69: 
joachim99@69: 
joachim99@69: 
joachim99@69: