Fib-System Dokumentation
Das Hauptdokument der Fib-Dokumentation wurde in LaTeX erstellt. Dies gibt es in verschiedenen Formaten:
- pdf (Größe: 1,1 MB)
- ps (Größe: 2,7 MB)
- dvi (Größe: 1,6 MB)
- html online (in schlechterer Qualität als das pdf-Format)
- LaTeX Quelltexte inklusive Bilder (Größe: 1,9 MB)
Die englische Dokumentation ist eine kurze Version der deutschen Dokumentation. Einige Teile der deutschen Dokumentation wurden bei der englischen Dokumentation weggelassen. Die englische Dokumentation enthält hauptsächlich den wichtigen theoretischen Hintergrund.
Die englische Dokumentation steht zur Verfügung in folgenden Formaten:
- pdf (size: 0,4 MB)
- ps (size: 1,1 MB)
- dvi (size: 0,5 MB)
- html online (in schlechterer Qualität als das pdf-Format)
- LaTeX Quelltexte inklusive Bilder (size: 1,1 MB)
Aufbau der Dokumentation
Der Aufbau der Dokumentation richtet sich nach der Projektstruktur.
Das Projekt ist hierarchisch aufgebaut und gliedert sich in zwei große Komponenten.
Die Komponenten sind die Multimediabeschreibungssprache Fib und der genetische Algorithmus, um effizente Fib-Kodierungen von Multimediaobjekten zu erzeugen.
Hierarchisch ist das Projekt, also auch jeweils die Komponenten, in mehrere Ebenen aufgebaut, wobei eine höhere Ebene auf den unteren aufbaut. Dabei werden die Ebenen immer detailierter.
Davon können folgende Ebenen in der oben augeführten Dokumentation gefunden werden:
- eine Zielbeschreibung für die Komponenten
- Die theoretische Beschreibung der Komponenten: Diese beschreibt die Komponenten, ohne auf deren möglich Realisierung einzugehen.
- Ein Entwurf der Realisierung der Komponenten: Dies ist ein Entwurf für die Implementierung der Komponenten. Er kann von der tatsächlichen Implementierung abweichen und soll nur den allgemeinen Aufbau sowie die Schnittstellen beschreiben. Implementierungen sollten sich nach diesem richten, so dass sie auf einem allgemeinen Standard fußen. Der Entwurf sollte aber Implementierungen genug weitere Freiräume lassen.
- Die Dokumentation der Realisierung: Sie umfasst die Beschreibung der Schnittstellen der konkreten Implementierung. Eine solche Dokumentation ist zur jeweiligen Realisierung zu halten. In der konkreten Realisierung in C++ gibt es eine Dokumentation, die mit Doxygen erstellt wird und im Doxygen Java Stil erfolgt.
- Die konkrete Realisierungen: Auch hier ist eine Dokumentation der Funktionsweise des Quellcodes sinnvoll.
Fib Dokumentation der Implementation
Des Weiteren gibt es eine mit Doxygen generierte Dokumentation der Implementation in Englisch:Copyright
Die Dokumentation des Fib-Systems steht unter der GNU Free Documentation License (GNU FDL)