cvs: phpdoc / global.ent make_chm.README
| From: | Hojtsy Gabor | Date: | Fri, 10 Aug 2001 10:40:24 +0000 |
| Subject: | cvs: phpdoc / global.ent make_chm.README | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969336981@lists.php.net to get a copy of this message | ||
goba Fri Aug 10 06:40:24 2001 EDT
Modified files:
/phpdoc make_chm.README global.ent
Log:
Microsoft changed the addresses, the HTML Help start page moved
Index: phpdoc/make_chm.README diff -u phpdoc/make_chm.README:1.6 phpdoc/make_chm.README:1.7 --- phpdoc/make_chm.README:1.6 Sun Jun 24 12:20:03 2001 +++ phpdoc/make_chm.README Fri Aug 10 06:40:24 2001 @@ -1,107 +1,107 @@ -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 [colin@easyDNS.com] :) - -Written by Gabor Hojtsy (goba@php.net), and adapted by -Thomas Schöfbeck (tom@php.net). Contact them or the phpdoc list -(phpdoc@lists.php.net) if you have any questions or suggestions... - -Last modified: 2001/06/24 \ No newline at end of file +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://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 [colin@easyDNS.com] :) + +Written by Gabor Hojtsy (goba@php.net), and adapted by +Thomas Schöfbeck (tom@php.net). Contact them or the phpdoc list +(phpdoc@lists.php.net) if you have any questions or suggestions... + +Last modified $Date: 2001/08/10 10:40:24 $ \ No newline at end of file Index: phpdoc/global.ent diff -u phpdoc/global.ent:1.103 phpdoc/global.ent:1.104 --- phpdoc/global.ent:1.103 Tue Jul 31 04:07:29 2001 +++ phpdoc/global.ent Fri Aug 10 06:40:24 2001 @@ -1,6 +1,6 @@ <!-- -*- SGML -*- - $Id: global.ent,v 1.103 2001/07/31 08:07:29 dams Exp $ + $Id: global.ent,v 1.104 2001/08/10 10:40:24 goba Exp $ Contains global "macros" for all the XML documents. @@ -158,7 +158,7 @@ <!ENTITY url.unicode "http://www.unicode.org/"> <!ENTITY url.velocis "http://www.raima.com/"> <!ENTITY url.win32install "http://www.umesd.k12.or.us/php/win32install.html"> -<!ENTITY url.winhelp "http://msdn.microsoft.com/library/tools/htmlhelp/chm/hh1start.htm"> +<!ENTITY url.winhelp "http://msdn.microsoft.com/library/en-us/htmlhelp/html/vsconhh1start.asp"> <!ENTITY url.wddx "http://www.wddx.org/"> <!ENTITY url.xemacs "http://www.xemacs.org/"> <!ENTITY url.xml "http://www.w3.org/XML/">
Index: phpdoc/make_chm.README diff -u phpdoc/make_chm.README:1.6 phpdoc/make_chm.README:1.7 --- phpdoc/make_chm.README:1.6 Sun Jun 24 12:20:03 2001 +++ phpdoc/make_chm.README Fri Aug 10 06:40:24 2001 @@ -1,107 +1,107 @@ -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 [colin@easyDNS.com] :) - -Written by Gabor Hojtsy (goba@php.net), and adapted by -Thomas Schöfbeck (tom@php.net). Contact them or the phpdoc list -(phpdoc@lists.php.net) if you have any questions or suggestions... - -Last modified: 2001/06/24 \ No newline at end of file +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://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 [colin@easyDNS.com] :) + +Written by Gabor Hojtsy (goba@php.net), and adapted by +Thomas Schöfbeck (tom@php.net). Contact them or the phpdoc list +(phpdoc@lists.php.net) if you have any questions or suggestions... + +Last modified $Date: 2001/08/10 10:40:24 $ \ No newline at end of file Index: phpdoc/global.ent diff -u phpdoc/global.ent:1.103 phpdoc/global.ent:1.104 --- phpdoc/global.ent:1.103 Tue Jul 31 04:07:29 2001 +++ phpdoc/global.ent Fri Aug 10 06:40:24 2001 @@ -1,6 +1,6 @@ <!-- -*- SGML -*- - $Id: global.ent,v 1.103 2001/07/31 08:07:29 dams Exp $ + $Id: global.ent,v 1.104 2001/08/10 10:40:24 goba Exp $ Contains global "macros" for all the XML documents. @@ -158,7 +158,7 @@ <!ENTITY url.unicode "http://www.unicode.org/"> <!ENTITY url.velocis "http://www.raima.com/"> <!ENTITY url.win32install "http://www.umesd.k12.or.us/php/win32install.html"> -<!ENTITY url.winhelp "http://msdn.microsoft.com/library/tools/htmlhelp/chm/hh1start.htm"> +<!ENTITY url.winhelp "http://msdn.microsoft.com/library/en-us/htmlhelp/html/vsconhh1start.asp"> <!ENTITY url.wddx "http://www.wddx.org/"> <!ENTITY url.xemacs "http://www.xemacs.org/"> <!ENTITY url.xml "http://www.w3.org/XML/">