From e749191baf1988a898304d9c9060845b629d5ee5 Mon Sep 17 00:00:00 2001 From: Jordi Kroon Date: Tue, 4 Aug 2026 18:36:26 +0200 Subject: [PATCH 1/3] add README file --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..30aa16741 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# PHP Third-Party Extension Documentation + +This repository hosts documentation for third-party PHP extensions, +extensions maintained outside the [`php-src`](https://github.com/php/php-src) +repository (typically distributed via PECL or PIE). + +It exists as a result of +[the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/separation-of-third-party-extension-documentation), +and is intended to be rendered as part of the PHP manual at +[php.net/manual/extensions/](https://www.php.net/manual/extensions/). + +## Contributing + +Pull requests are welcome from anyone. Extension maintainers may additionally +request commit access. + +Each extension lives in its own directory under `reference/`. Only the English +canonical documentation is maintained here; per the RFC, existing translations +were not carried over from the main manual. + +For general guidance on the documentation format, refer to the +[contribution guidelines](https://doc.php.net/guide/contributing.md). + +## Building With make and Docker + +- Install Docker (https://docs.docker.com/get-docker/) +- Rebuild the documentation using `make` +- Open output/php-chunked-xhtml/ in your browser. + +If the `doc-base` or `phd` repositories are available in directories to the +adjacent to this directory, those will be used for building. + +To force the Docker image used for building to itself be rebuilt, you can run +`make -B build`, otherwise the `Makefile` will only build it if does not +already exist. + +You can also build the `web` version of the documentation with `make php` +and the output will be placed in output/php-web + +## Documentation pipeline + +For more information on the various repositories that make up PHP's documentation pipeline, +see this [overview](https://github.com/php/doc-base/blob/master/docs/overview.md). From a8fcb3f48bb0b3140ef94213868f46859d60e2a5 Mon Sep 17 00:00:00 2001 From: Jordi Kroon Date: Wed, 5 Aug 2026 10:27:41 +0200 Subject: [PATCH 2/3] readme: Link to correct RFC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 30aa16741..7733dc0fc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ extensions maintained outside the [`php-src`](https://github.com/php/php-src) repository (typically distributed via PECL or PIE). It exists as a result of -[the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/separation-of-third-party-extension-documentation), +[the RFC on separation of third-party extension documentation](https://wiki.php.net/rfc/third_party_ext_documentation), and is intended to be rendered as part of the PHP manual at [php.net/manual/extensions/](https://www.php.net/manual/extensions/). From 49485a2be27cad90755f7a1bf42a2ef2f922dbae Mon Sep 17 00:00:00 2001 From: lacatoire Date: Wed, 5 Aug 2026 11:42:12 +0200 Subject: [PATCH 3/3] Add the shared documentation snippets as XML entities The extension pages migrated out of the main manual reference snippets that live in doc-en/language-snippets.ent, which is not carried over. Without them the manual does not parse, as an undefined entity is a fatal XML error rather than a warning. They are added as XML entities under entities/, per the policy for this repository, rather than as DTD entities. Three of them link into the main manual and now go through the entities of entities/main-manual.ent instead of a linkend that has no target here. --- entities/entities.snippets.ent | 87 ++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 entities/entities.snippets.ent diff --git a/entities/entities.snippets.ent b/entities/entities.snippets.ent new file mode 100644 index 000000000..0ace3030f --- /dev/null +++ b/entities/entities.snippets.ent @@ -0,0 +1,87 @@ + + + + +The above example will output: + +The above example will output +something similar to: + + +The constants below are defined by this extension, and +will only be available when the extension has either +been compiled into PHP or dynamically loaded at runtime. + + + +The behaviour of these functions is affected by settings in &php.ini;. + + +This method is an alias of: + +Here's a short explanation of +the configuration directives. + + + This extension requires the &link.book.libxml; PHP extension. + This means passing the , + or prior to PHP 7.4 the , + configuration flag, although this is implicitly accomplished because libxml + is enabled by default. + + +This extension has no configuration directives defined in &php.ini;. + +This function has no parameters. + +Information for installing this PECL extension may be +found in the manual chapter titled &link.install.pecl;. Additional information +such as new releases, downloads, source files, maintainer information, and a +CHANGELOG, can be located here: + +This extension is considered unmaintained and dead. +However, the source code for this extension is still available within +PECL SVN here: + +This &link.pecl; extension is not bundled with PHP. + +A DLL for this +PECL extension is currently unavailable. See also the +&link.install.windows.building; section. + +Windows binaries (DLL files) +for this PECL extension are available from the PECL website. + + or &false; on failure + +Returns &true; on success&return.falseforfailure;. + +No value is returned. + +This extension is +EXPERIMENTAL. The behaviour of this extension including +the names of its functions and any other documentation surrounding this +extension may change without notice in a future release of PHP. +This extension should be used at your own risk. + +This function is +EXPERIMENTAL. The behaviour of this function, its name, and +surrounding documentation may change without notice in a future release of PHP. +This function should be used at your own risk. + + +This function is +currently not documented; only its argument list is available. + + +