Fib system documentation
The main document of the Fib documentary was created in LaTeX.
The English documentation is a short version of the original German documentation. Some parts of the German documentation are skipped in the English version.
The English version contains mainly the description of the important theoretical background. The description of the source code, will be in the source code, as doxygen comments.
The English documentation is available in several formats:
- pdf (size: 0.4 MB)
- ps (size: 1.1 MB)
- dvi (size: 0.5 MB)
- html online (in a not so good quality as the pdf document)
- LaTeX source code including pictures (size: 1.1 MB)
The German document is available in several formats:
- pdf (size: 1.1 MB)
- ps (size: 2.7 MB)
- dvi (size: 1.6 MB)
- html online (in a not so good quality as the pdf document)
- LaTeX source code including pictures (size: 1.9 MB)
Structure of the documentation
The structure of the documentation is based on the project structure.
The project is structured hierarchically and divided into two major components.
The components are the Fib multimedia description language and the genetic algorithm to produce good Fib encodings of multimedia objects.
The project, including each of the components, is build hierarchically. Whereupon the higher levels are build on the lower levels, while each higher level is more detailed. The documentation includes just the lowest levels.
Of these, the following levels will be found in the above mentioned documentation:
- a target description for the components
- The theoretical description of the components: This describes the components, without considering ther realization.
- Just in the German documentation: A draft for the implementation of the components: This is a blueprint for the implementation of the components. It can vary from the actual implementation and should only describe the general structure and the interfaces. A implementation should be based on this, so that they are based on a common standard. But the design should give implementations enough freedom.
- The documentation of the realization: It includes the description of the interfaces of the concrete implementation. Such documentation must be kept for each realization. In the specific implementation in C++, there's a documentary that will be created with Doxygen and is implemented in the Doxygen Java style.
- The concrete realizations. Again a documentation of how the source code works is useful.
Fib documentation for the implementation
Furthermore, there is a documentation of the implementation generated by Doxygen :Copyright
The documentation of the Fib system is under the GNU Free Documentation License (GNU FDL)