1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?xml version='1.0' encoding='ISO-8859-1' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "../dtds/dbxml-4.1.2/docbookx.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;
<!ENTITY howto.preface SYSTEM "preface.xml">
<!ENTITY howto.framework SYSTEM "framework.xml">
<!ENTITY howto.tools SYSTEM "tools.xml">
<!ENTITY howto.cvs SYSTEM "cvs.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://cvsbook.red-bean.com/
http://www.sagehill.net/docbookxsl/index.html
DSSSL and openjade information page:
http://www.netfolder.com/DSSSL/index.html
Good visual CVS tools:
http://www.lincvs.org/
http://cervisia.sourceforge.net/
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 CVS shell integration tool for Windows (GPL):
http://www.tortoisecvs.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 id="index" lang="en">
<title>PHP Documentation HOWTO</title>
<bookinfo id="bookinfo">
<authorgroup id="authors">
<author>
<firstname>Stig</firstname><surname>Sæther Bakken</surname>
</author>
<author>
<firstname>Daniel</firstname><surname>Beckham</surname>
</author>
<author>
<firstname>Gábor</firstname><surname>Hojtsy</surname>
</author>
<author>
<firstname>Martin</firstname><surname>Jansen</surname>
</author>
<author>
<firstname>Jirka</firstname><surname>Kosek</surname>
</author>
<author>
<firstname>Philip</firstname><surname>Olson</surname>
</author>
<author>
<firstname>Anatoly</firstname><surname>Techtonik</surname>
</author>
<author>
<firstname>Jakub</firstname><surname>Vrana</surname>
</author>
<author>
<firstname>Jeroen</firstname><surname>van Wolffelaar</surname>
</author>
</authorgroup>
<pubdate>&php.build-date;</pubdate>
<!--authorgroup id="editors">
<editor>
<firstname>Gábor</firstname><surname>Hojtsy</surname>
</editor>
</authorgroup-->
<copyright>
<year>2001-2006</year><holder>the PHP Documentation Group</holder>
</copyright>
<legalnotice id="copyright">
<title>Copyright</title>
<simpara>
This manual is © Copyright 2001-2006 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>
</bookinfo>
&howto.preface;
<part id="part-getting-started">
<title>Getting Started</title>
&howto.framework;
&howto.tools;
&howto.cvs;
&howto.docbook;
</part>
<part id="part-working-in-phpdoc">
<title>Working with the PHP Documentation</title>
&howto.working;
</part>
<part id="part-generating-output">
<title>Generating Documentation and Validating</title>
&howto.generating;
</part>
<part 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
-->
|
