| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| doc:howto:gettingstarted [2011/09/16 22:15] – [Joining the PHP Documentation team] rquadling | doc:howto:gettingstarted [2013/04/28 10:31] – Display '--' properly. leszek |
|---|
| 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: | 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 https://svn.php.net/repository/phpdoc/modules/doc-en phpdoc | * ''svn checkout https://svn.php.net/repository/phpdoc/modules/doc-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: | 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 | * ''cd phpdoc'' |
| * vim en/preface.xml | * ''vim en/preface.xml'' |
| * php doc-base/configure.php | * ''php doc-base/configure.php'' |
| |
| In other words, this will create a directory named 'phpdoc' with a subdirectory 'en' that contains all of the English files. And a 'doc-base' directory with files used to validate/build/help the process. Now, a translator will instead do something like the following (to checkout German): | In other words, this will create a directory named 'phpdoc' with a subdirectory 'en' that contains all of the English files. And a 'doc-base' directory with files used to validate/build/help the process. Now, a translator will instead do something like the following (to checkout German): |
| |
| * svn checkout https://svn.php.net/repository/phpdoc/modules/doc-de phpdoc-de | * ''svn checkout https://svn.php.net/repository/phpdoc/modules/doc-de phpdoc-de'' |
| * cd phpdoc-de | * ''cd phpdoc-de'' |
| * vim de/preface.xml en/preface.xml | * ''vim de/preface.xml en/preface.xml'' |
| * php doc-base/configure.php --with-lang=de | * ''php doc-base/configure.php %%--%%with-lang=de'' |
| |
| Note: The above can all be done anonymously, therefore does not require a SVN account. Going through the above process is required before gaining SVN access, as is submitting a few patches to the [[communication|phpdoc mailing list]]. After doing so, people realize your're both sane and serious, [[http://php.net/svn-php|apply for SVN access]] and it will granted so you may commit changes to the PHP documentation yourself. | Note: The above can all be done anonymously, therefore does not require a SVN account. Going through the above process is required before gaining SVN access, as is submitting a few patches to the [[communication|phpdoc mailing list]]. After doing so, people realize your're both sane and serious, [[http://php.net/svn-php|apply for SVN access]] and it will granted so you may commit changes to the PHP documentation yourself. |
| Any will do, as XML is simply text. Most text editors provide syntax highlighting for XML files. | Any will do, as XML is simply text. Most text editors provide syntax highlighting for XML files. |
| |
| Note: Please disable the 'remove ending whitespace' future of your text editor. | Note: Please disable the 'remove ending whitespace' feature of your text editor. |