Warning, /documentation/digikam-doc/README is written in an unsupported language. File is not indexed.
0001 DIGIKAM HANDBOOK README 0002 ----------------------- 0003 0004 Dependencies 0005 ------------ 0006 0007 kf5doctools-devel 0008 0009 File Structures 0010 --------------- 0011 0012 The substructure of the help files that develop as a tree are created by <chapter> tags. 0013 0014 Respect the file naming convension ordred by chapter name, main section, and title resume, separated by minus. 0015 0016 The digiKam docbook files are shared with the Showfoto handbook. 0017 0018 How to make a screenshot for the manual with Alpha Blending 3D Border 0019 --------------------------------------------------------------------- 0020 0021 - Never use advanced color theme to make screenshots. Always use desktop default color and icon set. 0022 0023 - Use Festival Import to take a shot. Use region selection option to select only 0024 important area. Remove buttons and dialog header to limit image file size. 0025 _ALWAYS use PNG file format to save image to prevent compression artifacts. 0026 0027 - Use script project/screenshot-dropshadow.sh to add border frame around the shot. 0028 This script requires ImageMagick command line tools installed on the system. 0029 0030 The script can be run on a single file or in batch mode. To run in batch 0031 mode, call it like this from within the images folder: 0032 0033 $> screenshot-dropshadow.sh -b png 0034 0035 where <png> is the file extenion to look for. The script can be used 0036 with additional arguments, see '-h' for more options. 0037 0038 PNG screenshot optimizations 0039 ---------------------------- 0040 0041 Since the documentation is very good it is also very demanding in terms of volume, 99% whereof are screenshots. 0042 0043 In order to limit the byte count to the minimum the following command chain shall be used to reduce the png file size. 0044 0045 A factor of 2-4 can be gained. From within the folder where the png reside, use script project/optpng.sh. 0046 This script requires pngnq and optipng command line tools installed on the system. 0047 0048 To process all png files in one step : find *.png | xargs -0 ./makess.sh 0049 0050 Links 0051 ----- 0052 0053 - Converting handbook in PDF or Epub : 0054 0055 https://userbase.kde.org/How_To_Convert_a_UserBase_Manual_to_Docbook#Converting_into_PDF 0056 0057 - Documentation about Docbook format : 0058 0059 https://community.kde.org/Get_Involved/documentation 0060 0061 digiKam team 0062 http://www.digikam.org 0063