Hilfe Dateien erstellen

[Keldorn]

Hallo nochmal

öhhm, was ist eigentlich der aktuell richtige Weg, in eigenen VCL-Anwendungen Hilfe Dateien zu erstellen und einzubinden ?

Was könnt ihr hier empfehlen?

Gruß Frank

[Cronen]

Also zunächst mal zum Thema Hilfedatei erstellen:
Hier gibt es immer wieder neue (unterschiedliche) Formate:

Ich bevorzuge das .chm Formate -> ist nicht mehr das aktuellste wird
aber von Haus aus von Delphi unterstützt, dahe einfachste Einbindung

Zum Erstellen der Hilfedatei gibt es etliche Tools. Für den Anfang könnte ich
zum Einstieg HelpnDoc empfehlen: kostenfreie Version erhältlich, auf deutsch.

Das Einbinden in einer VCL-Anwednung ist denkbar einfach:
Project -> Optionen -> Erscheinungsbild: hier die Hilfedatei (.chm) auswählen.

Der Code wird im Projekt-Quelltetext automatisch generiert.
(ich bin mir nicht mehr ganz sicher aber ich glaube man muss noch manuell
die Unit "Vcl.HtmlHelpViewer" einbinden).
Jetzt reagiert die Anwednung schon auf F1. Jetzt noch den Komponenten den entsprechenden
Wert in der Eingenschaft HelpContext od. HelpKeyword zu weisen (die natürlich in der Hilfedatei definiert sein muss).
Schau dir mal die Hilfe zu TApplication.HelpCommand an.

Noch ein Hinweis:
Eine halbwegs braubare Hilfe für eine auch schon kleinere Anwendung zu erstellen ist zeitlich nicht zu unterschätzen.
Hier liegt die Tücke im Detail. Ein schlechte Hilfe kann den guten Eindruck einer ganzen Anwendung runterziehen.
(siehe dazu vielleicht die Diskussionen hier im Forum über die Hilfe in der Delphi-IDE selbst)

[Keldorn]

super, Danke, ich schaue es mir an

[freimatz]

<Sarkasmus>Der übliche Weg heuzutage ist gar keine Hilfe zu machen.</Sarkasmus>
Beipiele:
Win+E, F1
Outlook/Excel: F1 -> "Die Hilfe funktioniert offline nicht/Es besteht keine Internetverbindung."

[TurboMagic]

Gerade MS scheint lieber an der Infrastruktur zur Darstellung von Hilfe zu arbeiten als an eigentlichen Inhalten.
Das ist ein Problem. Wenn ich z. B. in einem Visio Einstelldialog die Hilfe aufrufe würde ich erwarten, dass für
jede dort aufgeführte Option etwas im Hilfethema steht. Tut es aber oft genug nicht. Und wenn ist es oft so gestelzt
formuliert, dass man nicht richtig versteht, was gemeint ist.

[himitsu]

Zitat von Windows-Hilfe:

"Hilfe und Support" funktioniert nicht, gehen sie in "Hilfe und Support" und suchen sie nach einer Lösung.

Wir lassen uns aktuell von Help&Manual eine HTML-Hilfe generieren. (die und andere Programme können noch mehr, aber reines HTML war das was fast überall geht, ohne dass man was machen muß, auf jedem einzelnen Client-PC)

Die Hilfe ist einmal online (ganz aktuell), aber auch nochmal im Programm.
Also quaso so ähnlich, wie auch im Delphi die OH (lokal) und DocWiki (online).

Da es aber im Intranet extrem beschissene Standardeinstellungen für InternetExplorer/Edge gibt, wo teilweise CSS und JavaScript geblockt wird, weil Intranet nicht als "Sicher" eingestuft ist.
Help&Manual hat dafür eine kleine EXE, die einen lokalen WebServer erstellt und darüber die Hilfe rausgibt, allerdings ist das Ding sicherheitstechnisch eine Katastrophe, weswegen ich in unserem Service einen TIdHTTPServer laufen hab, der einfach aus einem bestimmten Verzeichnis Dateien rausgibt (Abfrage nur Dateiname ohne Pfad erlaubt).

Und im Programm ist bei jeder Form HelpIndex=100 drin, damit die F1-Taste reagiert, auch wenn sonst in der DFM keine Hilfe direkt verlinkt ist.
In einem TApplicationEvents.OnHelp wird dann global drauf reagiert.
* bei aktiver Komponente, deren Parents, bis hin zur Form ... da wo zuerst was gefunden wird, das wird genommen
* entweder HelpKeyword als Link
* und es gibt eine Tabelle in der DB, mit ComponentName+FormClassName zu HilfeDateiName (alternativ eine externe URL, z.B. zu unserem Redmine)
* und dann noch ein Setting
** interne Hilfe -> ein TWebBrowser
** externe Hilfe -> Standardbrowser
** und die URL wählbar -> z.B. im Intranet zum Service oder über's Internet auf unserem WebServer
*** es ginege sogar über das filerotokoll auf ein lokales Verzeichni, bzw. auf ein Netzlaufwerk

[TigerLilly]

Wir haben früher unsere Hilfe sehr detailliert mit Doc-O-Matic erstellt, als CHM, HTML und PDF. Wir sind dann aber dazu übergegangen, in der Hilfe nur mehr Basis-Infos bereitzustellen und Abläufe und tiefergehende Infos in Videos und Tutorials auszulagern. Die zu erstellen macht viel mehr Spaß und bringens tausendmal mehr. Hilfe liest keiner, aber die Videos schaut sich jeder an.

[Rollo62]

Zitat von TigerLilly:

Die zu erstellen macht viel mehr Spaß und bringens tausendmal mehr.

Schön und gut, aber automatisch Doc-o-Matic ubnd manuell Videos erstellen ist ein Unterschied.
Ist das nur intern oder auch für Kunden ?
Wieviel mehr Zeit braucht man für gute Videos die man den Kunden zumuten kann ?

Ich finde Videos auch schön, aber wenn ich ehrlich bin:
- Es ist oft Zeitverschwendung 15min zu schauen, für 15Sek. relevante Info die ich brauche
- Ich kann nicht in Videos suchen
- Ich kann nicht aus Videos Code kopieren
...

Ich finde z.B. den Aufbau und Funktion von Embarcaderos DocWiki (also HTML5) einfach super,
und die sollten wirklich auch die F1-Hilfe direkt auf DocWiki umleiten.

Videos können dann gut ergänzend gemacht werden um Konzepte zu erklären.

[TigerLilly]

Ich rede von Hilfe + Video für Kunden, Endbenutzer unserer Software. Nicht interne Doku von Code. So hatte ich den TE verstanden.

@Videos für Endkunden: Wir schauen, dass die ca. 15 Minuten lang sind und sich auf ein Thema konzentrieren. Wir haben Templates für Intro/Outro und den grundsätzlichen Aufbau. Mittlerweile haben wir schon Routine, so dass die Roh-Erstellung selbst ca. 1 Stunde dauert + das Nachbearbeiten (Schneiden, Tonspur bereinigen, Hervorhebungen, Animationen) ca. 2h.

Wie gesagt, für uns funktioniert das sehr super, die Videos erfüllen auch im Vertrieb eine wichtige Funktion, weil die Interessenten sehen, wie die Software tut + was sie kann.

[Rollo62]

Zitat von TigerLilly:

... ca. 1 Stunde dauert + das Nachbearbeiten (Schneiden, Tonspur bereinigen, Hervorhebungen, Animationen) ca. 2h.