From ccead5e9721797e2c96961b7d5c9cc4e5e0a5f15 Mon Sep 17 00:00:00 2001
From: didou <didou@localhost>
Date: Mon, 29 Mar 2004 11:57:44 +0000
Subject: [PATCH] and finally, add a TODO here # please review my poor english

---
 docs/TODO | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 docs/TODO

diff --git a/docs/TODO b/docs/TODO
new file mode 100644
index 00000000..0cbb7721
--- /dev/null
+++ b/docs/TODO
@@ -0,0 +1,57 @@
+*normal mode* :
+- add a PHP script that will generate dynamically all the files entity in manual.xml
+- add CDATA sections in all programlistings.
+- add roles to programlisting (especially role="php") and add PHP tags in PHP examples (short_open_tag is banned). This will help to :
+ -- colorize examples
+ -- check parse errors : for i in $(ls |grep xml); do php -d short_open_tag=off -l $i; done
+
+*pedentic mode* :
+- fix indenting in all .xml files : don't uses tabs, indent by a space. Here's a nice indentation :
+
+<para>
+ <example>
+  <title />
+  <programlisting>
+<![CDATA[
+// ..
+]]>
+  </programlisting>
+ </example>
+</para>
+
+- clean all the examples :
+(if aggreed) examples should be XHTML compliant and should stick to PEAR's coding standards.
+
+Here's how a complete example, using PHP and templates, should be written :
+
+   <example>
+    <title>html_image example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+require('Smarty.class.php');
+$smarty = new Smarty;
+$smarty->display('index.tpl');
+
+?>
+]]>
+    </programlisting>
+    <para>
+     where index.tpl is:
+    </para>
+    <programlisting>
+<![CDATA[
+{html_image file="pumpkin.jpg"}
+]]>
+    </programlisting>
+    <para>
+     a possible output would be:
+    </para>
+    <screen>
+<![CDATA[
+<img src="pumpkin.jpg" alt="" border="0" width="44" height="68" />
+]]>
+    </screen>
+   </example>
+