CVS update: php3/doc

Date: Friday June 18, 1999 @ 20:56 Author: jim Update of /repository/php3/doc In directory php:/tmp/cvs-serv13839/doc Modified Files: README Removed Files: Makefile.in bookinfo.sgml chapters.ent checkdoc.in common.dsl docbook.tags funclist.txt funcparse.awk funcsummary.awk genfunclist genfuncsummary global.ent howto.dsl howto.sgml html-common.dsl html.dsl.in makedoc.cc manual.ced manual.sgml phpweb.dsl.in preface.sgml print.dsl.in version.ent.in Log Message: Ladies and gentleman, the documentation has left the building. Also cleaned up some of the output of configure.in. Index: php3/doc/README diff -u php3/doc/README:1.13 php3/doc/README:1.14 --- php3/doc/README:1.13 Thu May 27 10:24:03 1999 +++ php3/doc/README Fri Jun 18 20:56:04 1999 @@ -1,162 +1,5 @@ -READ THIS FIRST +As of June 18, 1999, the documentation is now kept in the 'phpdoc' +repository on the CVS server. This directory will be populated with the +HTML version of the documentation for releases. - This directory contains source files and a setup for converting - PHP3's SGML documentation into presentation formats like HTML and - RTF. You should not have to bother with this unless you are - writing documentation yourself, or if you simply are curious about - how the SGML stuff works. - - If you just want to read the documentation, download it from - http://www.php.net/docs.php3 - -INTRODUCTION - - All the documentation is written with SGML using the DocBook DTD. - See: - - http://www.ora.com/davenport/ - - If you want to produce something viewable, you need Jade and - Norman Walsh's modular DocBook stylesheets. See: - - http://www.jclark.com/jade/ - http://nwalsh.com/docbook/dsssl/ - - There is a DTD reference for DocBook at - - http://www.ora.com/homepages/dtdparse/docbook/3.0/ - - RPMs with the necessary software can be found at - ftp://sourceware.cygnus.com/pub/docbook-tools/ - -CONVENTIONS - - 1. Insert ID attributes in all major section tags such - as part, chapter, sect1 etc. The HTML stylesheet will - name the HTML files after these IDs. - - 2. Function reference IDs look like this (case does not matter): - `function.imageloadfont'. Please note that underscores cannot - be used in IDs, they should be replaced by minus signs (-). - - 3. Function section titles (<reference><title>...</>...) look - like this: `ref.category'. - - 4. The contents of examples with program listings start on column - 0 in the SGML code. - - 5. All examples use the <?php ... ?> form instead of <? ... ?> - - 6. The <refsect1><title> tag was set incorrectly when - converting from sgml-tools. For normal function reference, the - text "Description" should be used instead of the function name. - -SKELETONS - - Below are some "skeletons" to copy and paste from when adding - documentation. - -FUNCTION REFERENCE FILE IN functions/: - - <reference> - <title></title> - <titleabbrev></titleabbrev> - - </reference> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -sgml-parent-document:nil -sgml-default-dtd-file:"../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> - -END OF SKELETON - - -FUNCTION REFERENCE ENTRY: - - <refentry id="function."> - <refnamediv> - <refname></refname> - <refpurpose></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>RETURNTYPE <function>FUNCTIONNAME</function></funcdef> - <paramdef>ARGTYPE1 <parameter>ARGNAME1</parameter></paramdef> - <paramdef>ARGTYPE2 <parameter>ARGNAME2</parameter></paramdef> - <paramdef>ARGTYPE3 <parameter><optional>ARGNAME3</optional></parameter></paramdef> - </funcsynopsis> - <simpara> - A simple paragraph that can not contain anything that requires - fancy layout. - - <para> - A normal paragraph that can contain lots of stuff. For example - <example> - <title>Code examples</title> - <programlisting> -/* Do all indentation with spaces, not tabs, just to be sure. - * Don't try pushing the code to the right by adding spaces in - * front, this is the style sheet's job. - */ -function some_code($foo) -{ - /* we all agree that four spaces of indentation is good? */ -} -</programlisting></example> - - The text in a paragraph may continue after the example as well. - Here is how to make lists: - - <itemizedlist> - - <listitem><simpara> - List items must contain a container element such as - simpara or para (there are plenty of others too, see the - DocBook reference for the listitem element. - - <listitem><simpara> - List items must contain simple paragraphs or paragraphs. - - <listitem><para> - If you plan on making sub-lists, you must use para - - <orderedlist> - <listitem><simpara> first list item - <listitem><simpara> second list item - </orderedlist> - - You can also continue an ordered list you just left off - - <orderedlist> - <listitem><simpara> third list item - <listitem><simpara> fourth list item - </orderedlist> - - <simpara> - The documentation for a function should be wrapped up with - a "See also" list like this: - - <simpara> - See also <function>stripslashes</function> and - <function>quotemeta</function>. - - </refsect1> - </refentry> - - -END OF SKELETON - -Stig Bakken <stig@php.net> +Jim Winstead <jimw@php.net>