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
|
PhD - PHP DocBook
Copyright(c) 2007-2008 The PHP Documentation Team
All Rights Reserved.
$Id: README,v 1.9 2008/05/03 15:14:21 bjori Exp $
At the moment, the code depends upon the following:
- PHP 5.2.3 or later. PHP 5.3 is recommended. PHP 6 is unsupported, but
might work.
- An available CLI binary.
- DOM, libXML2, and xmlreader.
Installing the PhD renderer:
From a PEAR channel:
pear install doc.php.net/phd-beta
Note: You'll have to "discover" the channel first:
pear channel-discover doc.php.net
This command only needs to be executed once
From CVS:
cvs -d:pserver:cvsread@cvs.php.net/repository co phd
cd phd
pear install -f package.xml
After installing PhD you can use the `phd` command
to render the documentations. By default `phd` will use the current working
directory.
Rendering the documentations for the first time:
WINDOWS:
#1) cd c:\
#2) cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc
#3) cd phpdoc
#4) php configure.php
(Using PHP5.3:)
#5) phd --docbook c:\phpdoc\.manual.xml
(Using PHP prior to 5.3:)
#5-old) phd c:\phpdoc\
*NIX:
#1) cd ~
#2) cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc
#3) cd phpdoc
#4) php configure.php
(Using PHP5.3:)
#5) phd --docbook ~/phpdoc/.manual.xml
(Using PHP prior to 5.3:)
#5-old) phd -d ~/phpdoc/.manual.xml
NOTE: The short form works on PHP5.3 too
This will create
"php" directory containing the "phpweb" files
NOTE: You CANNOT view these files without a phpweb mirror running.
See http://doc.php.net/wiki/phd/view#viewing_the_phpfolder
"html" direcotry containing the "downloadable chunked html" files
NOTE: Do NOT move these files onto your webserver. Just double click
them and your browser will open and show you the content
"bightml.html" file, which is the "downloadable bightml" file
Now edit the XML files as you wish in the phpdoc folder.
To build the documentation again follow the instructions above, skipping step#2.
The `phd` command optionally takes more arguments.
For information about those arguments please type `phd -h`
- The PHP Documentation team
|
