goba Fri Nov 9 11:30:31 2001 EDT
Modified files:
/phpdoc/howto working.xml howto.html.tar.gz
Log:
Adding role="php" convention to the manual...
Index: phpdoc/howto/working.xml
diff -u phpdoc/howto/working.xml:1.5 phpdoc/howto/working.xml:1.6
--- phpdoc/howto/working.xml:1.5 Mon Oct 22 13:38:41 2001
+++ phpdoc/howto/working.xml Fri Nov 9 11:30:30 2001
@@ -92,6 +92,12 @@
like this: 'ref.category', for example: 'ref.ftp'.
</simpara></listitem>
<listitem><simpara>
+ Add PHP example code programlistings allways
+ with a role attribute set to "php". Never add any
+ other programlisting or PHP output with such
+ a role. It is reserved for PHP source code only.
+ </simpara></listitem>
+ <listitem><simpara>
The contents of examples with program listings
start on column 0 in the XML code.
</simpara></listitem>
@@ -111,7 +117,7 @@
<listitem><para>
If an example uses arguments specific to a newer version of
PHP, it is helpful to note this in the example:
- <programlisting>
+ <programlisting role="php">
foo("bar", "baz"); // second argument was added in PHP 4.0.3
</programlisting>
New arguments are denoted in the main text of the
@@ -370,6 +376,10 @@
<title>Code examples</title>
<programlisting role="php">
// Use CDATA is you would like to add lots of < to the code
+
+// Use a role="php" only for PHP codes. See <computeroutput>,
+// <screen> and other DocBook elements to express other
+// types of listings.
/* Do all indentation with spaces, not tabs, just to be sure.
* Don't try pushing the code to the right by adding spaces in
Index: phpdoc/howto/howto.html.tar.gz
