com web/doc: Adjust internal URLs to the parsing engine: tutorial/builds.md tutorial/editing.md tutorial/intro.md tutorial/joining.md
tutorial/structure.md tutorial/translating.md

From: Date: Thu, 19 Jun 2014 12:08:02 +0000
Subject: com web/doc: Adjust internal URLs to the parsing engine: tutorial/builds.md tutorial/editing.md tutorial/intro.md tutorial/joining.md
tutorial/structure.md tutorial/translating.md
Groups: php.doc.web 
Request: Send a blank email to doc-web+get-2376@lists.php.net to get a copy of this message
Commit: 3211853e490462a957d7b2c999c966b5de62482b Author: Sobak <msobaczewski@gmail.com> Thu, 19 Jun 2014 14:08:02 +0200 Parents: f159d47c82918bc7e0136a522df8061940a21891 Branches: master Link: http://git.php.net/?p=web/doc.git;a=commitdiff;h=3211853e490462a957d7b2c999c966b5de62482b Log: Adjust internal URLs to the parsing engine Changed paths: M tutorial/builds.md M tutorial/editing.md M tutorial/intro.md M tutorial/joining.md M tutorial/structure.md M tutorial/translating.md Diff: diff --git a/tutorial/builds.md b/tutorial/builds.md index 76b8fde..8d098cd 100644 --- a/tutorial/builds.md +++ b/tutorial/builds.md @@ -21,7 +21,7 @@ The CHM version of the manual is built on a Windows machine and pulled on Friday for distribution to mirrors. [Richard][rquadling] maintains these builds. ## Validation -Aside from running php configure.php –with-lang=foo (see [editing](editing.md)) +Aside from running php configure.php –with-lang=foo (see [editing](editing.php)) for a language, another way to check if the docs validated is by looking at build dates on the doc server. See "Doc server builds", above. diff --git a/tutorial/editing.md b/tutorial/editing.md index bf6b94d..6bf3ed8 100644 --- a/tutorial/editing.md +++ b/tutorial/editing.md @@ -3,7 +3,7 @@ ## Introduction When editing or translating the manual, you have to remember some things: - use only UTF-8 encoding -- follow the project's [style guidelines](style.md) +- follow the project's [style guidelines](style.php) ## Editing existing documentation Simply open the files and edit them. @@ -26,10 +26,10 @@ cp /phpdoc/RFC/skeletons/function.xml functions/functionname.xml #for new functi Note: *classname*, *methodname* and *functionname* are lowercased names of the class, method, or function, respectively, not a literal file name. -Remember the extension folder [structure](structure.md) when copying those files. +Remember the extension folder [structure](structure.php) when copying those files. ## Translating documentation -The translation process is described in the [translating chapter](translating.md). +The translation process is described in the [translating chapter](translating.php). ## Validating your changes Every time you make changes to documentation sources (both English or translation), @@ -54,9 +54,9 @@ there is a special mirror at [docs.php.net][docs] - where the manual is updated from sources every six hours. If any errors occured, a message will be delivered to the appropriate mailinglist (doc-{LANG}@lists.php.net). -Read more about manual builds in the [builds appendix](builds.md). +Read more about manual builds in the [builds appendix](builds.php). -The next chapter contains [style guidelines](style.md) that you are obliged to +The next chapter contains [style guidelines](style.php) that you are obliged to follow. Read them carefully. [docgen]: http://svn.php.net/viewvc/phpdoc/doc-base/trunk/scripts/docgen/ diff --git a/tutorial/intro.md b/tutorial/intro.md index 2e13de6..2bbe430 100644 --- a/tutorial/intro.md +++ b/tutorial/intro.md @@ -18,15 +18,15 @@ This guide uses some terminology that you have to know. Don't worry, it's easy: mailing list suffix. ## Table of Contents -- [Joining the team](joining.md) -- [Documentation structure](structure.md) -- [Editing the PHP Manual](editing.md) -- [Translating documentation](translating.md) -- [Style guidelines](style.md) +- [Joining the team](joining.php) +- [Documentation structure](structure.php) +- [Editing the PHP Manual](editing.php) +- [Translating documentation](translating.php) +- [Style guidelines](style.php) ## Appendices -- [FAQ](faq.md) -- [PHP Manual builds](builds.md) +- [FAQ](faq.php) +- [PHP Manual builds](builds.php) ## Feedback Feedback is most certainly welcome on this document. Without your submissions and input, this document wouldn't exist. diff --git a/tutorial/joining.md b/tutorial/joining.md index e5dc135..55ff02d 100644 --- a/tutorial/joining.md +++ b/tutorial/joining.md @@ -33,4 +33,4 @@ To request one, please fill in [this form](http://php.net/git-php.php). 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.md). +The next chapter will explain how to get the manual sources and how are they [structured](structure.php). diff --git a/tutorial/structure.md b/tutorial/structure.md index 92f268b..9469f24 100644 --- a/tutorial/structure.md +++ b/tutorial/structure.md @@ -47,4 +47,4 @@ And OO extensions (such as imagick) contain: Note: *classname* is the lowercased name of the class, not a literal file or directory name. -The next chapter will discuss how to [edit the manual sources](editing.md). +The next chapter will discuss how to [edit the manual sources](editing.php). diff --git a/tutorial/translating.md b/tutorial/translating.md index c869a64..898c27f 100644 --- a/tutorial/translating.md +++ b/tutorial/translating.md @@ -1,7 +1,7 @@ # Translating documentation **Watch out:** this chapter describes special parts of the whole editing process. -You will also have to follow other steps from the [editing manual sources](editing.md) section. +You will also have to follow other steps from the [editing manual sources](editing.php) section.. Translating documentation into other languages might look like a complicated process, but in fact, it's rather simple.

« previous php.doc.web (#2376) next »