README 2.11 KB
Newer Older
1
DIGIKAM HANDBOOK README
Gilles Caulier's avatar
Gilles Caulier committed
2 3
-----------------------

4 5 6 7 8 9 10 11
Dependencies
------------

kf5doctools-devel

File Structures
---------------

12
The substructure of the help files that develop as a tree are created by <chapter> tags.
13

Gilles Caulier's avatar
Gilles Caulier committed
14 15 16 17 18 19
Respect the file naming convension ordred by chapter name, main section, and title resume, separated by minus.

The digiKam docbook files are shared with the Showfoto handbook.

How to make a screenshot for the manual with Alpha Blending 3D Border
---------------------------------------------------------------------
Gilles Caulier's avatar
Gilles Caulier committed
20

Gilles Caulier's avatar
Gilles Caulier committed
21
- Never use advanced color theme to make screenshots. Always use desktop default color and icon set.
22

Gilles Caulier's avatar
Gilles Caulier committed
23
- Use Festival Import to take a shot. Use region selection option to select only
24
  important area. Remove buttons and dialog header to limit image file size.
Gilles Caulier's avatar
Gilles Caulier committed
25
  _ALWAYS use PNG file format to save image to prevent compression artifacts.
26

Gilles Caulier's avatar
Gilles Caulier committed
27 28
- Use script project/screenshot-dropshadow.sh to add border frame around the shot.
This script requires ImageMagick command line tools installed on the system.
29

Gilles Caulier's avatar
Gilles Caulier committed
30 31
The script can be run on a single file or in batch mode. To run in batch
mode, call it like this from within the images folder:
Gilles Caulier's avatar
Gilles Caulier committed
32

Gilles Caulier's avatar
Gilles Caulier committed
33
$> screenshot-dropshadow.sh -b png
34

Gilles Caulier's avatar
Gilles Caulier committed
35 36
where <png> is the file extenion to look for. The script can be used
with additional arguments, see '-h' for more options.
Gilles Caulier's avatar
Gilles Caulier committed
37

Gilles Caulier's avatar
Gilles Caulier committed
38 39
PNG screenshot optimizations
----------------------------
Gilles Caulier's avatar
Gilles Caulier committed
40

Gilles Caulier's avatar
Gilles Caulier committed
41
Since the documentation is very good it is also very demanding in terms of volume, 99% whereof are screenshots.
42

Gilles Caulier's avatar
Gilles Caulier committed
43
In order to limit the byte count to the minimum the following command chain shall be used to reduce the png file size.
44

Gilles Caulier's avatar
Gilles Caulier committed
45 46
A factor of 2-4 can be gained. From within the folder where the png reside, use script project/optpng.sh.
This script requires pngnq and optipng command line tools installed on the system.
47

Gilles Caulier's avatar
Gilles Caulier committed
48
To process all png files in one step : find *.png | xargs -0 ./makess.sh
49

Gilles Caulier's avatar
Gilles Caulier committed
50 51
Links
-----
52

Gilles Caulier's avatar
Gilles Caulier committed
53
- Converting handbook in PDF or Epub :
54

Gilles Caulier's avatar
Gilles Caulier committed
55
https://userbase.kde.org/How_To_Convert_a_UserBase_Manual_to_Docbook#Converting_into_PDF
56

Gilles Caulier's avatar
Gilles Caulier committed
57
- Documentation about Docbook format :
58

Gilles Caulier's avatar
Gilles Caulier committed
59
https://community.kde.org/Get_Involved/documentation
Gilles Caulier's avatar
Gilles Caulier committed
60

Gilles Caulier's avatar
Gilles Caulier committed
61
digiKam team
Gilles Caulier's avatar
Gilles Caulier committed
62
http://www.digikam.org
Gilles Caulier's avatar
Gilles Caulier committed
63