PHP Wiki - doc

articles

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

2014/04/06 10:30		current
Line 1:		Line 1:
-	==== Documentation related articles ====	+	This page has been removed, in favor of [[http://doc.php.net/tutorial/\|new guide]]
-	* [[doc:articles:localdocsetup\|Setting up Documentation environment]]	+
-	* [[doc:articles:nomenclature\|Nomenclature guide]]	+
-	* [[doc:articles:whitespace\|Why whitespace is important in phpdoc]]	+
-	* [[doc:articles:newtranslation\|Adding a new translation]]	+
-	* [[doc:articles:updating-markup\|Updating documentation to new OO markup]] - historical document	+

builds

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

2012/01/27 23:27		current
Line 16:		Line 16:
	=== Additional notes ===		=== Additional notes ===
	* If a manual does not validate on Friday, it will not be pushed to the mirrors until hopefully the upcoming Friday.		* If a manual does not validate on Friday, it will not be pushed to the mirrors until hopefully the upcoming Friday.
-	* Only active translations are selectable/downloadable, and this is managed in [[http://svn.php.net/viewvc/web/php/trunk/include/languages.inc\|phpweb/includes/languages.inc]]	+	* Only active translations are selectable/downloadable, and this is managed in [[http://git.php.net/?p=web/php.git;a=blob;f=include/languages.inc\|phpweb/includes/languages.inc]]

	=== The humans who manage these ===		=== The humans who manage these ===
	If there is a problem with the synced builds, it's wise to contact Derick or Hannes. If a problem exists on the developmental server (docs.php.net), then contact the documentation team.		If there is a problem with the synced builds, it's wise to contact Derick or Hannes. If a problem exists on the developmental server (docs.php.net), then contact the documentation team.

editor

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

2017/09/22 13:28		current
Line 1:		Line 1:
	====== Getting started ======		====== Getting started ======
-	Currently all documentation pages at php.net have link to the online editor, which allow anyone (anonymous or not) to edit manual pages. Link is placed under language select.	+	Currently all documentation pages at php.net have a link to the online editor, which allow anyone (anonymous or not) to edit manual pages. The link is placed under language select.

	The editor may also be accessed from here: https://edit.php.net/		The editor may also be accessed from here: https://edit.php.net/
Line 21:		Line 21:
	* your [[https://www.instagram.com\|Instagram]] account		* your [[https://www.instagram.com\|Instagram]] account

-	With a Facebook/Github/Google/Lindekin/Stackoverflow/Instagram account, we can better identify user who submit a patch.	+	With a Facebook/Github/Google/Lindekin/Stackoverflow/Instagram account, we can better identify the user who submitted a patch.

-	An anonymous user can edit any page and save the work as patch. While saving, an email may be entered that'll then be notified when the patch is approved or deleted. And all users may view patches under the "Pending Patch" tab.	+	An anonymous user can edit any page and save the work as a patch. While saving, an email may be entered that'll then be notified when the patch is approved or deleted. And all users may view patches under the "Pending Patch" tab.

	===== SVN users =====		===== SVN users =====
Line 34:		Line 34:

	====== All modules ======		====== All modules ======
-	All module are available for all languages except English, because translation related modules (like graphs displaying the translation percentage) don't make sense for English.	+	All modules are available for all languages except English, because translation related modules (like graphs displaying the translation percentage) don't make sense for English.

	===== Files Needing Translation =====		===== Files Needing Translation =====
Line 53:		Line 53:
	{{ :doc:phdoe_need_update.png?500\|}}		{{ :doc:phdoe_need_update.png?500\|}}

-	Based on the Revcheck tag, this module lists all files which have been modified in English but not yet synchronized in the chosen language. All files are sorted by folder and then filename.	+	Based on the Revcheck tag, this module lists all files which have been modified in English but not yet synchronized in the chosen language. All files are sorted by folder and their filename.

	<code><!-- EN-Revision: 288721 Maintainer: felipe Status: ready --></code>		<code><!-- EN-Revision: 288721 Maintainer: felipe Status: ready --></code>

-	Don't forget to update manually the EN-Revision number to the revision number in English from witch you update the given file.	+	Don't forget to update manually the EN-Revision number to the revision number in English from which you update the given file.

	You may simply double-click on a file to start editing them into a new tab.		You may simply double-click on a file to start editing them into a new tab.
Line 66:		Line 66:
	* On the top, the diff presents all modification made to the English language.		* On the top, the diff presents all modification made to the English language.
	* On the right, you can display the SVN log for this file, both as the chosen language and English.		* On the right, you can display the SVN log for this file, both as the chosen language and English.
-	* On the center you have 2 panels:	+	* On the center, you have 2 panels:
	* One for the LANG file		* One for the LANG file
	* One for the EN file		* One for the EN file
Line 77:		Line 77:
	{{ :doc:phdoe_file_error.png?500\|}}		{{ :doc:phdoe_file_error.png?500\|}}

-	This module present all files in error.	+	This module presents all files in error.
-	When the data is updated, there is a lot of checks done once each files.	+	When the data is updated, there is a lot of checks done once each file.
-	You can view all checks done by right-click on a file and chose the sub-menu "About error type". This action display all error type into a new tab.	+	You can view all checks done by right-click on a file and chose the sub-menu "About error type". This action displays all error type into a new tab.

	One you double-click into a file of this module, a new tab is open, similar to a "need update" tab.		One you double-click into a file of this module, a new tab is open, similar to a "need update" tab.
Line 85:		Line 85:
	* On the top, the error type for this file.		* On the top, the error type for this file.
	* On the right, you can display all SVN log for this file, into the chosen language, and into English.		* On the right, you can display all SVN log for this file, into the chosen language, and into English.
-	* On the center you have 2 panels :	+	* On the center, you have 2 panels :
	* One for the lang file		* One for the lang file
	* One for the EN file		* One for the EN file
Line 105:		Line 105:

	* On the right, you can display the SVN log for this file, both from the chosen language, and English.		* On the right, you can display the SVN log for this file, both from the chosen language, and English.
-	* On the center you have 2 panels:	+	* On the center, you have 2 panels:
	* One for the LANG file		* One for the LANG file
	* One for the EN file		* One for the EN file
Line 113:		Line 113:
	Your modification appears respectively in the 'Pending Commit' or the 'Pending Patch' module.		Your modification appears respectively in the 'Pending Commit' or the 'Pending Patch' module.

-	<code>The context menu allow you to open all files for the current extension. So, you can review all files for a given extension and be more consistent with your work.</code>	+	<code>The context menu allows you to open all files for the current extension. So, you can review all files for a given extension and be more consistent with your work.</code>

	===== Not in EN =====		===== Not in EN =====
Line 121:		Line 121:
	Usually, this happens when a file is deleted from EN tree but not yet synced in the chosen language.		Usually, this happens when a file is deleted from EN tree but not yet synced in the chosen language.

-	After double-clicking, a new tab will open and you can view the files contents. It cannot be edited here.	+	After double-clicking, a new tab will open and you can view the file's contents. It cannot be edited here.

	Right-click on it and choose "Remove this file" to add it to Pending Commit module.		Right-click on it and choose "Remove this file" to add it to Pending Commit module.
Line 143:		Line 143:
	This module lists all files which have been modified by you, or by other peoples (authenticated or not) for English files, and for the chosen language.		This module lists all files which have been modified by you, or by other peoples (authenticated or not) for English files, and for the chosen language.

-	All action (and sub-menus) depend on where the file have been modified.	+	All action (and sub-menus) depend on where the file has been modified.

	== File modified from "Need Translate" module ==		== File modified from "Need Translate" module ==
Line 186:		Line 186:
	The context-menu is identical to the context-menu of a file modified from "Need Update" module.		The context-menu is identical to the context-menu of a file modified from "Need Update" module.

-	==== Commiting changes ====	+	==== Committing changes ====
	From all of this, there is a default sub-menu "Commit..." which allows you to:		From all of this, there is a default sub-menu "Commit..." which allows you to:

feeds

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

2026/05/18 17:30	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}}

git

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

2017/09/22 13:28		current
Line 63:		Line 63:
	''doc-en Wrapper Repository Example''		''doc-en Wrapper Repository Example''
	git init phpdoc-en		git init phpdoc-en
-	git submodule add phpdoc-en/doc-base git://github.com/php/phpdoc-base.git	+	git submodule add git://github.com/php/doc-base.git phpdoc-en/doc-base
-	git submodule add phpdoc-en/en git://github.com/php/phpdoc-en.git	+	git submodule add git://github.com/php/doc-en.git phpdoc-en/en

	== Attributes ==		== Attributes ==

howto

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

2011/07/10 22:51		current
Line 1:		Line 1:
-	===== HOWTO contribute to the PHP Manual =====	+	This page has been removed, in favor of [[http://doc.php.net/tutorial/\|new guide]]
-		+
-	=== Introduction ===	+
-		+
-	PHP is well known for having excellent documentation, documentation that is created by volunteers who collectively make changes every day. This HOWTO is designed for people who work on the official PHP documentation. See also http://www.php.net/docs for viewable and downloadable versions of the PHP manual.	+
-		+
-	This HOWTO contains information about every aspect of the documentation process, which includes editing the DocBook XML sources, validating changes made to these sources, using the build system to generate documentation into other formats, and general tips like how to use SVN.	+
-		+
-	Related to this HOWTO is the simple README file that lives within the [[http://svn.php.net/viewvc/phpdoc/\|phpdoc SVN module]]. It's a quick guide for those already familiar with the basics of XML and SVN.	+
-		+
-	=== TOC ===	+
-		+
-	* [[doc/howto/gettingstarted]] - Getting started and setup to handle the docs	+
-	* [[doc/howto/communication]] - How the Documentation team communicates	+
-	* [[doc/howto/docbook]] - Information about DocBook, which is how the sources are stored	+
-	* [[doc/howto/translations]] - Translation specific information	+
-	* [[doc/howto/pecldocs]] - PECL specific information	+
-	* [[doc/howto/faq]] - Frequently asked questions	+
-	* [[doc/howto/structure]] - Structure of the docs	+
-	* [[doc/howto/skeletons]] - Doc XML skeletons	+
-	* [[doc/howto/styleguide]] - Style Guide	+
-	* [[doc/howto/editing]] - Editing, validating and building the docs	+
-		+
-	=== Feedback ===	+
-		+
-	Feedback is most certainly welcome on this document. Without your submissions and input, this document wouldn't exist. Please send your additions, comments and criticisms to the following email address: <phpdoc@lists.php.net>.	+

installation

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

2026/05/18 17:30	current
Line 1:	Line 1:
	+	====== Installing PHP from source on different Linux distributions ======
	+	* [[doc:installation:debian\|Installing PHP from source on Debian]]

phd

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

2009/10/16 17:02		current
Line 52:		Line 52:
	This will create		This will create
	* "php" directory containing the "phpweb" files		* "php" directory containing the "phpweb" files
-	* "html" direcotry containing the "downloadable chunked html" files	+	* "xhtml" direcotry containing the "downloadable chunked html" files
-	* "bightml.html" file, which is the "downloadable bightml" file	+	* "bigxhtml" file, which is the "downloadable bightml" file

	See the "[[doc/phd/view\|Viewing the results]]" for various ways of viewing the rendered files.		See the "[[doc/phd/view\|Viewing the results]]" for various ways of viewing the rendered files.

scratchpad

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

2011/04/06 10:59		current
Line 4:		Line 4:
	===== Topics =====		===== Topics =====
	* [[doc:scratchpad:upgrade\|Upgrade/migration Documentation]]		* [[doc:scratchpad:upgrade\|Upgrade/migration Documentation]]
-	* [[doc:scratchpad:howto\|The Documentation HOWTO]]
	* [[doc:howto:translations\|How to do Translations for the Manual]]		* [[doc:howto:translations\|How to do Translations for the Manual]]
	* [[doc:scratchpad:pecldocs\|How to document a PECL extension]]		* [[doc:scratchpad:pecldocs\|How to document a PECL extension]]

todo

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

2017/11/15 16:05		current
Line 1:		Line 1:
	==== Existing TODO files ====		==== Existing TODO files ====
		+
		+	== Priority Tasks ==
		+	* [[doc:todo:migrationguide\|Things that needs to be documented before the next big release (PHP 7.2.0)]]

	== General tasks ==		== General tasks ==

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

2014/04/06 10:30		current
Line 1:		Line 1:
-	==== Documentation related articles ====	+	This page has been removed, in favor of [[http://doc.php.net/tutorial/\|new guide]]
-	* [[doc:articles:localdocsetup\|Setting up Documentation environment]]	+
-	* [[doc:articles:nomenclature\|Nomenclature guide]]	+
-	* [[doc:articles:whitespace\|Why whitespace is important in phpdoc]]	+
-	* [[doc:articles:newtranslation\|Adding a new translation]]	+
-	* [[doc:articles:updating-markup\|Updating documentation to new OO markup]] - historical document	+

2011/04/06 10:59		current
Line 4:		Line 4:
	===== Topics =====		===== Topics =====
	* [[doc:scratchpad:upgrade\|Upgrade/migration Documentation]]		* [[doc:scratchpad:upgrade\|Upgrade/migration Documentation]]
-	* [[doc:scratchpad:howto\|The Documentation HOWTO]]
	* [[doc:howto:translations\|How to do Translations for the Manual]]		* [[doc:howto:translations\|How to do Translations for the Manual]]
	* [[doc:scratchpad:pecldocs\|How to document a PECL extension]]		* [[doc:scratchpad:pecldocs\|How to document a PECL extension]]