cvs: peardoc /en/chapters pear2cs.xml

arnaud		Fri Nov 30 11:09:28 2007 UTC

  Modified files:              
    /peardoc/en/chapters	pear2cs.xml 
  Log:
  improve docbook usage
  add note about state of the doc
  
  
http://cvs.php.net/viewvc.cgi/peardoc/en/chapters/pear2cs.xml?r1=1.10&r2=1.11&diff_format=u
Index: peardoc/en/chapters/pear2cs.xml
diff -u peardoc/en/chapters/pear2cs.xml:1.10 peardoc/en/chapters/pear2cs.xml:1.11
--- peardoc/en/chapters/pear2cs.xml:1.10	Wed Nov 28 20:05:25 2007
+++ peardoc/en/chapters/pear2cs.xml	Fri Nov 30 11:09:28 2007
@@ -1,10 +1,16 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
  <chapter id="pear2cs">
   <chapterinfo>
    <date>2007-11-26</date>
   </chapterinfo>
   <title>PEAR2 Coding Standards</title>
+  <note>
+   <simpara>
+    This document is being integrated in the manual and is not to be
+    considered complete.
+   </simpara>
+  </note>
   <subtitle>Coding Standards to be used in PEAR2</subtitle>
   <para>
    <itemizedlist>
@@ -329,8 +335,9 @@
     <para>
      All public classes must be in their own file with underscores (_) or
      namespace separators (::) replaced by directory separator, so that
-     PEAR2_PackageName_Base class or PEAR2::PackageName::Base class is always
-     located in PEAR2/PackageName/Base.php (this is required to make autoload
+     <classname>PEAR2_PackageName_Base</classname> class or
+     <classname>PEAR2::PackageName::Base</classname> class is always
+     located in <literal>PEAR2/PackageName/Base.php</literal> (this is required to make autoload
      work)
     </para>
     <sect3 id="pear2cs.rules.classtofile.requirement">
@@ -373,9 +380,10 @@
      are still allowed in doc and test files.
     </para>
     <para>
-     The installation structure of a package has implicit php_dir/src
+     The installation structure of a package has implicit
+     <literal>php_dir/src</literal>
      installation location, and data files are always located in
-     php_dir/data/channel/PackageName/.  To retrieve a data file within
+     <literal>php_dir/data/channel/PackageName/</literal>.  To retrieve a data file within
      <literal>PEAR2/PackageName/Subfile.php</literal>, you would use this code:
     </para>
       <programlisting role="php">