cvs: phpdoc /howto README

goba Sat Sep 8 14:54:16 2001 EDT Modified files: /phpdoc/howto README Log: Things changed a "bit" :)) Index: phpdoc/howto/README diff -u phpdoc/howto/README:1.2 phpdoc/howto/README:1.3 --- phpdoc/howto/README:1.2 Fri Sep 1 10:06:00 2000 +++ phpdoc/howto/README Sat Sep 8 14:54:16 2001 @@ -1,30 +1,30 @@ -READ THIS FIRST!! +ABOUT THE PHPDOC HOWTO -This directory contains a working DRAFT of a new PHP Documenation -HOWTO. It's being written in a very simliar format to the Linux -Documentation Project's HOWTO SGML document format. Since both the -LDP docs and PHP docs are both written in SGML/XML, there aren't very -many differences between the two, so anyone should be able to jump -right in. As a matter of fact, I'm using a modified copy of the main -PHP html.dsl stylesheet for this document's html formatting, so it -can't be that different. - -You can find good examples of how to write LDP style documenation in -howto-template.sgml. - -Also, once you've loaded phpdoc-howto.xml into emacs, (you do use -emacs+psgml don't you?) be sure to parse the DTD and then save it as -phpdoc-howto.ced in the same directory as phpdoc-howto.xml. - -Because I haven't finished joining this to the main configure script, -the Makefile is crude and the .dsl and .xml files use hardcoded paths. -It's possible that you may need to edit the location of the -docbook.dsl file at the top of hpdoc-howto.dsl in order for the -Makefile to work correctly for you. As always your mileage may vary. +This directory contains a working DRAFT of a PHP Documenation HOWTO. +It's being written in a very simliar format to the Linux Documentation +Project's HOWTO SGML document format. Since both the LDP docs and PHP +docs are written in SGML/XML, there aren't very many differences +between the two, so anyone should be able to jump right in. As a +matter of fact, we use a modified copy of the main PHPDOC html.dsl +stylesheet for this document's html formatting (see phpdoc/howto.dsl), +so it can't be that different. + +You can find good examples of how to write LDP style documenation +in howto-template.sgml. + +Also, once you've loaded howto.xml into emacs, (you do use +emacs+psgml don't you?) be sure to parse the DTD and then save +it as howto.ced in the same directory as howto.xml. + +To generate HTML format from the xml file, go to the phpdoc +directory, and type: + + make howto + +The HTML files will be generated in the html subdir of the +howto directory. -If you have any questions, suggestions or flames, please send them my -way. - -Daniel Beckham -danbeck@scott.net +If you have any questions, suggestions or flames, please +send them to the phpdoc mailing list: phpdoc@lists.php.net. +Original author: Daniel Beckham <danbeck@scott.net>