• Tutorials
• Downloads
• Referenz
• NoPaste
• FAQ

FB-Befehlsreferenz für Devhelp (De, Stand 16.03.2012)

Download

• ZIP-Archiv (1,08 MB)
• FBPSL
• Plattformen:
• FreeBASIC 0.23.0
• Quelltext enthalten
• Angelegt von TJF am 16.03.2012

Screenshot

Bild vergrößern

Bewertung

Bisher keine Bewertung

(Zum Abstimmen auf die Sterne klicken.)

Dieser Download betrifft die Dokumentation für FreeBASIC in einer Version, welche mit dem (GNOME) Hilfe-Browser Devhelp (en) unter LINUX verwendet werden kann.

Natürlich ist die deutschsprachige Befehlsreferenz dieser Seite die erste Wahl, wenn man bei der Programmierarbeit einmal etwas nachschlagen muss. Für die off-line Nutzung stehen dann die deutsche und die englische Dokumentation in Form von .chm-Dateien zur Verfügung.

Die Anwendung von .chm-Dateien ist eher als subobtimal einzustufen. Browser für .chm-Dateien können jeweils nur eine Datei darstellen. Wer in großen Projekten mehrere Bibliotheken verwendet wird schnell feststellen, dass der gleichzeitige Umgang mit mehreren Dokumentationsdateien umständlich ist. Die meisten Entwicklungsumgebungen (IDEs) unterstützen nur ein Hilfesystem. Konfigurierbare IDEs (z. B. Geany) können zwar mehrere Systeme integrieren, jedoch ist der automatische (kontext-sensitive) Aufruf einer Hilfeseite sehr umständlich, wenn in verschiedenen Dokumentationen gesucht werden soll.

Abhilfe schafft hier - zumindest unter LINUX - das Programm Devhelp, das für die GNOME Dukumentationen entwickelt wurde. Diese sind in sogenannte "Bücher" aufgeteilt, die mit gtk-doc erstellt werden. Es können mehrere Bücher installiert und gleichzeitig mit Devhelp durchsucht werden.

Da Devhelp die Seiten aus HTML-Code aufbaut, ist es prinzipiell möglich jede HTML-formatierte Hilfeseite anzuzeigen. Um auch nach Einträgen suchen zu können, wird zusätzlich eine Index-Datei benötigt. Als Schlagworte sind die Titel der Seiten verfügbar. Alle Links innerhalb der Seiten funktionieren so wie in der .chm-Datei. Zusätzlich ist das FB-Logo oben links mit einem Link versehen, der zu einer (neuen) Übersichtsseite verweist.

Der gegenständliche Download enthält die deutsch-sprachige Anleitung für FreeBASIC in der o. g. Version in Form eines Devhelp-Buches mit der erforderlichen Index-Datei. Das Buch kann z. B. parallel zur englischen Anleitung durchsucht bzw. gelesen werden.

Installation (Debian)

Zunächst wird das Programm Devhelp benötigt, das aus den Paketquellen installiert wird:

Dann wird der Archivinhalt (der Ordner 'freebaisc_De') in einen Devhelp-Ordner entpackt, entweder für die lokale Verwendung in den Ordner

oder für die globale Verwendung (alle Benutzer - root Zugriffsrechte nötig) in den Ordner

Nach einem Neustart von Devhelp sollte dann eine neue Sprache 'Fbc' und ein neues Buch 'FreeBASIC Anleitung' erscheinen.

Verwendung in Geany

Wer die Kontext-Hilfe in Geany nutzen möchte erzeugt folgenden Eintrag unter Menü "Bearbeiten -> Einstellungen: Kontextaktion:"

Anschließend veranlaßt Geany bei Aufruf der Kontextaktion (Standard: F12) Devhelp dazu, die Hilfeseite für das Schlüsselwort unter dem Geany-Cursor anzuzeigen. Ggf. wird Devhelp zuvor gestartet.

English

See page at english forum.