cvs: phpdoc / README.win32

jkj Tue May 15 11:55:15 2001 EDT Modified files: /phpdoc README.win32 Log: - added updates sent by Thomas - added reference for ISO entity sets Index: phpdoc/README.win32 diff -u phpdoc/README.win32:1.2 phpdoc/README.win32:1.3 --- phpdoc/README.win32:1.2 Wed Feb 7 02:55:37 2001 +++ phpdoc/README.win32 Tue May 15 11:55:14 2001 @@ -25,34 +25,61 @@ http://www.jclark.com/jade/ http://nwalsh.com/docbook/dsssl/ - There is a DTD reference for DocBook at + There is a Reference for DocBook at - http://www.ora.com/homepages/dtdparse/docbook/3.0/ + http://www.oasis-open.org/docbook/documentation/reference/ - RPMs with the necessary software can be found at - ftp://sourceware.cygnus.com/pub/docbook-tools/ - Most major linux distributions should already come with - ready to use packages. This is not case for Windows. You must do - following steps: + Most major linux distributions should already come with ready to use + packages. This is not case for Windows. You must do following steps: - 1. Directory where jade.exe is located must be added into your + 1. Download and unpack the distributions of + - Jade, + - DSSSL stylesheets + + 2. Download ISO entity sets (http://www.oasis-open.org/cover/ISOEnts.zip) + and unzip them into some directory, for example c:\isoent. Create file + named isoent.cat in this directory and place following code into it: + +PUBLIC "ISO 8879:1986//ENTITIES Diacritical Marks//EN" "isodia" +PUBLIC "ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN""isonum" +PUBLIC "ISO 8879:1986//ENTITIES Publishing//EN" "isopub" +PUBLIC "ISO 8879:1986//ENTITIES General Technical//EN" "isotech" +PUBLIC "ISO 8879:1986//ENTITIES Added Latin 1//EN" "isolat1" +PUBLIC "ISO 8879:1986//ENTITIES Added Latin 2//EN" "isolat2" +PUBLIC "ISO 8879:1986//ENTITIES Greek Letters//EN" "isogrk1" +PUBLIC "ISO 8879:1986//ENTITIES Monotoniko Greek//EN" "isogrk2" +PUBLIC "ISO 8879:1986//ENTITIES Greek Symbols//EN" "isogrk3" +PUBLIC "ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN" "isogrk4" +PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN" "isoamsa" +PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN" "isoamsb" +PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN" "isoamsc" +PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN" "isoamsn" +PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN" "isoamso" +PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN" "isoamsr" +PUBLIC "ISO 8879:1986//ENTITIES Box and Line Drawing//EN" "isobox" +PUBLIC "ISO 8879:1986//ENTITIES Russian Cyrillic//EN" "isocyr1" +PUBLIC "ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN" "isocyr2" + + 3. Directory where jade.exe is located must be added into your PATH environment variable. - - 2. Norm's modular DocBook DSSSL stylesheets must be unzipped somewhere. - 3. You need to download and install cygwin tools from www.cygwin.com. + 4. Make the catalog files available. + Set the environemt variable SGML_CATALOG_FILES, e.g.: + SGML_CATALOG_FILES=c:/jade/catalog;c:/isoent/isoent.cat + + 5. You need to download and install cygwin tools from www.cygwin.com. Just select "Install now!" link and run supplied setup.exe. It - will guide you through process of instalation. + will guide you through process of installation. These tools are port of standard unix tools like sed, awk, autoconf, make, perl, ... for Windows. - 4. If want to build documentation just run "Cygwin Bash Shell" + 6. If you want to build documentation just run "Cygwin Bash Shell" command from Programs menu (it will be added here by previous step). - 5. Now you get command line which behaves same as bash on unix + 7. Now you get a command line which behaves same as bash on unix boxes. Change to directory where you have snapshot of phpdoc. (If you haven't snapshot yet, use CVS command as described on http://www.php.net/cvs-php.php. CVS is part of cygwin, so you @@ -63,18 +90,32 @@ paths. If you want access directory foo on drive c: write is as c:/foo instead of c:\foo. - 6. Now do same steps as on unix machine. For example for building + 8. Now do same steps as on unix machine. For example for building HTML version of documentation use: autoconf ./configure --with-dsssl=c:/path/to/dsssl/stylesheets/dir make html + + to make your local language, replace the above configure-command with + + ./configure --with-dsssl=c:/path/to/dsssl/stylesheets/dir --with-lang=xx + + for further options, simply type + ./configure --help - 7. Wait a few minutes (now it is time to have a couple of tea or + 9. Wait a few minutes (now it is time to have a couple of tea or explore bash functionality in another window - it is really funny having "old good unix commands" on Windows box ;). + + If you have a problem with building the PHP Documentation: + + Consult the DocBook Installation Guide and check what you're missing at + http://www.oasis-open.org/docbook/documentation/reference/html/appa.html -Based on README, Win32 specific notes added by Jirka Kosek <jirka@kosek.cz> +Based on README +Win32 specific notes added by Jirka Kosek <jirka@kosek.cz> + and Thomas <Yin.Yang@gmx.net> -Last modified $Date: 2001/02/07 10:55:37 $ +Last modified $Date: 2001/05/15 18:55:14 $