Commit: 509047ee8687a7bad5cbcb739e4558f7d1c2dde3
Author: Sobak <[email protected]> Thu, 19 Jun 2014 17:36:50 +0200
Parents: 4d944db82f9514e2b00421d76056a2b32a35ac9f
Branches: master
Link: http://git.php.net/?p=web/doc.git;a=commitdiff;h=509047ee8687a7bad5cbcb739e4558f7d1c2dde3
Log:
More fixes...
Changed paths:
M tutorial/faq.md
M tutorial/joining.md
Diff:
diff --git a/tutorial/faq.md b/tutorial/faq.md
index c6c7a4f..9b8f10a 100644
--- a/tutorial/faq.md
+++ b/tutorial/faq.md
@@ -8,7 +8,7 @@ php docgen.php -e simplexml -o outdir
It creates the skeletons that you edit, and then commit.
-Help is available with following command: `$ php docgen.php -h`.
+Help is available with following command: `php docgen.php -h`.
## I created skeletons that contain a bunch of default text, should I commit it?
No! Edit the files, to check the generated content and add more information,
@@ -23,7 +23,7 @@ Note: This disables some error checking and beautification but raw errors will b
Note: Usually the problem is a major XML syntax issue.
## Is there an online editor?
-Yes, just go to [edit.php.net](https://edit.php.net).
+Yes, just go to [edit.php.net][editor]. Our wiki contains an [overview of the editor and how to use it][editor-tutorial].
## How do I add a link to a method?
Use `<methodname>Class::method</methodname>`. Note that the case does not matter when adding a link.
@@ -56,7 +56,7 @@ Typically titles are useful for notes, but it's not required.
## A feature became available in PHP X.Y.Z, how do I document that?
Version information for functions is stored inside `versions.xml` within
-each extension (e.g. `phpdoc/en/extname/version.xml`). Changes to functions,
+each extension (e.g. `phpdoc/en/extname/versions.xml`). Changes to functions,
like added parameters, are documented within the changelog section for each page.
## A parameter is optional, how is it documented?
@@ -93,3 +93,6 @@ Examples: `entities/file-entities.ent` and `en/reference/foo/entities.bar.xml`
```
*.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
```
+
+[editor]: https://edit.php.net
+[editor-tutorial]: https://wiki.php.net/doc/editor
diff --git a/tutorial/joining.md b/tutorial/joining.md
index 55ff02d..1b8b96c 100644
--- a/tutorial/joining.md
+++ b/tutorial/joining.md
@@ -18,19 +18,23 @@ You should send your message to the appropriate `doc-{LANG}@lists.php.net` maili
This step is required to show us that you are a real human, you want to do
some work and in general know how to do this.
-The simplest way to get started is by using the [Online Documentation Editor](https://edit.php.net)
+The simplest way to get started is by using the [Online Documentation Editor][editor].
which allows you to login via your Facebook/Twitter/Google account and edit the documentation.
Your patches will be then reviewed and accepted by someone with SVN access.
-Our wiki contains an [overview of the editor and how to use it](https://wiki.php.net/doc/editor).
+Our wiki contains an [overview of the editor and how to use it][editor-tutorial].
## Obtaining SVN access
If you plan to contribute to the manual regularly, and want to do this more efficiently,
you probably would like to use SVN directly. This requires a PHP.net account.
-To request one, please fill in [this form](http://php.net/git-php.php).
+To request one, please fill in [this form][request-account].
Provide links to your work that has already been committed and/or list your current patches.
Basically, tell us what have done, to prove that you really need this account.
The next chapter will explain how to get the manual sources and how are they [structured](structure.php).
+
+[request-account]: http://php.net/git-php.php
+[editor]: https://edit.php.net
+[editor-tutorial]: https://wiki.php.net/doc/editor
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.