cvs: peardoc /en/authoring readme.txt
| From: | Daniel Convissor | Date: | Mon, 19 Apr 2004 04:30:45 +0000 |
| Subject: | cvs: peardoc /en/authoring readme.txt | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3630@lists.php.net to get a copy of this message | ||
danielc Mon Apr 19 00:30:45 2004 EDT
Modified files:
/peardoc/en/authoring readme.txt
Log:
Add more section heads and a section telling folks to look at myfunction.xml.
http://cvs.php.net/diff.php/peardoc/en/authoring/readme.txt?r1=1.3&r2=1.4&ty=u
Index: peardoc/en/authoring/readme.txt
diff -u peardoc/en/authoring/readme.txt:1.3 peardoc/en/authoring/readme.txt:1.4
--- peardoc/en/authoring/readme.txt:1.3 Tue Oct 14 18:53:58 2003
+++ peardoc/en/authoring/readme.txt Mon Apr 19 00:30:44 2004
@@ -1,4 +1,8 @@
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
+
+------------------------------------------
+Directory structure
+
The directory structure of the published doc directory is:
<language>/
authoring/ (information about contributing to the manual
@@ -43,8 +47,8 @@
Returns (what is returned (without PEAR_Error))
Throws (returned PEAR_Errors)
Note (additional informations)
- See (links to related function or manual entries, optional)
Example (a small function related example, optional)
+ See (links to related function or manual entries, optional)
-----------------------------------------
Information about the id-attribute
@@ -59,4 +63,10 @@
<refentry> for function.xml:
package.<category>.<package>.<class>.<function>
<refsect1> for function.xml:
package.<category>.<package>.<class>.<function>.<contentpart>
+
------------------------------------------
+Important guidelines and tips
+
+Please make sure to examine
+package/categorie/mypackage/myclass/myfunction.xml
+It contains several essential pieces of information.