goba Sun Jan 14 09:05:55 2001 EDT
Modified files:
/phpdoc make_chm.README make_chm.bat
Log:
Some DOS batch file programmming
- now you only have to set PHP_PATH one place
- eliminated unnecessery compile.bat and index.hhk files
Getting more advanced functionality to the .chm files:
- activated advanced search
(search in results, search history, search in titles, sorting)
- activated favourites tab
- deactivated not used index tab
(although we should make an index somehow in the future)
- more buttons to ease navigation
(back, forward, reload, locate, home)
- custom icons in navigation pane
Now I will stop working on the .chm format for some time.
I need some rest :)
Index: phpdoc/make_chm.README
diff -u phpdoc/make_chm.README:1.3 phpdoc/make_chm.README:1.4
--- phpdoc/make_chm.README:1.3 Sun Jan 14 06:28:18 2001
+++ phpdoc/make_chm.README Sun Jan 14 09:05:55 2001
@@ -12,8 +12,7 @@
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:
@@ -44,7 +43,7 @@
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_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
@@ -62,34 +61,31 @@
=======================================================================
To make manual_lang.chm using the normal HTML pages:
-Open make_chm.bat in a text editor and make the appropriate
-modifications. You need to
+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)
- - 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):
make_chm.bat normal
-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
+It will generate manual_lang.hhp, manual_lang.hhc in the
+same directory, and run hhc 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!!!
-
+See make_chm.bat and make all the modifications described above.
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.
@@ -109,7 +105,7 @@
make_chm.bat
It will generate the fancy pages in the directory you specified,
-copy in the fancy dir the
+copying in to the fancy dir
make_chm_index_lang.html as index.html,
make_chm_spc.gif as spacer.gif and
Index: phpdoc/make_chm.bat
diff -u phpdoc/make_chm.bat:1.3 phpdoc/make_chm.bat:1.4
--- phpdoc/make_chm.bat:1.3 Sun Jan 14 05:53:16 2001
+++ phpdoc/make_chm.bat Sun Jan 14 09:05:55 2001
@@ -3,28 +3,36 @@
rem !! Please read the make_chm.README file for information
rem !! about how to build a manual_lang.chm file.
-echo.
-
+set PHP_PATH=D:\progra~1\php402\php.exe
set PHP_HELP_COMPILER=D:\progra~1\helpwo~1\hhc.exe
set PHP_HELP_COMPILE_LANG=hu
set PHP_HELP_COMPILE_DIR=html
+set PHP_HELP_COMPILE_FANCYDIR=fancy
+
+rem ==========================================================
+rem !!!!! DO NOT MODIFY ANYTHING BELOW THIS LINE !!!!!
+rem ==========================================================
+
+echo.
if a%1a == anormala goto skipfancy
-set PHP_HELP_COMPILE_FANCYDIR=fancy
-echo Now making the fancy manual...
-D:\progra~1\php402\php.exe -q make_chm_fancy.php
+echo Now generating the fancy manual in %PHP_HELP_COMPILE_FANCYDIR% dir...
+%PHP_PATH% -q make_chm_fancy.php
goto normal
+
:skipfancy
+set PHP_HELP_COMPILE_FANCYDIR=
echo Skipping fancy manual generation...
+
:normal
echo Now running the toc and project file generator script...
-D:\progra~1\php402\php.exe -q make_chm.php
+%PHP_PATH% -q make_chm.php
-echo Compiling the actual helpfile...
-call compile.bat
+echo Compiling the actual helpfile (manual_%PHP_HELP_COMPILE_LANG%.chm)...
+%PHP_HELP_COMPILER% manual_%PHP_HELP_COMPILE_LANG%.chm
echo Done!
-echo.
\ No newline at end of file
+echo.
