<?xml version='1.0' encoding='ISO-8859-1' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.0//EN" "..//docbook/docbook-xml/docbook.dtd" [

 <!-- We have our own entities, not dependant on phpdoc global.ent -->
 <!ENTITY % howto.entities SYSTEM "./howto.ent">
 %howto.entities;
 <!ENTITY % howto.date SYSTEM "../entities/version.ent">
 %howto.date;

 <!-- We use xhtml entities all over the place -->
 <!ENTITY % xhtml-lat1        SYSTEM "../entities/ISO/xhtml1-lat1.ent">
 <!ENTITY % xhtml-symbol      SYSTEM "../entities/ISO/xhtml1-symbol.ent">
 <!ENTITY % xhtml-special     SYSTEM "../entities/ISO/xhtml1-special.ent">
 <!ENTITY % isopub            SYSTEM "../entities/ISO/isopub.ent">
 %xhtml-lat1;
 %xhtml-symbol;
 %xhtml-special;
 %isopub;


 <!ENTITY howto.preface    SYSTEM "preface.xml"> 
 <!ENTITY howto.framework  SYSTEM "framework.xml"> 
 <!ENTITY howto.tools      SYSTEM "tools.xml"> 
 <!ENTITY howto.vcs        SYSTEM "vcs.xml"> 
 <!ENTITY howto.docbook    SYSTEM "docbook.xml"> 
 <!ENTITY howto.working    SYSTEM "working.xml"> 
 <!ENTITY howto.scripts    SYSTEM "scripts.xml"> 
 <!ENTITY howto.generating SYSTEM "generating.xml"> 
 <!ENTITY howto.editors    SYSTEM "editors.xml"> 
 
]>

<!-- TODO
  
  Quickrefs:
      http://www.mulberrytech.com/quickref/index.html
      http://www.dpawson.co.uk/docbook/reference.html#d3e60

  Other useful links:
      http://www.dpawson.co.uk/docbook/
      http://www.sagehill.net/xml/docbookxsl/
      http://www.sagehill.net/docbookxsl/index.html
      
  DSSSL and openjade information page:
      http://www.netfolder.com/DSSSL/index.html
      
  Good visual SVN tools:
  
  DocBook editors list to check:
      http://www.docbook.org/wiki/moin.cgi/DocBookAuthoringTools
      
  DocBook and OpenOffice.org
      http://www.zzoss.com/projects/oowdbk/
  
  Document new behaviour
  
  Sections need to be added:
    Documentation of the new CHM format generation
    How to add a new section/funcref/anything to the docs
    Work on Emacs and vi sections
    Practical advice for manual writers
    Separate conventions to parts, eg.
       - larger sections (eg. function explanations)
       - type, function and other tags, 
       - PHP code writing guidelines
    A short section about the most important docbook tags
    
  More info 
    About configure command line options
    On file names, and phpdoc logical directory stucture

  Notes need to be added:
    Look inside the TODO file, and use it
    Use the function table
    Use the manual notes when writing doc
    
  A good weblog about software documentation:
    http://trieloff.net/docbook/
    
  A great SVN shell integration tool for Windows (GPL):
    http://www.tortoisesvn.org/

  [From Yasuo Ohgaki:]
  It would be nice to see:
    - jade test sample to make sure jade works
    - description for SGML_CATALOG_FILES environment variable
      (http://docbook.sourceforge.net/projects/dsssl/doc/install.html)

-->

<book xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="index" xml:lang="en" xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>PHP Documentation HOWTO</title>

 <info xml:id="bookinfo">
  <authorgroup xml:id="authors">

   <author>
     <personname><firstname>Stig</firstname><surname>S&aelig;ther Bakken</surname></personname>
   </author>
 
   <author>
     <personname><firstname>Daniel</firstname><surname>Beckham</surname></personname>
   </author>
  
   <author>
    <personname><firstname>G&aacute;bor</firstname><surname>Hojtsy</surname></personname>
   </author>

   <author>
    <personname><firstname>Martin</firstname><surname>Jansen</surname></personname>
   </author>
 
   <author>
    <personname><firstname>Jirka</firstname><surname>Kosek</surname></personname>
   </author>

   <author>
    <personname><firstname>Philip</firstname><surname>Olson</surname></personname>
   </author>

   <author>
    <personname><firstname>Anatoly</firstname><surname>Techtonik</surname></personname>
   </author>

   <author>
    <personname><firstname>Jakub</firstname><surname>Vrana</surname></personname>
   </author>

   <author>
    <personname><firstname>Jeroen</firstname><surname>van Wolffelaar</surname></personname>
   </author>

  </authorgroup>
  
  <pubdate>&php.build-date;</pubdate>

  <!--authorgroup xml:id="editors">
   <editor>
    <personname><firstname>G&aacute;bor</firstname><surname>Hojtsy</surname></personname>
   </editor>
  </authorgroup-->
  
  <copyright>
   <year>2001-2010</year> <holder>the PHP Documentation Group</holder>
  </copyright>
  
  <legalnotice xml:id="copyright">
   <title>Copyright</title>
   <simpara>
    This manual is &copy; Copyright 2001-2010 by the PHP Documentation
    Group. See the copyright terms of the PHP Documentation for
    information about what conditions are applied to this document.
   </simpara>
  </legalnotice>
 </info>

 &howto.preface;
 
 <!--
  "The quicky" series.
  Mostly Docbook markupified version of various mails from bjori :]
  (Yes. More to come, I hope :)
 -->
 <part xml:id="part-quickies">
  <title>The Quickies</title>
   <xi:include href="thequicky/exceptions.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
  </part>

 <part xml:id="part-getting-started">
  <title>Getting Started</title>
  &howto.framework;
  &howto.tools;
  &howto.vcs;
  &howto.docbook;
 </part>

 <part xml:id="part-working-in-phpdoc">
  <title>Working with the PHP Documentation</title>
  &howto.working;
 </part>

 <part xml:id="part-generating-output">
  <title>Generating Documentation and Validating</title>
  &howto.generating;
 </part>

 <part xml:id="part-using-editors">
  <title>Using Editors</title>
  &howto.editors;
 </part>

</book>

<!-- 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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"howto.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->