Technical data
8. Documentation for Developers
The entire text documentation may not contain any tabs and has to have a line feed no later
than after 79 characters. This ensures that the documentation can also be read correctly with
an editor without automatic line feed.
Also a documentation in L
A
T
E
X-format is possible, with HTML and PDF versions generated
from it. The documentation of fli4l may serve as an example here. A documentation framework
for required L
A
T
E
X-macros can be found in the package “template”. A brief description is to
be found in the following subsections.
The fli4l documentation is currently available in the following languages: German
(<LANGUAGE> = “deutsch”), English (<LANGUAGE> = “english”) and French (<LANGUAGE> =
“french”). It is the package developer’s decision to document his package in any language.
For the purposes of clarity it is recommended to create a documentation in German and/or
English (ideally in both languages).
Prerequisites for Creating a L
A
T
E
XDocumentation
To create a documentation from L
A
T
E
X-sources the following requirements apply:
• Linux/OS X-Environment: For ease of production, a makefile exists to automate all other
calls (Cygwin should work too, but is not tested by the fli4l team)
• LaTeX2HTML for the HTML version
• of course L
A
T
E
X (Recommended: “TeX Live” for Linux/OS X and “MiKTeX” for Mi-
crosoft Windows) the “pdftex”program and these T
E
X-packages:
– current KOMA-Skript (at least version 2)
– all packages necessary for pdftex
– unpacked documentation package for fli4l, it provides the necessary makefiles and
T
E
X-styles
File Names
The documentation files are named according to the following scheme:
<PACKAGE>_main.tex: This file contains the main part of the documentation. <PACKAGE>
stands for the name of the package to be described (in lowercase letters).
<PACKAGE>_appendix.tex: If further comments should be added to the package, they should
be placed there.
The files should be stored in the directory fli4l/<PACKAGE>/doc/<SPRACHE>/tex/<PACKAGE>.
For the package sshd this looks like here:
$ ls fli4l/doc/deutsch/tex/sshd/
Makefile sshd_appendix.tex sshd_main.tex sshd.tex
The Makefile is responsible for generating the documentation, the sshd.tex-file provides a
framework for the actual documentation and the appendix, which is located in the other two
files. See an example in the documentation of the package “template”.
315