Hilfe im Programm integrieren?

[NoGAD]

Hallo,

ich habe versucht, eine kleine Hilfe/Kurzanleitung für ein Programm im Programm selbst zu implementieren.

Mir gefällt aber einiges nicht, was ich versucht habe:

1. Richedit: Hier ist die Formatierung sehr umständlich, gerade, wenn es um längere Texte mit verschiedenen Schriftstilen.

2. Webbrowser: Hier sind unter Delphi 10 nur der IE oder Edge verfügbar, beides nutzen nicht alle.

3. Memo: Formatierungen sind hier einfach nicht möglich.


Hat jemand eine Idee, wie man optisch eine solche Aufgabe angeht?

Lieben Gruß Mathias :-)

[DieDolly]

Zitat:

2. Webbrowser: Hier sind unter Delphi 10 nur der IE oder Edge verfügbar, beides nutzen nicht alle.

Eine integrierte Hilfe hat den Vorteil, dass sie offline verfügbar ist. Aber die Pflege ist u.U. umständlich und schön ist sowas auch nicht.

Ich habe meine Hilfe mittlerweile komplett ins WWW verlegt. Wenn man das selber machen möchte, kann man sich mit Bootstrap austoben oder ein Theme kaufen. Oder man nimmt PrettyDocs https://themes.3rdwavemedia.com/demo...ocs/start.html

Vergiss die lokale Offline-Hilfe, vergiss diese Windows-Hilfs-Dateien und vergiss den integrierten Webbrowser.

[himitsu]

Ist egal.

Wir erstellen mit Help&Manual,
die Hilfe kann im Verzeichnis liegen und direkt in einen integrierten Browser oder im StandardBrowser des Windows oder manuell in einer beliebigen Browser.exe geladen werden

sowohl direkt vom Verzeichnis, von einem Share, aus dem Verzeichnis über einen lokalen TIdHttpServer, über einen TIdHttpServer in einem Service irgendwo im Intranet, aus dem Internet (also über jeden anderen WebServer, egal, ob Lokal, im Netz oder im Web)



Und HTML/JS/CSS/Bilder kann man via res:-Protokoll auch aus den Ressourcen einer EXE/DLL in einen beliebigen Browser laden.

[Uwe Raabe]

Zitat:

Zitat von DieDolly (Beitrag 1532126)

Eine integrierte Hilfe hat den Vorteil, dass sie offline verfügbar ist. Aber die Pflege ist u.U. umständlich und schön ist sowas auch nicht.

Umständlich kommt vielleicht auch auf die verwendeten Tools an. Schön ist aber Geschmackssache.

Ich verwende zur Erstellung auch Help & Manual mit Ausgabe je nach Bedarf als CHM für die kontextsensitive Hilfe, PDF für Handbücher und HTML5/WebHelp für Internet & Co. Bislang bin ich damit immer ganz gut gefahren.

[TurboMagic]

Help & Manual kann sicher auch eine CHM Hilfedatei erzeugen.
Da ist dann alles in einer Datei drin und somit auch leichter mal jemand vorab zu
schicken etc. inkl. Index und Suchfunktion.

Die CHM kann man auch leicht an die eigene Anwendung anbinden. Jedes Hilfethema hat dann
eine numerische IDE und die kann man z.B. beim Edit usw. hinterlegen, dann wird bei F1 Drücken
das entsprechende Thema gleich automatisch aufgerufen.

[himitsu]

Und dann brauchst'e noch eine App zum Anzeigen der CHM.
Wie gut/schlecht das funktioniert sieht man am Delphi.

Wir haben uns ins ApplicationEvents.OnHelp gehängt,
da kann dann entweder im HelpContext etwas angegeben werden,
oder in einer Tabelle, welche über's Netz synchronisiert werden kann (da steht dann Form.ClassName, optional noch ein ActiveComponent.Name und dazu dann ein Dateiname sowie auch der Anker oder eine externe URL, z.B. ins Wiki)

Bei F1 word dann für das ActiveComponent, deren Parents (PageControl/Frame) bis zur Form nach oben zu geschaut, ob irgendwo etwas gefunden wird und das Erste dann angezeigt.

[NoGAD]

Ich beanke mich für eure Ideen. :)

Help & Manual ist mir für mein Hobby leider zu teuer.

Ich habe mich inzwischen doch mit einer Variante über TRichEdit abgefunden, erstelle die formatierte Hilfe in LibreOffice und lade den Code von der RTF-Datei als Stream ins RichEdit. Dann klappt es mit der Formatierung.

Lieben Gruß :-)

[himitsu]

Du kannst HTML-Dateien auch kostenlos mit Delphi erstellen. :stupid:

[NoGAD]

Zitat:

Zitat von himitsu (Beitrag 1532140)

Du kannst HTML-Dateien auch kostenlos mit Delphi erstellen. :stupid:

Ja, das stimmt, geht auch mit einem Text-Editor. Aber ich möchte keine TWebBrowser-Komponente nutzen, lieber direkt im Programm einbinden.

[exon]

Es gibt auch noch HelpNDoc .

Das wird bei uns von den Kollegen genutzt, ich selbst bekomme davon nur die generierte pas-Datei mit den Hilfe-ID-Konstanten.

Scheint günstiger zu sein als das oben empfohlene. Und es gibt auch eine kostenlose Version für den privaten nichtkommerziellen Gebrauch.

gruß exon

[Delphi.Narium]

Die HTML-Anzeige setzt nicht zwingend TWebBrowser vorraus.

Eventuell dahier mal anschauen: HtmlViewer

[DieDolly]

Ein bisschen Eigeninitiative und Bootstrap-Kenntnisse sind kostenlos.

[tomkupitz]

Hallo,

habe im RegEd einen "HTML" Hilfe Hint genutzt und die Texte als Res eingebunden. Die ID ergab sich über welchem Control die Maus war.

Grüße

[NoGAD]

Zitat:

Zitat von Delphi.Narium (Beitrag 1532143)

Die HTML-Anzeige setzt nicht zwingend TWebBrowser vorraus.

Eventuell dahier mal anschauen: HtmlViewer

Vielen lieben Dank!

So etwas habe ich gesucht. :-D

Liebe Grüße!

[TigerLilly]

Da gab´s schon mal nen Thread:
https://www.delphipraxis.net/197075-...erstellen.html

Und das ist auch hilfreich:
https://www.crosshelp.de/

[jziersch]

Ganz interessant ist auch Jekyll

https://jekyllrb.com/

Damit kann man sehr einfach eine statische Website erstellen welche aus markdown Dateien zusammen gebaut wird. Die Installation ist recht einfach und es gibt viele Themes.

Ziemlich gut ist das Theme "Just the Docs" welches eine leistungsfähige Suche mitbringt:

https://just-the-docs.github.io/just-the-docs/

(Die Technologie wird übrigens von GitHub verwendet)

[peterbelow]

Zitat:

Zitat von NoGAD (Beitrag 1532141)

Zitat:

Zitat von himitsu (Beitrag 1532140)

Du kannst HTML-Dateien auch kostenlos mit Delphi erstellen. :stupid:

Ja, das stimmt, geht auch mit einem Text-Editor. Aber ich möchte keine TWebBrowser-Komponente nutzen, lieber direkt im Programm einbinden.

Ich habe für diesen Zweck oft THTMLViewer verwendet. Seit langem freeware, aber halt alt und daher nicht für HTML5-Features verwendbar. Aber für simplen formattierten Text reicht es dicke. Es gibt dazu auch eine Projekt auf Sourceforge das offenbar auf neuere Delphi-Versionen angepaßt wurde und auch bessere Unterstützung für HTML 4 verspricht.

[himitsu]

Delphi kaun auch markdown bearbeiten (nur an der AutoCompletion sollten sie etwas arbeiten), sowie ein WYSIWYG-Editor oder Edit und Preview gleichzeitig sichtbar.
Könnte man dann diese Dateien für einen Hilfegenerator nutzen.
Bzw. aktuell vor allem für die Info-Page, welche man für seine Projekte erstellen und zuweisen kann.

[NoGAD]

Zitat:

Zitat von Delphi.Narium (Beitrag 1532143)

Die HTML-Anzeige setzt nicht zwingend TWebBrowser vorraus.

Eventuell dahier mal anschauen: HtmlViewer

Danke euch allen, Delphi.Narium hat mir schon geholfen, diese Komponente ist unglaublich toll!

Lieben Gruß und ein schönes Wochenende :-)