Dokumentation

Das KDevelop-Programmierhandbuch: Leitfaden zur C++-Anwendungsentwicklung für das K Desktop Environment (KDE) mit Hilfe der KDevelop-IDE in der Version 1.2
Zurück | Kapitel 13. Der KDE-Dateisystemstandard | Vor

# 13.4. Dokumentation

Mein Vorschlag ist, mindestens eine Seite in

kdedir()/doc/default/HTML/&<;appname&>;/&<;appname&>;.html

für alle KDE-Anwendungen zur Pflicht zu machen. Abgesehen davon steht es jeder Applikation frei, in diesem Verzeichnis jegliche für nötig erachtete Hilfedateien abzulegen.

Anwendungen, die mehr als eine Sprache unterstützen, nutzen dafür kdedir()/doc/&<;lang&>;/HTML/&<;appname&>;/&<;appname&>;.html, wobei ein 'lang'-Verzeichnis für jeden Sprachcode üblich ist. Indem man diese Dateien so anordnet, ist es möglich, Links zwischen den Hilfedateien zweier verschiedener Anwendungen zu setzen, vorausgesetzt, beide unterstützen ein und dieselbe Sprache.

100&%; glücklich bin ich mit dieser von mir vorgeschlagenen Lösung nicht, da man damit im Zweifelsfall nicht auf die Originalsprache zurück zurück greifen kann, wenn keine Übersetzung vorhanden ist.

Zurück | Anfang | Vor
Was bedeutet das für Anwendungsentwickler? | Hoch | Welche Folgen hat das für Bibliotheksentwickler?