tom Sun Jun 24 18:20:03 2001 EDT
Modified files:
/phpdoc make_chm.README
Log:
complete rewrite for an easier newbie-start, incl. adapted file-sizes etc.)
Index: phpdoc/make_chm.README
diff -u phpdoc/make_chm.README:1.5 phpdoc/make_chm.README:1.6
--- phpdoc/make_chm.README:1.5 Sat Feb 3 12:04:01 2001
+++ phpdoc/make_chm.README Sun Jun 24 18:20:03 2001
@@ -1,127 +1,107 @@
-
-This is a README file about building the manual in
-Windows Help File (.chm) format. This README is written
-by Gabor Hojtsy ([EMAIL PROTECTED]). Contact him, or the phpdoc
-list if you have any questions or suggestions...
-
-Note: Where 'lang' is mentioned in this doc, it is the
-actual language code of the manual you are compiling,
-not the 'lang' word itself!
-
-=======================================================================
-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)
-
-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
-You need the complete workshop package install (about 4 Megs).
-Of cource you need one Microsoft(r) Windows to run that software.
-
-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
- a) Build the html manual yourself using Jade and the other
- tools needed (look into the README or README.win32
- file to see how to build it yourself)
-
-=======================================================================
-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.
-
-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 (original index, 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
-fancy manual too!!!!!
-
-Now put the above listed make_chm_* files to one directory.
-Put the html manual (~1700 files) under a subdir in this
-directory (eg. html).
-
-You need to decide what method to use (normal or fancy).
-The output .chm file for the tested English and Hungarian version
-were nearly in the same size, the fancy manual .chm took 30k more space.
-This is not significant, as the .chm files are ~1.5Megs in size.
-
-=======================================================================
-To make manual-lang-date.chm using the normal HTML pages:
-
-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)
- - 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.
-
-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 in the
-same directory, and run hhc to finalize the process
-and compile manual-lang-date.chm.
-
-=======================================================================
-To make manual-lang-date.chm using the fancy style:
-
-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.
-
-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
-will be rewritten to be fancy ones.
-
-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:
-
-make_chm.bat
-
-It will generate the fancy pages in the directory you specified,
-copying in to the fancy dir
-
- make_chm_index_lang.html as fancy_index.html,
- make_chm_spc.gif as spacer.gif and
- make_chm_style.css as style.css
-
-A date subtitution takes place when copying fancy_index.html (the
-actual date will be printed inside the file), and some more
-modifications are made to the original manual index and copyright.html.
-
-After that the same process is done as described above with normal pages.
-After this process, you will have manual-lang-date.chm in your language...
-
-The fancy design improvemenets and the .css file is based on
-the newsite design(TM) work of Colin Viebrock [[EMAIL PROTECTED]] :)
-=======================================================================
+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/tools/htmlhelp/chm/hh1start.htm
+ 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://snaps.php.net/manual/lang/
+ and untar the distribution into a directory
+ a) Build the html manual yourself using Jade and the other
+ tools needed (look into the README or README.win32
+ file 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)
+ - 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 manual-lang-date.chm in your language...
+
+=======================================================================
+The fancy design improvemenets and the .css file is based on
+the newsite design(TM) work of Colin Viebrock [[EMAIL PROTECTED]] :)
+
+Written by Gabor Hojtsy ([EMAIL PROTECTED]), and adapted by
+Thomas Schöfbeck ([EMAIL PROTECTED]). Contact them or the phpdoc list
+([EMAIL PROTECTED]) if you have any questions or suggestions...
+
+Last modified: 2001/06/24
\ No newline at end of file
