Technical data

8. Documentation for Developers
L
A
T
E
X-Basics
L
A
T
E
X is, just like HTML, “Tag-based” , only that the tags are called “commands” and have
this format: \command resp. \begin{environment} . . . \end{environment}
By the help of commands you should rather emphasize the importance of the text less the
display. It is therefore of advantage to use
\warning{Please␣do␣not...}
instead of
\emph{Please␣do␣not...}
.
Each command rsp. each environment may take some more parameters noted like this:
\command{parameter1}{parameter2}{parameterN}.
Some commands have optional parameters in square (instead of curly) brackets:
\command[optionalParameter]{parameter1} . . . Usually only one optional parameter is
used, in rare cases there may be more.
Individual paragraphs in the document are separated by blank lines. Within these para-
graphs L
A
T
E
X itself takes care of line breaks and hyphenation.
The following characters have special meaning in L
A
T
E
X and, if occuring in normal text,
must be masked prefixed by a \: # $ & _ % { }. “~” and “^” have to be written as follows:
\verb?~? \verb?^?
The main L
A
T
E
X-commands are explained in the documentation of the package “template”.
8.3.10. File Formats
All text files (both documentation and scripts, which later reside on the router) should be
added to the package in DOS file format, with CR/LF instead of just LF at the end of a line.
This ensures that Windows users can read the documentation even with “notepad” and that
after changing a script under Windows everything still is executable on the router.
The scripts are converted to the required format during archive creation (see the description
of the flags in table 8.2).
8.3.11. Developer Documentation
If a program from the package defines a new interface that other programs can use, please store
the documentation for this interface in a separate documentation in doc/dev/<PACKAGE>.txt.
8.3.12. Client Programs
If a package also provides additional client programs, please store them in the directory
windows/ for Windows clients and in the directory unix/ for *nix and Linux clients.
8.3.13. Source Code
Customized programs and source code may be enclosed in the directory src/<PACKAGE>/. If
the programs should be built like the rest of the fi4l programs, please have a look at the
documentation of the “src”-package (Page ??) .
316