goba Sun Jan 14 06:04:56 2001 EDT
Modified files:
/phpdoc make_chm.README
Log:
Get rid of tabs...
Index: phpdoc/make_chm.README
diff -u phpdoc/make_chm.README:1.1 phpdoc/make_chm.README:1.2
--- phpdoc/make_chm.README:1.1 Sun Jan 14 05:59:11 2001
+++ phpdoc/make_chm.README Sun Jan 14 06:04:56 2001
@@ -12,9 +12,9 @@
You have two options to build the .chm manual:
a) Use only the traditional DSSSL made html manual
- b) Use a fancy html manual (converted from the
- DSSSL made html)
-
+ b) Use a fancy html manual (converted from the
+ DSSSL made html)
+
In both cases you need Microsoft(r) HTML Help Workshop.
You can download it freely at:
http://msdn.microsoft.com/library/tools/htmlhelp/chm/hh1start.htm
@@ -24,30 +24,30 @@
Now you need the html manual. You have two alternatives:
a) Donwload the actual html manual from
- http://snaps.php.net/manual/lang/
- and untar the distribution in a directory
+ http://snaps.php.net/manual/lang/
+ and untar the distribution in a directory
a) Build the html manual yourself using Jade and the other
- tools needed (how to do it is not in the scope of this README)
-
+ tools needed (how to do it is not in the scope of this README)
+
=======================================================================
You need 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.
-
+ make_chm.php - Auto toc generator.
+
To make the fancy manual additional files needed:
make_chm_fancy.php - Convert the normal html files to
- good looking pages and correct
-
some pages (manual.html, copyright.html)
+ good looking pages and correct
+ some pages (manual.html, copyright.html)
make_chm_index_lang.html - Fancy index. I recommend you
- to use a fancy index in the language
-
of the actual compiled maunal (look into
-
phpdoc/lang dir if it exists).
- make_chm_spc.gif - Gif file needed by the fancy pages.
- make_chm_style.css - This adds some good style to html files.
-
-Note that you NEED make_chm.php and make_chm.bat to make the
+ to use a fancy index in the language
+ of the actual compiled maunal (look into
+ phpdoc/lang dir if it exists).
+ make_chm_spc.gif - Gif file needed by the fancy pages.
+ make_chm_style.css - This adds some good style to html files.
+
+Note that you NEED make_chm.php and make_chm.bat to make the
fancy manual too!!!!!
Now put the above listed make_chm_* files to one directory.
@@ -64,15 +64,15 @@
Open make_chm.bat in a text editor and make the appropriate
modifications. You need to
-
- - 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)
- - substitute D:\progra~1\php402\php.exe with your
- php.exe path (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)
+ - substitute D:\progra~1\php402\php.exe with your
+ php.exe path (including php.exe)
Now the batch file is ready to run. To compile the normal
manual, use the 'normal' command line option (without quotes):
@@ -82,18 +82,18 @@
It will generate manual_lang.hhp, manual_lang.hhc, index.hhk
and compile.bat in the same directory, and call compile.bat
to finalize the process and compile manual_lang.chm
-
+
=======================================================================
To make manual_lang.chm using the fancy style:
See make_chm_fancy.bat and make all the modifications described
above at make_chm.bat. Note, that you need to substitute the
php.exe path in two places in this batch file!!!
-
+
One more thing you need to set here is the PHP_HELP_COMPILE_FANCYDIR
environment variable, which is the container for the directory name
where the fancy pages will go.
-
+
You can decide not to sacrifice any more space for the fancy dir
(it takes up 55 megs on my FAT16 system), and set this variable
to the same as PHP_HELP_COMPILE_DIR. Then your old HTML files
@@ -102,7 +102,7 @@
In any case make sure that the directory named in
PHP_HELP_COMPILE_FANCYDIR exists. I pesonally used "fancy"
as the value of this variable (without quotes).
-
+
Now the batch file is ready to run. To compile the fancy manual,
do not add any command line options, run:
@@ -111,14 +111,14 @@
It will generate the fancy pages in the directory you specified,
copy in the fancy dir the
- make_chm_index_lang.html as index.html,
- make_chm_spc.gif as spacer.gif and
- make_chm_style.css as style.css
-
+ make_chm_index_lang.html as index.html,
+ make_chm_spc.gif as spacer.gif and
+ make_chm_style.css as style.css
+
A date subtitution takes place when copying index.html (the
actual date will be printed inside the file), and some more
modifications are made to manual.html and copyright.html.
-
+
After that the same process is done as described above with normal pages.
After this process, you will have manual_lang.chm in your language...
=======================================================================
