FB-Befehlsreferenz für Devhelp (En, 1.00.0rc1)
Download
- TAR.BZ2-Archiv (723 kB)
- FBPSL
- Plattformen:
- FreeBASIC 0.90.1
- Quelltext enthalten
- Angelegt von TJF am 16.03.2012 • Aktueller Dateiupload vom 13.09.2014
- Alle Dateiversionen
Bewertung
Bisher keine Bewertung(Zum Abstimmen auf die Sterne klicken.)
Achtung: diese Internetpräsenz wird nicht mehr gepflegt, sondern aktualisierte Dateien sind jetzt unter https://github.com/DTJF/fb_devhelp verfügbar.
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- oder .html-Dateien zur Verfügung. Problematisch ist dabei das Auffinden der richtigen Seite zu einem Schlüsselwort, welches möglichst durch einen einzigen Tastendruck im Quelltext-Editor erfolgen sollte. Dabei kommen natürlich nicht nur FB Schlüsselworte vor, sondern es können auch solche aus eingebundenen Bibliotheken gewünscht werden. Viele Hilfe-Browser sind damit überfordert, mehrere Stichwortverzeichnisse zu durchsuchen.
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.
Dieser Download enthält also das "Buch" FreeBasic-Help in Devhelp-Formatierung. Die Seiten sind HTML-formatiert und wie gewohnt verlinkt. Zusätzlich verfügt jede Seite über einen Link zur Übersichtsseite (jener im Screenshot dargestellten Seite), welcher über das FB-Logo oben links erreichbar ist. Und natürlich ist die Schlagwortdatei für Devhelp enthalten.
Installation (Debian / Ubuntu)
Zunächst wird das Programm Devhelp benötigt, das aus den Paketquellen installiert wird:
sudo apt-get install devhelp
Dann wird der Archivinhalt (der Ordner 'freebaisc_En') in einen Devhelp-Ordner entpackt, entweder für die lokale Verwendung in den Ordner
~/.devhelp/books
oder für die globale Verwendung (alle Benutzer - root Zugriffsrechte nötig) in den Ordner
/usr/share/gtk-doc/html
Nach einem Neustart von Devhelp sollte dann eine neue Sprache 'Fbc' und ein neues Buch 'FreeBASIC Manual' erscheinen.
Verwendung in Geany
Wer die Kontext-Hilfe in Geany nutzen möchte erzeugt folgenden Eintrag unter Menü "Bearbeiten -> Einstellungen: Kontextaktion:"
devhelp -s '%s'
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. Dabei erfolgt die Suche innerhalb von DevHelp generell (also ohne Beachtung der Groß- bzw. Kleinschreibung), wenn der Suchbegriff aus dem Quelltext nur kleine Buchstaben enthält. Andernfalls wird unter genauer Beachtung der Schreibweise gesucht.
Seit Version 140913... ist das Skript 'calldevhelp' enthalten. Es ermöglicht auch bei Suchbegriffen mit Großbuchstaben generelle Suche in DevHelp. Dazu wird es in der Ordner
~/bin
verschoben (und ggf. mit
chmod +x calldevhelp
ausführbar gemacht. Der Geany-Eintrag unter Menü "Bearbeiten -> Einstellungen: Kontextaktion:" ist in diesem Fall
calldevhelp '%s'