Windows Hilfe erstellen (chm) - Erläuterung der PB Verzeichn

Für allgemeine Fragen zur Programmierung mit PureBasic.
Benutzeravatar
Kurzer
Beiträge: 1617
Registriert: 25.04.2006 17:29
Wohnort: Nähe Hamburg

Windows Hilfe erstellen (chm) - Erläuterung der PB Verzeichn

Beitrag von Kurzer »

Nabend zusammen,

zwei Sachen, die evtl. miteinander zu tun haben:

1) Ich suche nach einem Tool / tutorial, um eine Windows-Hilfedatei für mein Programm zu erstellen. Die Endung für diese Dateien sind .chm. Kann sein, daß es da bereits neuere Formate gibt, ich meine das Format, welches auch unter Win98 darstellbar ist (die PB-Hilfe z.B.). Womit baut ihr Eure chm's?

2) Ich habe im PB-Verzeichnis Library SDK\DocMaker eine DocMaker.exe gefunden, deren Funktion sich mir nicht ganz erschliesst. Wäre das evtl. schon das Tool, welches ich brauche?
In diesem Zusammenhang ist auch das Interessen an den weiteren PB-Unterverzeichnissen aufgekeimt. Gibt es irgendwo eine Beschreibung für was die zusätzlichen Dateien in diesen Ordnern gut sind. Ich bin tendenziell nicht unbeleckt, was das "hinter die Kullissen gucken" angeht, aber da meine Erfahrunen lediglich von den Kulissen des Amiga herrühren (und auch ca. 15 Jahre alt sind), fehlt mir jetzt doch reichlich Grundlageninfo. Z.B. würde ich auch gern mal die von PB erzeugte Assembler-Datei einsehen wollen, die an den NAsm weitergereicht wird. Einfach nur, um wieder mal Assembler-Luft geschnuppert zu haben (auch wenn's kein 680x0 code ist ;-) ).
"Never run a changing system!" | "Unterhalten sich zwei Alleinunterhalter... Paradox, oder?"
PB 6.02 x64, OS: Win 7 Pro x64 & Win 11 x64, Desktopscaling: 125%, CPU: I7 6500, RAM: 16 GB, GPU: Intel Graphics HD 520
Useralter in 2024: 56 Jahre.
Benutzeravatar
Kiffi
Beiträge: 10711
Registriert: 08.09.2004 08:21
Wohnort: Amphibios 9

Re: Windows Hilfe erstellen (chm) - Erläuterung der PB Verze

Beitrag von Kiffi »

Kurzer hat geschrieben:Womit baut ihr Eure chm's?
ich persönlich mit UDO (http://www.udo-open-source.org/).
Allerdings ist hier ein wenig Einarbeitungszeit vonnöten.

Einsteigerfreundlicher sind das Programme wie der HelpMaker (Freeware):
http://www.vizacc.com/gen_download.php

Wenn es um Dokumentationen von PB-Libs oder Includes geht, dann solltest
Du Dir auf jeden Fall auch die Tools von gnozal anschauen:
http://freenet-homepage.de/gnozal/

Grüße ... Kiffi
a²+b²=mc²
Benutzeravatar
Thomas
Beiträge: 893
Registriert: 06.07.2006 19:24
Wohnort: Regensburg
Kontaktdaten:

Beitrag von Thomas »

Hatte damals die gleiche Frage ...

http://www.purebasic.fr/german/viewtopi ... hlight=chm

Jetzt benutze ich HTML Help Workshop:
HTML-Dateien erstellen das zeug dadurchjagen, FERTIG!
v6.00
Benutzeravatar
Kurzer
Beiträge: 1617
Registriert: 25.04.2006 17:29
Wohnort: Nähe Hamburg

Beitrag von Kurzer »

Danke für die links...
HelpMaker schmiert mir unter Win98SE leider ab, gucke mir dann doch das M$ Produkt an (UDO will ich mir (noch) nicht antun ;) .)
"Never run a changing system!" | "Unterhalten sich zwei Alleinunterhalter... Paradox, oder?"
PB 6.02 x64, OS: Win 7 Pro x64 & Win 11 x64, Desktopscaling: 125%, CPU: I7 6500, RAM: 16 GB, GPU: Intel Graphics HD 520
Useralter in 2024: 56 Jahre.
Benutzeravatar
gnozal
Beiträge: 219
Registriert: 04.12.2004 13:01
Wohnort: Frankreich (67)
Kontaktdaten:

Beitrag von gnozal »

What I did for PureFORM.chm :
- build the HTML files with NVU / KOMPOSER
- compile the HTML to CHM with PureHELP Compiler [or directly with MS Help Compiler]
- open CHM file (with TotalCMD plugin [or 7-ZIP])
- edit the HHC file
- recompile CHM (with TotalCMD plugin [or 7-ZIP])

Now, when I have to modify an HTML page :
- edit HTML file with NVU / KOMPOSER
- add to CHM (with TotalCMD plugin [or 7-ZIP])

I hope it's somehow clear enough ...

Note : I use TotalCMD a lot ; with the CHM plugin it can handle CHM files like a regular ZIP archive !
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
Benutzeravatar
Kurzer
Beiträge: 1617
Registriert: 25.04.2006 17:29
Wohnort: Nähe Hamburg

Beitrag von Kurzer »

Der HTML Help Workshop tut seinen Dienst (aus Zeitgründen leider erst 10 Minuten angesehen), hat aber wohl keinen eigenen WYSIWYG HTML-Editor bei. Macht nix, habe eh einen externen Editor wegen meiner Website. Besten Dank also, Eure Beiträge haben geholfen. :allright:

@gnozal: I'm a big TotalCommander fan too.
Could you shortly explain the purpose of the HHC file in a CHM (up to now I had no time to create a helpfile - I took only a quick look on HTML Help Workshop)?
And what is the name of the TC-Plugin you mentioned?

Do I understand correctly? If I have a basic framework in CHM-format, then I simply add modyfied HTML-file(s) into the CHM-file using the TC-Plugin. But if I have to change the structure of the Help (e.g. new links), then I have to use HTML Help Workshop?

Sorry, I have no time this weekend to test this.
"Never run a changing system!" | "Unterhalten sich zwei Alleinunterhalter... Paradox, oder?"
PB 6.02 x64, OS: Win 7 Pro x64 & Win 11 x64, Desktopscaling: 125%, CPU: I7 6500, RAM: 16 GB, GPU: Intel Graphics HD 520
Useralter in 2024: 56 Jahre.
Benutzeravatar
gnozal
Beiträge: 219
Registriert: 04.12.2004 13:01
Wohnort: Frankreich (67)
Kontaktdaten:

Beitrag von gnozal »

Kurzer hat geschrieben:@gnozal: I'm a big TotalCommander fan too.
Could you shortly explain the purpose of the HHC file in a CHM (up to now I had no time to create a helpfile - I took only a quick look on HTML Help Workshop)?
And what is the name of the TC-Plugin you mentioned?
PLUGIN = http://www.totalcmd.net/plugring/chmdir.html
The HHC file defines the 'summary' treegadget content.
Example (from PureFORM.chm) :

Code: Alles auswählen

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<HTML>
<HEAD>
<meta name="GENERATOR" content="Gnozal HelpMaker Pro">
<!-- Sitemap 1.0 -->
</HEAD><BODY>
<OBJECT type="text/site properties">
<param name="Window Styles" value="0x24">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Introduction">
<param name="Local" value="Introduction.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Gadget manipulation">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Create new gadgets">
<param name="Local" value="CreateGadgets.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Move / resize gadgets">
<param name="Local" value="MoveResizeGadgets.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Gadget placement">
<param name="Local" value="GadgetPlacement.htm">
</OBJECT>
</UL>

<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Menus">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The main menu">
<param name="Local" value="MainMenu.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The window menu">
<param name="Local" value="WindowMenu.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The gadget menu">
<param name="Local" value="GadgetMenu.htm">
</OBJECT>
</UL>

<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Windows">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The main window">
<param name="Local" value="MainWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The gadget list">
<param name="Local" value="GadgetListWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The window list">
<param name="Local" value="WindowListWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The gadget properties">
<param name="Local" value="GadgetPropertiesWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The window properties">
<param name="Local" value="WindowPropertiesWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The integrator">
<param name="Local" value="IntegratorWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The code view">
<param name="Local" value="CodeViewWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="The gadget bar">
<param name="Local" value="GadgetBarWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Menu builder">
<param name="Local" value="MenuBuilderWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Toolbar builder">
<param name="Local" value="ToolbarBuilderWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Statusbar builder">
<param name="Local" value="StatusBarBuilderWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Tab order">
<param name="Local" value="GadgetOrderWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Gadget groups">
<param name="Local" value="GadgetGroupsWindow.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Code infusion">
<param name="Local" value="CodeInfusionWindow.htm">
</OBJECT>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value=" Miscellaneous">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Update source code">
<param name="Local" value="SourceUpdating.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Custom gadgets">
<param name="Local" value="CustomGadgetsWindow.htm">
</OBJECT>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Preferences">
<param name="Local" value="Preferences.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="FAQ">
<param name="Local" value="FAQ.htm">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="License">
<param name="Local" value="License.htm">
</OBJECT>
</UL>
</BODY></HTML>
Kurzer hat geschrieben:Do I understand correctly? If I have a basic framework in CHM-format, then I simply add modyfied HTML-file(s) into the CHM-file using the TC-Plugin.
Yes, works for me.
Kurzer hat geschrieben:But if I have to change the structure of the Help (e.g. new links), then I have to use HTML Help Workshop?
Not necessarily. Copy your new HTML files to the CHM and update the HHC file.
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
Benutzeravatar
Kurzer
Beiträge: 1617
Registriert: 25.04.2006 17:29
Wohnort: Nähe Hamburg

Beitrag von Kurzer »

:allright:

Edit: Too bad, the TC Plugin don't run on Win98Se. But HTML Help Workshop will be adequate.
"Never run a changing system!" | "Unterhalten sich zwei Alleinunterhalter... Paradox, oder?"
PB 6.02 x64, OS: Win 7 Pro x64 & Win 11 x64, Desktopscaling: 125%, CPU: I7 6500, RAM: 16 GB, GPU: Intel Graphics HD 520
Useralter in 2024: 56 Jahre.
Benutzeravatar
gnozal
Beiträge: 219
Registriert: 04.12.2004 13:01
Wohnort: Frankreich (67)
Kontaktdaten:

Beitrag von gnozal »

Kurzer hat geschrieben::allright:

Edit: Too bad, the TC Plugin don't run on Win98Se. But HTML Help Workshop will be adequate.
It runs, be sure to download the latest version [there was a Win98 bug in some versions].
For free libraries and tools, visit my web site (also home of jaPBe V3 and PureFORM).
Antworten