]> git.saurik.com Git - wxWidgets.git/blame - utils/HelpHTML/README
symbols.txt is no longer.
[wxWidgets.git] / utils / HelpHTML / README
CommitLineData
cb813dee
KB
1
2HelpHTML : Support scripts for generating external HTML help files
3------------------------------------------------------------------
4
5The scripts in this directory can be used to generate external HTML
6help files for use with wxHTMLHelpControllerBase derived help implemen-
7tations. Currently the only implementation using this is the
8wxExtHelpController class, using an external HTML browser. I hope to
9add a class using a wxWindows-built-in HTML viewer soon.
10
11These viewers need a "wxhelp.map" file in the help directory which
12maps numeric help IDs to relative URLs, having entries like:
13
141000 overview.html;Overview
151010 mainmanu.html;Main Menu
16...
17
18The numeric help ids are used to refer to the help in the application,
19the URL specifies the file to be displayed, relative to the help base
20directory (extended by the locale name if that directory exists) and the
21text behind the semicolon is used to display and search a list of all help
22topics.
23
24html2wxhelp:
25------------
26The html2wxhelp script in this directory allow you to automatically generate
27this file from a set of HTML pages. All you need is to append the numeric ID
28to the section header in the HTML file like this:
29<H1>Overview_1000_</H1>
30
31html2wxhelp will scan all html files in the directory in which it is called
32and find these lines. It will create a wxhelp.map file and strip the help
33IDs from the HTML files. So you should have a backup of the files before
34running it, or a way to regenerate them.
35
36striphelpids:
37-------------
38
39Called with the name of a .tex file, it will strip the help IDs from the file,
40so the IDs do not show up in the printed documentation.
41
42
43How to use them:
44----------------
45
46I use LyX to generate the docs, export the text as LaTeX. I then use
47latex2html to generate the set of HTML pages and html2wxhelp to generate
48the map file from them. Then I run striphelpids on the .tex file before
49generating PostScript documentation from that.
50The whole process can easily be automated with a Makefile. For an example
51of how to do this, see the source of my mail program, available from
52http://www.phy.hw.ac.uk/~karsten/M/
53
54
55Karsten Ballueder <Ballueder@usa.net>
56
57
58