Format der Hilfedateien?

[smart]

Hallo Alle,

Thema Hilfedateien, wie ist das heutzutage, in welchem Format erstellt man Hilfe-Dateien? Im PDF – Format oder benutzt man noch das chm – Format. Wie macht Ihr das, was benutzt Ihr so?

[WM_CLOSE]

Ich persönlich verwende gerne HTML, das ist so universiell, dass man es in Word importieren, als pdf exportieren oder später in ein chm file kompillieren kann. Eventuell sogar eine Online-Hilfe?

Ich würde sagen, für umfangreiche Programme ist chm das üblichere Format, für kleine Tools eher ein pdf.
Der Vorteil bei chm ist, dass wenn man es richtig macht, der User ganz einfach mit dem Index durchblättern kann.
Bei PDF muss er das ganze Dokument durchackern.

ABER: Je nach Programm kann es auch wichtig sein die Anleitung auch ausdrucken zu können. (daher eher PDF).

PS: Das chm-Format ist eigentlich recht aktuell. Es wird sogar von M$ empfohlen.

[shmia]

Zitat:

Zitat von WM_CLOSE (Beitrag 1080502)

PS: Das chm-Format ist eigentlich recht aktuell. Es wird sogar von M$ empfohlen.

Na ja, es ist eher so, dass Microsoft das gesamte Hilfesystem von Windows verbockt hat.
Mit weitreichenden Folgen auch für andere Softwarehersteller!
Zuerst gab es das *.hlp Format, danach kam *.chm-Format.
Und dann gab MS das Winhelp-Format heraus.
Einige Zeit später hat MS dieses Format wieder zurückgezogen.
Borland Delphi 2007 hat z.B. auf diesem Winhelp-Format aufgesetzt mit der Folge, dass die Online-Hilfe absolut unbrauchbar wurde.

Ab Windows Vista wurde dann Assistance Platform Help (AP Help) eingeführt.
Auf Vista ist aber auch der Support für *.hlp und *.chm entfernt und muss nachinstalliert werden.
Insgesamt ist die Lage bei den Hilfesystemen ein unhaltbarer Zustand, weshalb viele Entwickler auf PDF oder HTML-Seiten ausweichen.
Als Online-Hilfe sind diese Formate aber eigentlich ungeeignet.

Da Winhelp ein Rohrkrepierer war und AP Help irgendwie noch nicht richtig angekommen ist, ist in der Tat das CHM-Format z.Zt. noch die beste Wahl.

[Bernhard Geyer]

Zitat:

Zitat von shmia (Beitrag 1080506)

Auf Vista ist aber auch der Support für *.hlp und *.chm entfernt und muss nachinstalliert werden.

Gilt nur für *.hlp. CHM läuft immer noch (wenn lokal gestartet) Problemlos.

Bei Netzwerkstart muss man es (im Hintergrund) in lokales Verzeichnis kopieren damit es funktioniert.

[DeddyH]

Zitat:

Zitat von Bernhard Geyer (Beitrag 1080510)

Bei Netzwerkstart muss man es (im Hintergrund) in lokales Verzeichnis kopieren damit es funktioniert.

Oder einen Registry-Hack anwenden.

[Sharky]

Zitat:

Zitat von Bernhard Geyer (Beitrag 1080510)

... Bei Netzwerkstart muss man es (im Hintergrund) in lokales Verzeichnis kopieren damit es funktioniert.

Oder, alternativ, die Regestry so ändern das die CHM auch aus einer anderen als der lokalen Zone wieder geladen werden.

Daddy war schneller

[Bernhard Geyer]

Zitat:

Zitat von Sharky (Beitrag 1080513)

Oder, alternativ, die Regestry so ändern das die CHM auch aus einer anderen als der lokalen Zone wieder geladen werden.

Diesen Hack kenn ich. Jedoch wird unsere Anwendung oft per XCopy auf Serverlaufwerke kopiert und läuft dann ohne Admin-Rechte so das ich diese Lösung nicht anwenden kann.

[Bummi]

ich schließe mich WM_CLOSE an, in unserem Fall ist es meist gewünscht dass die Fachabteilungen der Kunden die Hilfe anpassen können, hier ist HTML das flexibelste und schnellste (und mächtigste Konzept)

[DelphiMini]

Hi smart!

Oft werden ja .hlp oder .chm Dateien verwendet,
aber ich schließe mich WM_CLOSE wie Bummi an.
Denn HTML ist, wie von WM_CLOSE beschrieben, gut einsetzbar.

Zitat:

ABER: Je nach Programm kann es auch wichtig sein die Anleitung auch ausdrucken zu können. (daher eher PDF).

Allerdings kann man HTML auch drucken,
indem man eine neue Form für die Hilfe nimmt und dort einen TWebBrowser platziert,
mit dem man es dann ausdrucken kann. Zusätzlich kann man dann auch Sonderfunktionen einfügen (z.B.: suchen). :thumb:

[BUG]

Zu dem Thema evtl. interessant: http://www.delphipraxis.net/147569-l...erstellen.html

[shmia]

Zitat:

Zitat von DelphiMini (Beitrag 1080549)

aber ich schließe mich WM_CLOSE wie Bummi an.
Denn HTML ist, wie von WM_CLOSE beschrieben, gut einsetzbar.

Besser als nichts, aber weit von einer perfekten Lösung entfernt.
Eine Hilfedatei sollte platzsparend (also komprimiert) und alles in einer Datei enthalten.
Beides ist für normales HTML nicht erfüllt.
Wir haben z.B. eine Software, bei der über 250 HTML-Dateien als Hilfe beiliegen (in Deutsch und Englisch).
Installiert man beide Sprachen, dann braucht das auf der Platte über 200 MB :shock:
Microsoft war mit ihrem HTMLHelp (*.chm) im Prinzip schon auf dem richtigen Weg.
Eine CHM-Datei ist ein komprimierter Kontainer für HTML-Dateien.
Nur leider haben sie's verbockt und WinHelp2 erfunden :wall:

[WM_CLOSE]

@shmia: HTML hat aber den Vorteil, dass ich es bei Bedarf schnell in jedes beliebige Format umwandeln kann. (Bei Auslieferung der SW)
Dass chm bei größeren Projekten vielleicht diverse Vorteile bietet streitet ja niemand ab.

ABER: 200MB?? Sind da vielleicht viele große Bilder drin? Oder ist jede einzelne Seite mit einem eigenen Hintergrundbild belegt?
Bei mir hat eine Seite mit 3 Screenshots (800x600) im JPEG Format Max 0,5 MB
Das sind ja fast 1MB für jede seite!

Das mit den vielen Dateien ist aber tatsächlich ein Problem.

[Florian Hämmerle]

Ich gewöhn mir gerade an, meine Dokumentationen (auch wenn sie nicht sehr groß sind) mit Latex zu erstellen. Da kann man in viele Formate exportieren und alle zur Verfügung stellen.

[Namenloser]

LaTeX ist eine nette Sache, nutze ich auch gerne, für Dokumentationen habe ich es aber noch nicht eingesetzt (wobei ich sowieso bisher erst eine einzige geschrieben habe). Die Idee gefällt mir aber gut.

Hat jemand vielleicht ein kleines Beispiel, wie so eine mit LaTeX erstellte und ins chm-Format konvertierte Dokumentation aussieht?

[Florian Hämmerle]

Das kannst du über ein Stylesheet alles schön regeln :)

hab auf die schnelle auch kein Beispiel gefunden

[BUG]

Zitat:

Zitat von BUG (Beitrag 1080559)

Zu dem Thema evtl. interessant: http://www.delphipraxis.net/147569-l...erstellen.html

Obwohl man das wohl noch optimieren kann.

[Namenloser]

Zitat:

Zitat von Florian Hämmerle (Beitrag 1080610)

Das kannst du über ein Stylesheet alles schön regeln :)

Ist das so? Die Formatierungen von ins HTML-Format konvertierten LaTeX-Dokumenten sind nach meiner Erfahrung meist hardcoded. Aber es gibt ja auch verschiedene Converter, vielleicht machen manche es besser...

[Florian Hämmerle]

Ich denke schon, zumindest das von BUG verlinkte Beispiel - Dort werden classes verwendet.

mfg Florian

[smart]

Warum nimmt man zB. nicht eine Datenbank mit kleine Maske als Hilfe Datei?

[WM_CLOSE]

Weil das den eine Eigen-Bastellösung wäre.
In vielen Fällen würde es dem Anwender besser gefallen,
aber bis das dann richtig läuft und schön aussieht,... vergeht teure Zeit.
Man verwendet also das, was schon die Leute vor einem gebastelt haben (also schon fertig ist).

[Florian Hämmerle]

Zitat:

Zitat von smart (Beitrag 1080622)

Warum nimmt man zB. nicht eine Datenbank mit kleine Maske als Hilfe Datei?

Wenn du so etwas mit entsprechendem Editor und genügend Features bereitstellst und für Aktualität sorgst, werden es manche vielleicht verwenden.

[smart]

Sorry, drann hatte ich nicht gedacht.

[Florian Hämmerle]

Zitat:

Zitat von smart (Beitrag 1080629)

Sorry, drann hatte ich nicht gedacht.

Die Idee an sich ist ja nicht schlecht finde ich. Ich hab schon einmal mit so etwas begonnen, aber es beansprucht wirklich viel Zeit. Vielleicht führe ich das Projekt in einer etwas ich-hab-wieder-mal-etwas-mehr-Zeit weiter und vielleicht wird es ja auch etwas ;)

[Namenloser]

Könnte man schon verwenden, aber mit HTML und Co. ist man denke ich flexibler was z.B. Bilder und so’n Kram angeht. Außerdem sollte man imo im Zweifelsfalle man eine etablierte Lösung einer Bastellösung vorziehen.

[Florian Hämmerle]

Es spricht ja nichts dagegen, HTML auch im eigenen Format zu verwenden ;)

[smart]

Ihr habt natürlich Recht. Mir gefällt nur nicht die vielen Dateien die bei Html kauskommen.

[Florian Hämmerle]

Wie man die Daten dann zusammenpackt. Komprimierung etc. bleibt dir dann ja überlassen :)

[Namenloser]

Eventuell könnte man ja XSLT verwenden, aber ich glaube kaum, dass der „CHM-Browser“ damit umgehen kann, oder? Für eine einfache (nicht kompilierte) HTML-Hilfe wäre es vielleicht trotzdem eine Idee.

[Garfield]

Zitat:

Zitat von WM_CLOSE (Beitrag 1080592)

Das sind ja fast 1MB für jede seite!

shmia hat 250 HTML-Dateien in Deutsch und Englisch, also 500. Macht 0,4 MB je Seite.

[Namenloser]

Das ist schon viel – zum Vergleich: diese Seite ist gerade mal 13kb groß.

[WM_CLOSE]

@NamenLozer: bist du dir sicher? bei mir hat die Seite insgesamt 720 KB!

Aber die Seite ist auch recht aufwändig, es würde auch wesentlich kleiner gehen ohne die ganzen Foren-Features

[Garfield]

Zitat:

Zitat von NamenLozer (Beitrag 1080712)

Das ist schon viel – zum Vergleich: diese Seite ist gerade mal 13kb groß.

Ja, ne, is klar.

Textdatei 6 kB, HTML mit Bildern etwas über 400 kB und als *.mht 514 kB.

[Namenloser]

Zitat:

Zitat von Garfield (Beitrag 1080748)

Textdatei 6 kB, HTML mit Bildern etwas über 400 kB und als *.mht 514 kB.

Die Bilder sind aber nur einmal zentral gespeichert, und nicht auf jeder Seite neu, deshalb vernachlässigbar.

[nici]

Zitat:

Zitat von Florian Hämmerle (Beitrag 1080637)

Wie man die Daten dann zusammenpackt. Komprimierung etc. bleibt dir dann ja überlassen :)

a) mhh, das frag ich mich auch immer wieder.


ich habe noch einige alte kommerzielle Programme die eine pure HTML-Hilfe dabei haben.
Die braucht ordentlich Platz (verschwendet die ganzen Cluster).

Da kam ich mal auf die Idee, die HTMLSeiten mit dem Compiler als CHM zu erstellen. Leider haben dann die Unterseiten nicht mehr perfekt funktionniert. Wahrscheinlich hab ich was falsch gemacht.
Denn die HTML-Dateien hatten eine eigene Suche in den HTMLdateien und Frames (links die Navigation und Suche und rechts die InfoSeiten)



b) Dabei.. á propos PDF speichern
was ist denn eigenltich mit der ehemaligen PDF-Ausgabe der Threads dieses Forums? Gibt es das noch? oder ist das Vergangenheit?


c) Mhh, also ich finde was sprich dagegen CHM-Dateien zum schnellen Suchen und ein ordentlich strukturiertes PDF-Handbuch mit dem Programm gleichzeitig auszuliefern ?
nur Onlinehilfen find ich schlecht, weil man dazu immer einen Netzzugang braucht.

[shmia]

Zitat:

Zitat von Garfield (Beitrag 1080647)

shmia hat 250 HTML-Dateien in Deutsch und Englisch, also 500. Macht 0,4 MB je Seite.

Die HTML-Seiten wurden mit WinWord exportiert und enthalten jede Menge Müll. (ständige Wiederholungen der Schriftart,...)
Hab' nicht ich gemacht; die Kollegen aus der Nachbarabteilung halt.

[mschaefer]

Inzwischen habe ich mich schlicht für pdf entschieden, das vom Programm mit der jeweiligen Seite aufgerufen werden kann. Dann ist bei der Installation der Acrobat-Reader dabei. Ist sicherlich nicht der Weisheit letzter Schluß, aber aus Zeitgründen ist so Hilfe und Dokumentation verschmolzen.

Grüße in die Runde // Martin

[Garfield]

Zitat:

Zitat von NamenLozer (Beitrag 1080815)

Die Bilder sind aber nur einmal zentral gespeichert, und nicht auf jeder Seite neu, deshalb vernachlässigbar.

Woher weißt Du dass?

Du gehst von einer Texthilfe aus mit wenig Bildern aus. Aber was ist wenn sie stark illustriert ist?

Zitat:

Zitat von shmia (Beitrag 1080865)

Die HTML-Seiten wurden mit WinWord exportiert und enthalten jede Menge Müll. (ständige Wiederholungen der Schriftart,...)
Hab' nicht ich gemacht; die Kollegen aus der Nachbarabteilung halt.

Auch die Browser scheinen die Seiten unterschiedlich abzuspeichern. Dürfte eine Menge Arbeit sein, das zu optimieren.

[Namenloser]

Zitat:

Zitat von Garfield (Beitrag 1080958)

Zitat:

Zitat von NamenLozer (Beitrag 1080815)

Die Bilder sind aber nur einmal zentral gespeichert, und nicht auf jeder Seite neu, deshalb vernachlässigbar.

Woher weißt Du dass?

Du gehst von einer Texthilfe aus mit wenig Bildern aus. Aber was ist wenn sie stark illustriert ist?

Nene, ich meinte die DP-Seite. Klar kann es sein, dass die Hilfe stark illustriert ist, aber bei 0.4MB pro Seite erschien mir trotzdem viel. Selbst in gut bebilderten Hilfen beträgt der Anteil der Seiten, die tatsächlich Bilder enthalten, erfahrungsgemäß nur einen Bruchteil der gesamten Anzahl.