PHP Wiki

faq

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

2026/04/23 13:46	current
Line 1:	Line 1:
	+	==== So, How exactly do I get the source files for the PHP Manual? ====
	+	Simple. The PHP Project uses CVS to manage its sources, so to retrieve the sources for the PHP Manual you will checkout (download) these sources from CVS. An anonymous CVS user named //cvsread// exists (password: //phpfi//) that anybody in the world may use to make checkouts. For example:
	+
	+	<code>
	+	$ cvs -d :pserver:cvsread@cvs.php.net:/repository login
	+	$ cvs -d :pserver:cvsread@cvs.php.net:/repository checkout phpdoc
	+	</code>
	+
	+	The above assumes you have CVS installed. Odds are if you're using Linux or Mac that this is already installed, but Windows users aren't so lucky (or unlucky, depending on your feelings towards CVS!) The simplest method for Windows users is TortoiseCVS, see the FAQ for that.
	+
	+	There will now exist a directory named //phpdoc// that houses all sources files for the PHP Manual.
	+
	+	==== I use Windows, and heard something about TortoirseCVS... should I use it? ====
	+	Sure, it's simple and offers a friendly GUI so if you're into that then go for it! And besides, it also installs the cvs command so it may be used in your Terminal too. The steps include:
	+
	+	* Install [[http://www.tortoisecvs.org/\|TortoirseCVS]]
	+	* Open a new explorer window and go to the folder you wish to do a checkout in (store CVS files)
	+	* Right click anywhere in the blank area to spawn the context menu, select "CVS Checkout"
	+	* A new window will popup and ask for details about the checkout; these values will be remembered so will be entered just once
	+	* Enter the following:
	+	* CVSROOT: ":pserver:cvsread@cvs.php.net:/repository"
	+	* Module field: "phpdoc"
	+	* Press OK to begin the checkout. If you're prompted to enter a password while checking out, then type in "phpfi" and OK
	+	* When the checkout is complete, then it should have created a directory called "phpdoc" where the english php documentation source tree will be
	+
	+	==== I was told to create a patch, how do I do that? ====
	+	== New Files ==
	+	== Current Files ==
	+
	+	==== How do I know if my changes are good and valid? ====
	+	* Whitespace
	+	* Read diff
	+	* php configure.php
	+	* Describe when editing manual.xml.in is needed
	+	* PhD
	+
	+	==== Is there an online editor? ====
	+	* Yes and No

updating-markup

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

2009/02/16 22:42		current
Line 1:		Line 1:
-	Updating PHP docs to the new markup	+	==== Updating PHP docs to the new markup ====

	Several PHP extensions have documentation for OO-style APIs which is written as if the documentation was a procedural API. A good example of this was ext/soap, but also ext/rar seems to be using the old markup too. So, I'm going to take this as my example. If you go to http://php.net/rar, and look over the methods of the Rar class, you can see they're documented just the same as the functions rar_close(), rar_entry_get(), etc. This isn't handy and makes the search less useful. There is a new variant of the DocBook markup which makes more sense for OO APIs, and it should be converted. This is basically a copy and paste job.		Several PHP extensions have documentation for OO-style APIs which is written as if the documentation was a procedural API. A good example of this was ext/soap, but also ext/rar seems to be using the old markup too. So, I'm going to take this as my example. If you go to http://php.net/rar, and look over the methods of the Rar class, you can see they're documented just the same as the functions rar_close(), rar_entry_get(), etc. This isn't handy and makes the search less useful. There is a new variant of the DocBook markup which makes more sense for OO APIs, and it should be converted. This is basically a copy and paste job.
Line 39:		Line 39:

	TODO: Describe fixing user notes.		TODO: Describe fixing user notes.
		+	TODO: Describe how to deal with old CVS history... links to old files should be in the commit message at least.

per-release-minor

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

2026/04/23 13:46	current
Line 1:	Line 1:
	+	==== TODO for every minor (x.Y.0) release ====
	+
	+	== Migration guides ==
	+	Since PHP 5.1.0, every such release has included a migration appendix / upgrade guide. This involves the following:
	+
	+	* php-src/README.UPDATE_X_Y (Examples: [[http://cvs.php.net/viewvc.cgi/phpweb/README_UPGRADE_51.php?hideattic=0\|5.1]], [[http://cvs.php.net/viewvc.cgi/php-src/README.UPDATE_5_2?&pathrev=PHP_5_2\|5.2]])
	+	* phpdoc/appendix/migrationXY.xml (Examples: [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/migration51.xml?view=log\|5.2]], [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/migration52.xml?view=log\|5.2]])
	+
	+	Currently the internals team has created the README files, but this may change.
	+
	+	== Extension categories ==
	+	Some extensions may have been moved to PECL, became bundled, were re-categorized, etc. This information should be updated at this time, or at any time before:
	+	* The XML: [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/extensions.xml?view=log\|phpdoc/en/appendices/extensions.xml]]
	+	* The script that updates it: [[http://cvs.php.net/viewvc.cgi/phpdoc/scripts/extensions.xml.php?view=log\|phpdoc/scripts.extensions.xml.php]]
	+	NOTE: This information comes from the comments found within (on top of) every book.xml. Status, and Membership. The Purpose dictates how the extensions are categorized in the index/table of contents.

translations

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

2008/12/23 05:31		current
Line 46:		Line 46:
	=== When we should know ===		=== When we should know ===
	The SVN conversion will be completed sometime in the first quarter of 2009, let's say March 1. We should have our system essentially in place by that time. A sequential move is possible too (Start using SVN numbers, then later gettext) but that wouldn't be ideal. However, given the size of our manual, it may be required.		The SVN conversion will be completed sometime in the first quarter of 2009, let's say March 1. We should have our system essentially in place by that time. A sequential move is possible too (Start using SVN numbers, then later gettext) but that wouldn't be ideal. However, given the size of our manual, it may be required.
		+
		+	=== Status update: May 20, 2009 ===
		+	So far I've (philip) am having success converting translations to po files using po4a. After additional tweaking the plan is to setup pootle and see what happens. We may use transifex instead so we'll see but the key is getting the po files going. The main alternative to po4a is xml2po but so far I like po4a so don't see a need to investigate xml2po much further.
		+
		+	* po4a manual: http://po4a.alioth.debian.org/man/man7/po4a.7.php
		+	* Command: po4a-gettextize -f docbook -m en/reference/strings/functions/strlen.xml -p strlen.po (creates a po file)
		+	* Command: po4a-translate -f docbook -m en/reference/strings/functions/strlen.xml -p foo.po (creates docbook file)
		+	* Command: po4a-gettextize -f docbook -m en/reference/strings/functions/strlen.xml -l ja/reference/strings/functions/strlen.xml -p foo.po (converts translation to po file)
		+
		+	So, the current plan:
		+	* Convert current translations to po files (progressing)
		+	* Setup pootle at translate.php.net
		+	* Profit

newtranslation

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

2008/05/11 00:50		current
Line 8:		Line 8:
	* Update CVSROOT/modules		* Update CVSROOT/modules
	* Update CVSROOT/loginfo		* Update CVSROOT/loginfo
		+	* Update CVSROOT/avail (in a couple places)
	* Add {lang} to docweb for revcheck		* Add {lang} to docweb for revcheck
	* Add {lang} to phpweb/includes/languages.inc as INACTIVE		* Add {lang} to phpweb/includes/languages.inc as INACTIVE
	* Add the new {lang} mailing list to our super secret gmail doc account (user php.doc.lists)		* Add the new {lang} mailing list to our super secret gmail doc account (user php.doc.lists)

feeds

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

2026/04/23 13:46	current
Line 1:	Line 1:
	+	==== Discussion List ====
	+	{{rss>http://news.php.net/group.php?group=php.doc&format=rss 10 6h}}
	+
	+	==== Commits ====
	+	{{rss>http://news.php.net/group.php?group=php.doc.cvs&format=rss 10 6h}}
	+
	+	==== Bugs ====
	+	{{rss>http://news.php.net/group.php?group=php.doc.bugs&format=rss 10 6h}}

pecldocs

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

2009/03/24 17:14		current
Line 17:		Line 17:
	</code>		</code>

-	This will create a directory named 'tmp' for the extension named 'extname' which will be full of documentation skeletons. Reflection is used to make guesses about the extension, like for classes, methods, functions, constants, parameters, version information, etc. but this information will not be fully correct. Please go through and edit each XML file by updating this information and adding documentation.	+	This will create a directory named 'tmp' that will contain documentation skeletons for the 'pecl' extension named 'extname'. Reflection is used to make guesses about the extension, like for classes, methods, functions, constants, parameters, version information, etc. but this information will not be fully correct. Please go through and edit each XML file by updating this information and adding documentation.

	* Read the Validating Changes section of the [[doc:scratchpad:howto\|PHP Documentation HOWTO]].		* Read the Validating Changes section of the [[doc:scratchpad:howto\|PHP Documentation HOWTO]].

install

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

2026/04/23 13:46	current
Line 1:	Line 1:
	+	=== Installation section rewrite ===
	+	This task involves rewriting and restructuring the installation section of the PHP Manual. This is a large task so may be broken up into smaller parts.

	+	The section in question:
	+	* URL: http://php.net/install
	+	* Source: http://cvs.php.net/viewvc.cgi/phpdoc/en/install/
	+
	+	=== Problems ===
	+	This section has become outdated. For example, we highlight Apache 2.0.x and only include a few notes about Apache 2.2.x. There are a ton of user notes from confused users that should be addressed. The IIS/PWS section is outdated. The Mac section is outdated. Other parts, outdated.
	+
	+	=== TODO ===
	+	Start work on this one section at a time.

per-release-all

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

2011/06/20 03:41		current
Line 9:		Line 9:
	$ cd svn/phpdoc/trunk		$ cd svn/phpdoc/trunk
	$ xmllint --output tmp.xml --noent doc-base/install-unix.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > INSTALL		$ xmllint --output tmp.xml --noent doc-base/install-unix.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > INSTALL
-	$ xmllint --output tmp.xml --noent doc-base/install-windows.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > install.txt	+	$ xmllint --output tmp.xml --noent doc-base/install-win.xml && phd -d ./tmp.xml -P PHP -f bigxhtml -o ./ && lynx -dump -nolist -justify -display_charset UTF-8 ./php-bigxhtml.html > install.txt
	</code>		</code>

per-release-major

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

2026/04/23 13:46	current
Line 1:	Line 1:
	+	==== TODO for every major (X.0.0) PHP Release ====
	+
	+	== Check version information ==
	+	Since each major PHP version is stored in the version files, this is taken into account at this time.
	+
	+	== Consider removing old information ==
	+	For example, is PHP 3 still relevant? How about PHP 4? If using version specific tagging, does the build system need adjusting?
	+
	+	== Update PHP version specific info ==
	+	The following manual pages contain version specific information that needs updating:
	+	* [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/about.xml?view=log\|appendices/about.xml]]

53

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

2009/06/26 02:29		current
Line 1:		Line 1:
	====== PHP 5.3 upgrading notes ======		====== PHP 5.3 upgrading notes ======
	* This document has been removed in favor of [[http://cvs.php.net/viewvc.cgi/php-src/UPGRADING?view=markup&pathrev=PHP_5_3\|UPGRADING]] and will eventually live in the PHP Manual (see below)		* This document has been removed in favor of [[http://cvs.php.net/viewvc.cgi/php-src/UPGRADING?view=markup&pathrev=PHP_5_3\|UPGRADING]] and will eventually live in the PHP Manual (see below)
-	* The 5.3.0 upgrade guide can be seen here: [[http://php.net/migration53]]	+	* The 5.3.0 upgrade guide can be seen here: [[http://docs.php.net/migration53]]
-	* The 5.2.0 upgrade guide can be seen here: [[http://php.net/migration52]]	+	* The 5.2.0 upgrade guide can be seen here: [[http://docs.php.net/migration52]]
-	* The 5.1.0 upgrade guide can be seen here: [[http://php.net/migration51]]	+	* The 5.1.0 upgrade guide can be seen here: [[http://docs.php.net/migration51]]

refstruct-progress

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

2008/03/21 20:36		current
Line 6:		Line 6:

	===== Progress =====		===== Progress =====
-	* ar (?)	+	* <del>ar</del>
	* <del>bg</del>		* <del>bg</del>
	* ca (?)		* ca (?)
Line 13:		Line 13:
	* <del>de</del>		* <del>de</del>
	* el		* el
-	* es	+	* <del>es</del>
	* fi		* fi
-	* fr	+	* <del>fr</del>
	* he		* he
	* hk		* hk
	* hu		* hu
	* <del>id</del>		* <del>id</del>
-	* it	+	* <del>it</del>
	* <del>ja</del>		* <del>ja</del>
	* kr		* kr
Line 26:		Line 26:
	* nl		* nl
	* no		* no
-	* pl	+	* <del>pl</del>
	* pt		* pt
	* <del>pt-br</del>		* <del>pt-br</del>
-	* ro	+	* <del>ro</del>
	* <del>ru</del>		* <del>ru</del>
	* sk		* sk