PHP Wiki doc:todo

doc:todo:changelog

2009-04-28T21:40:06+00:00

	current
Line 1:	Line 1:
	+	=== Changelog evaluation ===
	+	Each function/method has its own changelog. However, how they are written has introduced inconsistencies into the documentation.

	+	=== TODO ===
	+	Determine the official route for:
	+	* Order: Do newest PHP versions go on top or bottom?
	+	* Format: Is it PHP 5, 5, 5.0, or 5.0.0?
	+	* Information: Would the documentation make sense without the changelog entries? It should.
	+
	+	Next, evaluate each changelog and ensure it adheres to our official scheme.
	+
	+	And lastly, document this scheme within the HOWTO.

doc:todo:gwynne

2009-08-07T08:30:04+00:00

1249477623		current
Line 1:		Line 1:
	* Complete Zend Engine 2 documentation		* Complete Zend Engine 2 documentation
	* Write Zend Engine 3 documentation (Unicode support)		* Write Zend Engine 3 documentation (Unicode support)
-	* Write SAPI documentation (would resolve [[http://bugs.php.net/bug.php?id=10528\|#10528]])	+	* Write SAPI documentation

doc:todo:include

2009-04-28T21:36:09+00:00

	current
Line 1:	Line 1:
	+	=== Include() docs rewrite ===
	+	The documentation for include() is rather messy and needs simplification. This is perhaps the most common construct used in PHP and should be treated as such.

	+	=== Notes ===
	+	The require() and _once() documentation all refer to include(), and this is good.
	+
	+	=== TODO ===
	+	Evaluate the page, and rewrite.

doc:todo:inicleanup

2009-05-18T03:35:35+00:00

	current
Line 1:	Line 1:
	+	=== INI Documentation cleanup ===
	+	The ini information is scattered around the PHP Manual and needs cleanup and reorganization.

	+	The sections in question:
	+	* http://php.net/manual/en/ini.php (appendix)
	+	* http://php.net/manual/en/configure.php (appendix)
	+	* http://php.net/manual/en/configuration.php (installation and configuration)
	+	* php.ini files
	+	* Each extension (has its own ini section)
	+	* phpdoc/scripts/iniupdate
	+
	+	=== Problems ===
	+	Difficult to find. Should be easy to find a list of all directives.
	+
	+	This applies mainly to runtime directives but compile time should also be considered and dealt with.
	+
	+	=== TODO ===
	+	* Evaluation situation
	+	* List each section and update this TODO
	+	* Determine how best to present the information
	+	* Discuss and implement

doc:todo:install

2009-04-28T16:35:15+00:00

	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.

doc:todo:installrole

2009-04-28T21:33:27+00:00

	current
Line 1:	Line 1:
	+	=== Installation section rewrite ===
	+	Each extension has its own configuration and installation section, and these sections don't really follow a standard. We need a standard.
	+
	+	=== OS ===
	+	The main issue is Windows versus Unix. Currently this is done in many ways so it's rather confusing.
	+
	+	For details, see: http://markmail.org/message/c7hz3yycg4mvyje5
	+
	+	=== PECL ===
	+	Whether or not an extension is in PECL is another issue, as is worrying about if it moved to or from PHP core.
	+
	+	=== TODO ===
	+	Essentially this task involves three steps.
	+
	+	* Evaluate the current situation
	+	* Propose a format that each extension will use
	+	* Implement

doc:todo:kalle

2008-09-11T09:41:13+00:00

1224518578		current
Line 3:		Line 3:
	* <del>Close [[bugid@43728]]</del>		* <del>Close [[bugid@43728]]</del>
	* <del>Close [[bugid@44155]]</del>		* <del>Close [[bugid@44155]]</del>
-	* Close [[bugid@46183]]	+	* <del>Close [[bugid@46183]]</del>
-	* Finish and commit class_alias() function in the manual	+
	* <del>Merge updated PECL Installation on Windows patch into cvs</del>		* <del>Merge updated PECL Installation on Windows patch into cvs</del>
	* <del>Add a couple of examples for touch() and stat functions</del>		* <del>Add a couple of examples for touch() and stat functions</del>
-	* More reorganization of reserved.php
	* <del>Add usage examples for remaining functions in GD</del>		* <del>Add usage examples for remaining functions in GD</del>
	* <del>Missing description for imageftbbox below prototype</del>		* <del>Missing description for imageftbbox below prototype</del>
-	* Change examples on the main GD examples to use resampling instead of resizing

doc:todo:logdownloads

2009-05-21T21:27:28+00:00

	current
Line 1:	Line 1:
	+	=== Log Downloads ===
	+	This idea involves logging (tracking) downloads, namely from here:

	+	* http://www.php.net/download-docs.php
	+	* http://www.php.net/downloads.php
	+
	+	The code should:
	+
	+	* Never interfere with ability to download
	+	* Be efficient
	+	* Track information like for example: file name, timestamp of download, file size, manual build date, ?user info?, ...
	+	* Consider being used for other parts of the site, like php source code downloads (ex: php-5.x.x.tar.gz)
	+	* Consider being used for other sites, like snaps.php.net
	+
	+	=== Related files ===
	+	* CVS Module: phpweb (the www.php.net website)
	+	* http://cvs.php.net/viewvc.cgi/phpweb/downloads.php?view=log
	+	* http://cvs.php.net/viewvc.cgi/phpweb/download-docs.php
	+	* http://cvs.php.net/viewvc.cgi/phpweb/include/do-download.inc
	+	* Helper functions spread around elsewhere
	+	* CVS Module: phpdoc (the sources to the php manual)
	+	* None needed.
	+	* CVS Module: php-master-web (the master.php.net website)
	+	* Very old, not used: http://cvs.php.net/viewvc.cgi/php-master-web/log_download.php
	+	* CVS Module: phd (the documentation build system)
	+	* None needed. But, it might be adjusted to, for example, create unique ids for each build
	+
	+	=== History ===
	+	Long ago we tracked downloads but it was disabled [in 2004] for a few reasons:
	+	* One day the master server went down, and this stopped the downloads from working
	+	* The data wasn't really used
	+	* Nobody felt the need to work on it
	+
	+	=== Status ===
	+	How exactly this will work is unknown. A few questions needing answers:
	+	* How will the data be stored? (Note: write heavy, few reads)
	+	* Where will the data be stored? (Master?)
	+	* Is this useful data? (worth the performance hit?)
	+	* How will the data be compiled and presented?
	+	* Each mirror should behave the same, and work without too much trouble... how?
	+	People who are working on it:
	+	* Probably nobody... you?
	+
	+	=== Notes ===
	+	It would be helpful to determine and document exactly how our download system works. For example, a 404 handler sees /get/ then ...

doc:todo:mysqlnd_vs_libmysql

2009-11-05T12:21:40+00:00

1256306494		current
Line 25:		Line 25:
	* asynchronous queries		* asynchronous queries
	* 100+ statistics		* 100+ statistics
		+	* security: mysqlnd can inspect LOAD LOCAL INFILE and check open_basedir setting, libmysql won't care about open_basedir. libmysql allows accessing files which other PHP functions cannot access, if open_basedir is set

	in general		in general

doc:todo:per-release-all

2008-03-10T01:38:35+00:00

	current
Line 1:	Line 1:
	+	==== TODO for every PHP release ====

	+	== Installation files ==
	+	Two files are generated from the Installation section of the manual, and updated into php-src. They are:
	+	* [[http://cvs.php.net/viewvc.cgi/php-src/INSTALL?view=log\|php-src/INSTALL]]
	+	* [[http://cvs.php.net/viewvc.cgi/php-src/win32/install.txt?view=log\|php-src/win32/install.txt]]
	+	These files are generated from the installation chapter, run through lynx, and saved. Several chapters are intentionally excluded first. (FIXME: Which are excluded? How to use PhD to do this update?)
	+
	+	== Version Information ==
	+	Update the version information contained within the manual. FIXME: How to do this now is under construction.
	+
	+	== INI options update ==
	+	Update the ini information. The scripts to do this are in [[http://cvs.php.net/viewvc.cgi/phpdoc/scripts/iniupdate/\|phpdoc/scripts/iniupdate]] and also this version number is specified in [[http://cvs.php.net/viewvc.cgi/phpdoc/en/appendices/configure/index.xml\|appendices/configure/index.xml]]

doc:todo:per-release-major

2008-03-10T01:41:24+00:00

	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]]

doc:todo:per-release-minor

2008-03-10T01:39:29+00:00

	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.

doc:todo:phd

2009-10-02T17:57:45+00:00

1239286007		current
Line 4:		Line 4:
	* PhD-Setup (replaces configure.php and several phpdoc/scripts/*)		* PhD-Setup (replaces configure.php and several phpdoc/scripts/*)
	* PhD-Build (replaces .manual.xml generation)		* PhD-Build (replaces .manual.xml generation)
-	* Split up into different packages: phd core, phd xhtml, phd pdf, and theme packages
-	* "so I could do pear install phd && pear install phd-xhtml && pear install phd-peardoc or pear install phd-all to install everything"
	* Gtk "theme"		* Gtk "theme"
-	* Create a true indexer
-	* Use PEAR style class naming and class locations
	* Implement the rest of the standard DocBook elements+attributes		* Implement the rest of the standard DocBook elements+attributes
-	* Implement default "themes" for all formats
-	* Support for dbhtml processing instructions
-	* Make it generic for the world to use
	* Close [[http://bugs.php.net/search.php?limit=All&cmd=display&status=Open&bug_type%5B%5D=Doc+Build+problem\|PhD Bugs and feature requests]]		* Close [[http://bugs.php.net/search.php?limit=All&cmd=display&status=Open&bug_type%5B%5D=Doc+Build+problem\|PhD Bugs and feature requests]]

doc:todo:philip

2009-05-28T06:19:52+00:00

1236015760		current
Line 16:		Line 16:
	* Mention ' ' and '.' turn to '_' via HTTP request		* Mention ' ' and '.' turn to '_' via HTTP request
	* Organize the FAQ effort started, helping		* Organize the FAQ effort started, helping
-	* Help find someone to create the Indexer for [[PhD]]	+	* <del>Help find someone to create the Indexer for [[PhD]] Hannes and a GSoC student</del>
	* Find/build server to build past php versions for testing of doc changelogs, and testing how FC we were/are		* Find/build server to build past php versions for testing of doc changelogs, and testing how FC we were/are
	* Document flags and <del>context parameters (bjori)</del> somewhere, like why we use \| and constants		* Document flags and <del>context parameters (bjori)</del> somewhere, like why we use \| and constants
Line 27:		Line 27:
	* <del>Group all [[http://tinyurl.com/4vufw\|open doc bugs]] by category/extension/etc. and encourage people to add info (and mark them as verified)</del>		* <del>Group all [[http://tinyurl.com/4vufw\|open doc bugs]] by category/extension/etc. and encourage people to add info (and mark them as verified)</del>
	* <del>Document the inclued extension partially done</del>		* <del>Document the inclued extension partially done</del>
-	* grep -ir "linkend='function" \|wc -l --> (~300)	+	* <del>Cleanup: grep -ir "linkend='function" \|wc -l --> (~300)</del>
	* Fix xml:id's and update appropriate translations		* Fix xml:id's and update appropriate translations
	* Go through every extensions documentation and clean up reference/setup/book information.		* Go through every extensions documentation and clean up reference/setup/book information.

doc:todo:ross

2008-11-01T19:53:46+00:00

1225572019		current
Line 4:		Line 4:
	Working on further documenting the [[http://docs.php.net/datetime/\|datetime]] reference.		Working on further documenting the [[http://docs.php.net/datetime/\|datetime]] reference.

-	- [[http://uvshock.co.uk/DateTimeTodo.txt\|Todo List]]	+	- [[http://uvshock.co.uk/DateTimeTodo.txt\|Todo List]]

	=== Other Tasks ===		=== Other Tasks ===

doc:todo:translations

2008-03-21T18:16:25+00:00

1205809209		current
Line 2:		Line 2:
	These are TODO items to help translations of the PHP Manual.		These are TODO items to help translations of the PHP Manual.

-	* Update the new reference style so translations will build (wip - philip)	+	* [[doc:todo:translations:refstruct-progress\|Update the new reference style]] so translations will build (wip - philip)
	* Review the translations HOWTO		* Review the translations HOWTO
	* Define "dead translation"		* Define "dead translation"

doc:todo:undocumented

2009-02-03T17:31:14+00:00

1231506920		current
Line 326:		Line 326:
	* //function.session//: "if you try to name a php session "example.com" it gets converted to "example_com" and everything breaks." ([[http://www.php.net/manual/en/function.session-name.php#86000\|note]])		* //function.session//: "if you try to name a php session "example.com" it gets converted to "example_com" and everything breaks." ([[http://www.php.net/manual/en/function.session-name.php#86000\|note]])

		+	===== Internals =====
		+
		+	* Opcodes: http://markmail.org/thread/gk6hul5mvoyuhgfw
		+	* Arginfo for reflection: http://tmp.cweiske.de/HackingPHP5.xml

doc:todo:yearly

2008-03-10T01:27:50+00:00

	current
Line 1:	Line 1:
	+	==== TODO to begin each calendar year ====

	+	== License years ==
	+	The main update, important places to check:
	+	* phpdoc/scripts
	+	* phpdoc/
	+	* docweb/
	+	* phd/