TDAE Hilfe System

[MightyMAC]

TDAE Hilfe System V1.01
geschrieben von Marcus 'MAC' Röckendorf im November 2011

Das GUI wurde mittels PureFORM gemacht (somit nötig wenn man Änderungen an dieser nicht per pedes machen will).
Die verwendeten Icons sind aus dem Fatcow-Hosting-Icons-Paket.

Für die Weiterverwendung des Sourcecodes wird Gnozal's PureRESIZE benötigt!



Übersicht
Da ich mit HTMLHelp von Microsoft irgendwie auf Kriegsfuß stehe (oder ich halt zu blöd dafür bin...) habe ich mir ein eigenes kleines Hilfesystem für mein aktuelles Projekt geschrieben. Es bietet die Möglichkeit HTML-basierte Dateien mit einem Inhaltsverzeichnis und einer Indexliste zu verknüpfen und enthält ausserdem eine Suchfunktion. Zusätzlich zu den eigentlichen HTML-Seiten werden zwei Textdateien zur Strukturierung benötigt. Eine für das Inhaltsverzeichnis und eine für die Indexliste. Beim Starten des Programms ohne Übergabe eines Kommandozeilenparameters werden der Reihenfolge nach folgende Startseiten gesucht wobei die erste gefundene als Startseite verwendet wird: index.htm, index.html, home.htm, home.html. Diese Startdatei muss im gleichen Verzeichnis sein wie das Programm. Alle anderen Seiten können nach belieben in Unterverzeichnissen strukturiert werden.

Bedienung
Die Bedienung des Programms ist - denke ich mal - selbsterklärend.

Features
- Einfache Erstellung eines Hilfesystems
- Inhaltsverzeichnis in Baumstruktur inkl. Icons
- Filterbare Indexliste
- Suchfunktion mit mehreren ODER-verknüpften Schlüsselwörtern
- Gefundene Schlüsselwörter in den Seiten werden markiert
- HTML-Seiten können per Kommandozeile angegeben werden um Seitenaufrufe z.B. aus einer Hostapplikation zu ermöglichen
- Dateien mit der Endung ".htm" und ".html" werden unterstützt

Inhaltsverzeichnis
Eine Textdatei mit dem Namen "HelpContent.txt" enthält das Inhaltsverzeichnis das im Programm als TreeGadget angezeigt wird.

Der Aufbau des Inhaltsverzeichnis hat folgendes Format (Werte werden mit <TAB> getrennt):

Code: Alles auswählen

Iconnummer<TAB>TreeGadget-Level<TAB>Text<TAB>HTML-Seite

- Iconnummer: 0 für Seitenicon ; 1 für Buchicon
- TreeGadget-Level: mit 0 beginnend aufsteigend (wie im TreeGadget halt üblich)
- Text: Der Text der im TreeGadget dargestellt wird
- HTML-Seite: Die HTML-Datei die aufgerufen wird wenn der entsprechende Eintrag im TreeGadget ausgewählt wird


Indexliste
Eine Textdatei mit dem Namen "HelpIndex.txt" enthält eine Liste der Indexeinträge. Die Liste wird nach dem Einladen automatisch alphabetisch sortiert.

Der Aufbau der Indexliste hat folgendes Format (Werte werden mit <TAB> getrennt):

Code: Alles auswählen

Indexeintrag<TAB>HTML-Seite

- Indexeintrag: Der Text wie er in der Indexliste angezeigt wird
- HTML-Seite: Die HTML-Datei die aufgerufen wird wenn der entsprechende Eintrag in der Indexliste ausgewählt wird


Der Sourcecode ist beiliegend und darf von jedem verwendet und beliebig nach eigenen Vorstellungen abgeändert werden. Credits sind nett aber nicht zwingend. Sollte jemand eine sinvolle Erweiterung eingebracht oder einen eventuellen Fehler ausgemerzt haben, bin ich natürlich nicht böse, wenn dieses hier gepostet wird . Solten von meiner Seite aus Änderungen, Bugfixes oder ähnliches vorgenommen werden, werde ich es natürlich an dieser Stelle bekannt geben. Ich habe mal die Hilfedateien für mein aktuelles Projekt dringelassen, damit man mal an einem Beispiel sehen kann wie es aussieht.
Dabei ist auch die PureFORM-Projektdatei zur GUI (.pbf).

Vielleicht hat ja irgendjemand ausser mir Verwendung dafür...

Versionshistorie
V1.0 - Ur-Version
V1.01 - Bug in Suchfunktion behoben (Es wird jetzt nicht mehr in HTML-Tags gesucht)

Viel Spaß damit und freundlichen Gruß
MAC

Downloadlink:
TDAE Hilfe System V1.01 848kB

Homepage:
Hier

PS: Bevor das gemoppere losgeht: Windows only (32-Bit) (XP, vielleicht auch andere, keine Ahnung)

[STARGÅTE]

Oh oh, da ist irgendwo ein Speicherleck in der Suchfunktion.

Nachdem ich etwas gesucht habe und eine Seite des Resultats angeklickt habe, hat sich mein RAM gefüllt bis voll war. Danach hatte die "SearchList.htm" rund 80MB.

Grund ich vermutlich deine "Ergebnis-Einfärbe-Methode", denn blöderweise, wurde bei mir, nachdem etwas eingefärbt wurde, der zusätzliche HTML erneut eingefärbt usw. -> Endlosschleife.
_____

Ansonsten sieht es halt aus wie die Win-Hilfe, was ich nicht ganz verstehe, wenn du mit der auf "Kriegsfuß" stehst, wieso schreibst du sie dann nach? Oder stehst du nur mit dem Help-Editor auf "Kriegsfuß" ?
_____

Die PureBasic-Dateien lassen sich leider nicht ausführen. Zum einen: was ist eine ".pbf" ?
Zum anderen verwendest du vermutlich irgendwelche Zusatz-Libs, denn PureRESIZE_SetGadgetResize() gibts zB nicht.

[MightyMAC]

Du hast recht, ich stehe nicht mit der Windows Hilfe direkt auf Kriegsfuß, sondern mit dem Editor. Hat mich Stunden gekostet ein halbwegs brauchbares Inhaltsverzeichnis hinzubiegen, und da habe ich die ganze Klamotte direkt entsorgt.

Die .pbf Datei ist die dazugehörige PureFORM-Projektdatei (was ich gleich im ersten Post mal hinzufügen werde, ähem). Auch kann man natürlich erwähnen, daß PureRESIZE zur Erstellung verwendet wurde und zum Weiterverwenden des Sourcecodes benötigt wird (weil's so schön in PureFORM eingebettet ist...).

Das mit dem Problem bei der Suche muss ich mir mal ansehen, habe gerade noch einmal exzessiv nach allem möglichen gesucht ohne irgendwelche Probleme.

[STARGÅTE]

Hauptproblem ist: Du suchst den Suchtext in der fertigen HTML.
Somit wird jeder Suchbegriff auch im HTML-Code "gefärbt", und das chaos entsteht.

Hier mal "gebräuchliche" Beispielsuchwörter:

• style
• table
• width

Wenn man dann einfach mal nach "b" suchst, gibs das angesprochene Problem der endlosschleife beim färben.

[MightyMAC]

Jo, recht hast du.

Ich werde morgen mal einbauen nicht mehr in HTML-Tags zu suchen. Danke für den Hinweis.

EDIT: Neue VErsion 1.01 ist online. Bug ist behoben.

[Danilo]

Ich starte TDAEHelp.exe und klicke die Seiten durch...

Code: Alles auswählen

[-] Project Editor
   [-] Fenster
      * 3D View                     ; << geht nicht, zeigt "This program cannot display the webpage"
   [-] Object properties
      * Scripts Seite               ; << geht nicht, zeigt "This program cannot display the webpage"
      * Frame animations Seite      ; << geht nicht, zeigt "This program cannot display the webpage"
      * Skeletal animations Seite   ; << geht nicht, zeigt "This program cannot display the webpage"
      * Lip sync                    ; << geht nicht, zeigt "This program cannot display the webpage"
[-] Script-Referenzhandbuch
   [-] Allgemeine Befehle
      * Includes                    ; << geht nicht, zeigt "This program cannot display the webpage"
      * ChangeCamera                ; << geht nicht, zeigt "This program cannot display the webpage"
...

Sonst sieht es ja ganz gut aus wie es dargestellt wird. Aber wo ist der Editor um eine
eigene Hilfe erstellen zu können? Verstehe ich noch nicht ganz.

[MightyMAC]

Hi Danilo,

das Programm beinhaltet keinen Editor um eine Hilfedatei zu erstellen. Du erstellst deine Hilfeseiten als ganz normale HTML-Dateien. Das Programm bietet dir lediglich die Möglichkeit mit wenig Aufwand deine Seiten in ein kompaktes Hilfesystem zu verpacken, inklusive strukturiertem Inhaltsverzeichnis, Indexliste und Suchfunktion.

Die Seiten die nicht angezeigt werden sind schlicht und einfach nicht vorhanden. Das liegt daran, daß das was als Seiten dabei ist, die angefangene Dokumentation meines aktuellen Projekts TDAE ist, für welches ich dieses Hilfesystem geschrieben habe. Ich habe da jetzt keinen Wert auf Vollständigkeit gelegt, sondern habe die Sachen dabei gepackt die fertig sind, damit man direkt mal was sieht wenn man die EXE startet. Die beiligenden Demonstrationsdateien sind also quasi "Work-in-Progress". Wenn du dir die Dateien "HelpContent.txt" (Inhaltsverzeichnis) und "HelpIndex.txt" (Indexliste) ansiehst, kannst du sehen, wie der Aufbau der Dateien und somit des Hilfesystems ist. Weitere Erklärungen findest du in der beiliegenden Beschreibung.

Ich hoffe ich konnte Klarheit schaffen, ansonsten einfach nochmal nachfragen.

Gruß
MAC

[Danilo]

das Programm beinhaltet keinen Editor um eine Hilfedatei zu erstellen.
[...]
Ich hoffe ich konnte Klarheit schaffen, ansonsten einfach nochmal nachfragen.

Yo, Danke. Mein Fehler, ich dachte es wäre mit Editor.