PHP Wiki - doc:phd

faq

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2011/04/06 10:59		current
Line 12:		Line 12:

	=== Download: ===		=== Download: ===
-	* View source: http://svn.php.net/viewvc/phd/trunk	+	* View source: https://svn.php.net/viewvc/phd/trunk
-	* SVN Repo: http://svn.php.net/repository/phd/trunk	+	* SVN Repo: https://svn.php.net/repository/phd/trunk
	* http://php.net/svn.php		* http://php.net/svn.php
	<code shell>		<code shell>
	$ cd /my/svn/dir		$ cd /my/svn/dir
-	$ svn co http://svn.php.net/repository/phd/trunk phd	+	$ svn co https://svn.php.net/repository/phd/trunk phd
	$ cd phd		$ cd phd
	$ ls		$ ls
Line 54:		Line 54:
	==== How do I use PhD with non-php.net centric projects? ====		==== How do I use PhD with non-php.net centric projects? ====
	* Short answer: Create a theme, and build.		* Short answer: Create a theme, and build.
-	* Long answer: It's not yet friendly for this but two close examples of smaller projects that use PhD are: The [[http://svn.php.net/viewvc/phpdoc/doc-base/trunk/howto/\|PHP documentation howto]] and [[http://svn.php.net/viewvc/phd/trunk/docs/phd-guide/\|PhD guide]].	+	* Long answer: It's not yet friendly for this but two close examples of smaller projects that use PhD are: The [[https://svn.php.net/viewvc/phpdoc/doc-base/trunk/howto/\|PHP documentation howto]] and [[https://svn.php.net/viewvc/phd/trunk/docs/phd-guide/\|PhD guide]].

install

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2012/03/07 11:30		current
Line 37:		Line 37:
	$ pear install http://doc.php.net/get/PhD-1.1.0.tgz		$ pear install http://doc.php.net/get/PhD-1.1.0.tgz
	</code>		</code>
-	==== Using SVN ====	+	==== Using GIT ====
-	NOTE: Using PhD from SVN is not recommended.	+	NOTE: Using PhD from GIT is not recommended.


Line 51:		Line 51:


-	Install and run from SVN. There are several package_*.xml files, but in the very least you'll need:	+	Install and run from GIT. There are several package_*.xml files, but in the very least you'll need:
	<code>		<code>
	$ cd phd		$ cd phd
Line 62:		Line 62:
	</code>		</code>

-	Alternately you can run PhD directly from SVN, without needing to install it. The same holds true if using the tarball, because all the phd command really does is execute "php render.php" so:	+	Alternately you can run PhD directly from GIT, without needing to install it. The same holds true if using the tarball, because all the phd command really does is execute "php render.php" so:
	<code>		<code>
	$ cd phd		$ cd phd

usage

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2026/05/01 13:40	current
Line 1:	Line 1:
	+	===== PhD Usage ===
	+	First, check out the internal help information:
	+	<code>
	+
	+	$ phd -h
	+
	+	PhD version: 0.2.4
	+	Copyright (c) 2008 The PHP Documentation Group
	+
	+	-v
	+	--verbose <int> Adjusts the verbosity level
	+
	+	-f <formatname>
	+	--format <formatname> The build format to use
	+
	+	-t <themename>
	+	--theme <themename> The theme to use
	+
	+	-i <bool>
	+	--index <bool> Index before rendering (default) or load from cache (false)
	+
	+	-d <filename>
	+	--docbook <filename> The Docbook file to render from
	+
	+	-p <id[=bool]>
	+	--partial <id[=bool]> The ID to render, optionally skipping its children chunks (default to true; render children)
	+
	+	-s <id[=bool]>
	+	--skip <id[=bool]> The ID to skip, optionally skipping its children chunks (default to true; skip children)
	+
	+	-l <formats/themes>
	+	--list <formats/themes> Print out the supported formats/themes (default: both)
	+
	+	-o <directory>
	+	--output <directory> The output directory (default: .)
	+
	+	-c <color>
	+	--color <color> Enable color output when output is to a terminal,
	+	optionally specify numerical color value (default: false)
	+
	+	-V
	+	--version Print the PhD version information
	+
	+	-h
	+	--help This help
	+	</code>
	+
	+	===== Descriptions of each argument ====
	+	%%--verbose%%
	+	* VERBOSE_INDEXING
	+	* VERBOSE_FORMAT_RENDERING
	+	* VERBOSE_THEME_RENDERING
	+	* VERBOSE_RENDER_STYLE
	+	* VERBOSE_PARTIAL_READING
	+	* VERBOSE_PARTIAL_CHILD_READING
	+	* VERBOSE_TOC_WRITING
	+	* VERBOSE_CHUNK_WRITING
	+	* VERBOSE_NOVERSION
	+	* VERBOSE_ALL
	+	* VERBOSE_DEFAULT

view

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T13:08:43+00:00

2008/03/19 11:00		current
Line 1:		Line 1:
	====== Viewing the results ======		====== Viewing the results ======
-	After [[doc:phd\|building the docs]] you probably want to view them now.	+	After [[doc:phd\|building the docs]] it's time to view them. There are a few choices:
-	You have a few choices:	+
-	* See how it would be online (the php/ folder)	+
-	* Just quickly see the results (the html/ folder)	+
-	* Test how long it takes for your browser to render 20mb xhtml file (the bightml.html file)	+

		+	* View how it would look online (the php/ folder, which uses the theme used by www.php.net)
		+	* View the plain html (the html/ folder)
		+	* View the single file plain html, which is around 20mb (the bightml.html file)
		+	* And other formats that require additional setup to the build environment: chm, pdf and *nix man pages

	===== Viewing the php/ folder =====		===== Viewing the php/ folder =====
-	These files are tightly integrated into www.php.net, so to view them you need a ''phpweb'' mirror.	+	These files are tightly integrated into www.php.net, so to simplest way to view them is to
-	This method is currently the only "supported" method as the online manual is the most important one.	+	setup a ''phpweb'' mirror.

-	(Note; On Windows you are pretty much out of luck regarding instructions on setting up a ''phpweb'' mirror, you may try the following instructions but I have no idea if it would work.)	+	Note: These instructions likely don't work on Windows, but may, feel free to update them to do so (rsync alternative?)
		+
		+	So, the mirrors use the rsync command. The following will work and it disables downloading parts of the mirror (like all the distributed php source files):

	<code bash>		<code bash>
Line 21:		Line 22:
	</code>		</code>

-	Now locate your webserver configuration file and add a new virtual host.	+	Notes:
-	For an example virtual host configuration, see [[http://www.php.net/mirroring.php#settings]].	+	* Change /path/to/your/webroot/phpweb
-	Now restart your webserver. Tada!	+	* The 'ln -s' creates a symlink from your build directory to this location in the docroot
		+	* The docroot will likely be setup as a new virtual host via the web server configuration file
		+	* See also an example virtual host configuration here: [[http://www.php.net/mirroring.php#settings]].
		+	* Once the changes are made, restart the web server.

	===== Viewing the html/ folder =====		===== Viewing the html/ folder =====

	Do //not// place the contents of the html/ folder onto your webserver. Especially not if you are running apache2.		Do //not// place the contents of the html/ folder onto your webserver. Especially not if you are running apache2.
-	Just browse to the folder in your faviorite file manager and open the "index.html" file (or any page you are interested in viewing).	+	Just browse to the folder in your favorite file manager and open the "index.html" file (or any page you are interested in viewing).

	===== Viewing the bightml.html file =====		===== Viewing the bightml.html file =====

-	Double click it.	+	Is that really wise?