1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
****************************************************************
** This build system is used to generate the simple CHM files **
** available for download in many languages on the php.net **
** website. There is an extended CHM generator system in **
** the 'htmlhelp' folder, which is used to build the extended **
** CHM file (only available in English). **
** **
** Both of the systems are used in paralell. **
****************************************************************
BUILDING THE MANUAL IN WINDOWS HELP FILE (.CHM) FORMAT
Note: Where 'lang' is mentioned in this doc, it is the actual
language code (e.g. en) of the manual you are compiling,
not the 'lang' word itself!
With the herein described tools you're able to build the .chm manual
with two options:
a) Simply build the traditional html manual
b) Make a fancy version of the html manual and build it
=======================================================================
WHAT YOU NEED
Microsoft(r) HTML Help Workshop.
You can download it freely at:
http://msdn.microsoft.com/library/en-us/htmlhelp/html/vsconhh1start.asp
You need the complete workshop package install (about 4 Megs).
Of course you need Microsoft(r) Windows to run that software :)
The html manual. You have two alternatives:
a) Download the actual html manual from
http://www.php.net/download-docs.php
and untar the distribution into a directory
b) Build the html manual yourself using Jade and the other
tools needed (look into the HOWTO to see how to build it yourself)
The .chm manual generator files (from cvs.php.net):
make_chm.bat - The only file you need to run yourself.
make_chm.php - Auto toc generator.
To make the fancy manual, additional files are needed:
make_chm_fancy.php - Converts the normal html files to fancy
(good looking) pages
make_chm_index_lang.html - Fancy index. (you find it in phpdoc/lang
dir, if it exists for that language).
make_chm_spc.gif - GIF file needed by the fancy pages.
make_chm_style.css - This adds some good style to html files.
=======================================================================
INSTALLATION
Install Microsoft(r) HTML Help Workshop.
Put the above listed make_chm_* files to one directory.
Open make_chm.bat in a text editor and set the appropriate
environment variables. You need to
- set PHP_PATH to the full path of the CGI php.exe on
your machine (including php.exe).
- set PHP_HELP_COMPILER to the full path of hhc.exe on
your machine (including hhc.exe).
- set PHP_HELP_COMPILE_LANG to the language code of the
actual manual (use the code from cvs.php.net, eg. hu)
- set PHP_HELP_COMPILE_DIR to the directory of the
html manual (eg. ..\html when you build it like mentioned in the howto)
- set PHP_HELP_COMPILE_INDEX to the index filename in
the directory you set above. This used to be manual.html
for a long time, but it seems it is now index.html.
The following variable is only needed for the fancy manual:
- set PHP_HELP_COMPILE_FANCYDIR to the directory name where
the fancy pages will go.
You can decide not to sacrifice any more space for the fancy dir
(it takes ~25% more space than the normal html-manual), and set
this variable to the same as PHP_HELP_COMPILE_DIR. Then your old
HTML files will be rewritten to be fancy ones.
=======================================================================
BUILDING THE MANUAL:
Put the html manual (~2100 files) under the subdir specified above in
PHP_HELP_COMPILE_DIR (eg. html).
Now you need to decide what method to use (normal or fancy).
The fancy manual .chm takes ~240k more space. This is not significant,
as the .chm files are ~2.1Megs in size.
To compile the NORMAL manual, use the 'normal' command line option:
make_chm normal
To compile the FANCY manual, just run:
make_chm
This can take a while, the fancy manual takes ~6 minutes on a
750MHz Pentium with 128MB RAM, running Windows 98SE.
After this process, you will have php_manual_lang.chm...
=======================================================================
The fancy design improvemenets and the .css file is based on
the newsite design(TM) work of Colin Viebrock [colin@easyDNS.com] :)
Written by Gabor Hojtsy (goba@php.net), and adapted by
Thomas Schoefbeck (tom@php.net). Contact them or the phpdoc list
(phpdoc@lists.php.net) if you have any questions or suggestions...
Last modified $Date: 2004/10/31 12:05:46 $
|
