phd -d .manual.xml
mkdir phpdoc cd phpdoc git clone git@github.com :php/doc-en.git en git clone git@github.com :php/doc-your-language-of-choice.git your-language-of-choice git clone git@github.com :php/doc-base.git
-
Make the change. Use spaces not tabs. Be sure to carefully watch your whitespace! -
cd into the desired clone directory, e.g. cd en -
Look at your unified diff, make sure it looks right and that whitespace changes aren't mixed in: git diff path/to/file.xml -
Make sure no errors are present, so at the command line in your phpdoc source directory run: php ../doc-base/configure.php -
If you are translating, remember to add the full Git commit hash of the English file that you are translating from, to the file's EN-Revision comment. -
Commit your changes git commit path/to/file.xml
-
Copy an existing XML file or use a skeleton from the HOWTO. Rename and place it into the appropriate directory. -
Edit. Be sure no leftover text exists. No tabs either. -
If you are translating, remember to add the full Git commit hash of the English file that you are translating from, to the file's EN-Revision comment. -
cd into the desired clone directory, e.g. cd en -
Now test locally before commit by first running php ../doc-base/configure.php -
Add the file to your staging area git add path/to/yourfile.xml -
Commit the file and push it to the git-server git commit path/to/yourfile.xml git push remote your-branch -
Open a pull request to the main repository via GitHub
<filename> filenames <constant> constants <varname> variables <parameter> a function's parameter/argument <function> functions, this links to function pages or bolds if already on the function's page. it also adds (). <literal> teletype/mono-space font <tt> <emphasis> italics <example> see HOWTO, includes many other tags. <link> internal manual links <link linkend="language.variables">variables</link> <link> external links via global.ent <link xlink:href="&spec.cookies;">mmm cookies</link> <type> types, this links to the given types manual page: <type>object</type> -> php.net/types.object &return.success; see: language-snippets.ent &true; < constant>TRUE</constant> &false; < constant>FALSE</constant> &php.ini; < filename>php.ini</filename>