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
|
PhD - PHP DocBook
Copyright(c) 2007-2009 The PHP Documentation Team
All Rights Reserved.
$Revision: 286389 $
At the moment, the code depends upon the following:
- PHP 5.2.3 or later. PHP 5.3 is recommended.
- 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 SVN:
svn checkout http://svn.php.net/repository/phd/branches/PHD_0_4 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) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
#3) cd doc-en\doc-base
#4) php configure.php
(Using PHP5.3:)
#5) phd --docbook c:\doc-en\doc-base\.manual.xml
(Using PHP prior to 5.3:)
#5-old) phd c:\doc-en\doc-base\
*NIX:
#1) cd ~
#2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
#3) cd doc-en/doc-base
#4) php configure.php
(Using PHP5.3:)
#5) phd --docbook ~/doc-en/doc-base/.manual.xml
(Using PHP prior to 5.3:)
#5-old) phd -d ~/doc-en/doc-base/.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" directory 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 doc-en/en directory.
To build the documentation again follow the instructions above, skipping step#2.
NOTE: To work on translations, you should replace the 'en' in all
of the above examples with the appropriate ISO 639-1 Code of the desired language.
(see http://www.sil.org/iso639-3/codes.asp for a list of codes)
e.g. 'pt' for Portuguese, or pt_BR for Brazillian Portuguese. Step two in the
example above would change to:
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt
or
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt_BR
The XML files to edit will be in doc-pt/pt or doc-pt_BR/pt_BR directories.
The `phd` command optionally takes more arguments.
For information about those arguments please type `phd -h`
- The PHP Documentation team
|
