doc:howto:gettingstarted

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
doc:howto:gettingstarted [2009/09/09 00:08] – initial commit, needs improvement philipdoc:howto:gettingstarted [2017/09/22 13:28] (current) – external edit 127.0.0.1
Line 1: Line 1:
-===== What is needed ===== +This page has been removed, in favor of [[http://doc.php.net/tutorial/|new guide]]
- +
-==== Subversion (SVN) ==== +
- +
-Since the documentation is stored in SVN, you'll need a SVN client. SVN is a common form of version control and every operating system has clients for this. A client does not mean a GUI although some people prefer GUI interfaces. The following list is not exhaustive put should provide an idea for what we're talking about. +
- +
-== Windows == +
- +
-The most common is TortoiseSVN. Here are the steps to checkout the sources of the PHP manual using it: +
-  * Download and install TortoiseSVN: [[http://tortoisesvn.net/]] +
-  * Open a new explorer window and go to the folder you wish to do the checkout into +
-  * Right click anywhere in the blank area to spawn the context menu, select "SVN Checkout..." +
-  * A new window will popup asking for details about the checkout, these values will be remembered, so you will not need to enter them again +
-  * Enter the following URL: "http://svn.php.net/repository/phpdoc", then 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 php documentation source tree will be +
- +
-== Mac == +
- +
-The command-line works fine, download/install the sources (or binaries) from [[http://subversion.tigris.org/]] +
- +
-== Linux == +
- +
-The command-line works fine, download/install the sources (or binaries) from [[http://subversion.tigris.org/]] +
- +
-==== The source files ==== +
- +
-Using SVN, checkout the source files of the PHP manual. These are the files you will edit and commit, and anyone (no account is required) may checkout these files. For example, using the command-line: +
- +
-  * svn checkout http://svn.php.net/repository/phpdoc/modules/phpdoc-en phpdoc +
- +
-That will use svn:externals to checkout both the doc-base and en/ modules, into a local directory named phpdoc. Then, after the above you might: +
- +
-  * cd phpdoc +
-  * vim en/preface.xml +
- +
-In other words, this will create a directory named 'phpdoc' with a subdirectory 'en' that contains all of the English files. Now, a translator will instead do something like the following (to checkout German): +
- +
-  * svn checkout http://svn.php.net/repository/phpdoc/modules/phpdoc-de phpdoc-de +
-  * cd phpdoc-de +
-  * vim de/preface.xml en/preface.xml +
- +
-==== PHP ==== +
- +
-You'll need a recent version of PHP. Since the build system requires PHP 5.3, you should probably install it. However, building the manual is optional as validation (ensuring XML changes are valid) is a separate process and will work with any version of PHP 5. +
- +
-==== PhD ==== +
- +
-The build system that builds both the downloadable and online versions of the PHP manual. It also builds the PEAR manual, and several other DocBook 5 based documents. Installing PhD is optional, however it's recommended so you may see what your changes will look like. +
- +
-==== A text editor ==== +
- +
-Any will do, as XML is simply text. Most text editors provide syntax highlighting for XML files. +
doc/howto/gettingstarted.1252454895.txt.gz · Last modified: 2017/09/22 13:28 (external edit)