Beschreibung

Das Projekt The Cat Helpviewer (tchelp) hat sich zu einer umfassenden Suite für technische Dokumentation entwickelt. Es dient nicht mehr nur der Anzeige, sondern bietet einen vollständigen Workflow zum Erstellen, Verwalten und Portieren von Hilfedateien.

Die Suite besteht aus drei Hauptkomponenten:

  • Der Viewer (tchelpgui): Eine grafische Oberfläche basierend auf Qt 6 für moderne Systeme. Er bietet eine zweigeteilte Ansicht mit Suche, Favoriten-Verwaltung über die "Path"-Datei und HTML-Export.
  • Der Editor (tchelpeditor): Ein neues Werkzeug zum projektbasierten Arbeiten. Er verwaltet .tcproject Dateien, scannt Unterordner automatisch und ermöglicht das komfortable Bearbeiten von Inhalten und Metadaten ohne XML-Kenntnisse.
  • Der Konverter (tchelpconverter): Ein Brückenschlag zwischen den Welten. Dieses Tool konvertiert moderne UTF-8 XML-Projekte in das Legacy-Format (ANSI, 8.3 Dateinamen) für MS-DOS und Windows 3.1.

Besonders hervorzuheben ist die extreme Plattformunabhängigkeit. Während die modernen Tools auf Windows 10/11 und Linux laufen, existieren native, mit Borland C++ kompilierte Versionen für MS-DOS und Windows 3.1. So können Sie eine Dokumentation im modernen Editor schreiben und sie im nächsten Schritt auf einem 386er PC unter DOS lesen.

top

Installation & Einrichtung

Windows & Linux (Fertige Downloads)

Für Windows und Linux stehen fertig kompilierte Versionen bereit. Es ist keine Installation notwendig.

  • Laden Sie das entsprechende ZIP-Archiv für Ihr System herunter.
  • Entpacken Sie den Inhalt an einen beliebigen Ort.
  • Windows: Starten Sie die tchelpgui.exe.
  • Linux: Starten Sie die Binary im Ordner. Stellen Sie sicher, dass die Qt6-Laufzeitumgebung installiert ist.

macOS (Build from Source)

Für macOS muss die Anwendung aktuell selbst kompiliert werden. Laden Sie den Source Code herunter und nutzen Sie CMake in Verbindung mit Qt 6, um das Projekt auf Ihrem Mac zu bauen.

Erster Start & Konfiguration

Beim ersten Start legt die Anwendung automatisch eine Konfigurationsdatei namens "Path" an. Diese Datei steuert, in welchen Ordnern nach Hilfedateien gesucht wird. Sie können diese Datei mit jedem Texteditor bearbeiten.

top

Systemanforderungen & Downloads

Die Voraussetzung für die Ausführung der modernen Versionen ist QT 6. Unter Linux und Mac Systemen einfach über die Paketverwaltung installieren. Für Retro-Systeme sind die Dateien so kompiliert, dass sie ohne zusätzliche Abhängigkeiten laufen. Unter MS-DOS und Windows 3.1/3.11 wurde der Borland C++ 3.1 Compiler verwendet. Die MS-DOS Anwendungen laufen auf jedem DOS kompatiblen System, inklusive FreeDOS.

MS-DOS MS-DOS
Portable .zip Disk Image .img
Windows 3.1 / 3.11 Windows 3.1 / 3.11
Portable .zip Install Disk .img
Win x86 Windows 95-11 (32-bit/x86)
Portable .zip CD Image .iso Disk Image .img
Win x64 Windows 10/11 (64-bit)
Portable .zip
Linux Linux / Unix
Portable .zip
Source Source Code
Disk Image (DOS) .zip Archiv (QT) .iso Archiv (WIN x86) .zip CD Image (WIN X86) .iso Disk Image (WIN 3.1/3.11) .img
top

Befehlszeile & Konverter

Der Viewer (CLI)

Die Anwendung tchelpcli kann direkt über die Konsole gesteuert werden:

  • -lsf [Suchbegriff] : Listet alle Dateien, die den Begriff enthalten.
  • -html [Datei] : Konvertiert eine Hilfedatei nach HTML.
  • -sh : Interaktive Auswahl einer Hilfe aus einer Liste.

Der Konverter (tchelpconverter)

Mit tchelpconverter wandeln Sie Projekte zwischen Formaten um:

  • -f2dos : Konvertiert moderne UTF-8 Dateien in das alte 8.3-Format (DOS/Win16).
  • -p2dos : Exportiert ein .tcproject in eine Dateiliste für den alten Projektmanager.
top