com web/doc: Clarified the download section: tutorial/structure.md
[email protected] (Maciej Sobaczewski) Thu, 14 Sep 2017 19:16:55 +0000
| Newsgroups | php.doc.web |
|---|---|
| Message-ID | <[email protected]> |
Commit: 38fa42515932bd5e5d9fa1df138effb0a140a395=0AAuthor: Philip Ols= on <[email protected]> Thu, 14 Sep 2017 12:16:55 -0700=0ACommitte= r: GitHub <[email protected]> Thu, 14 Sep 2017 12:16:55 -0700=0AParen= ts: f4aa155a0ea348133b879459e2b613c1f12441c5=0ABranches: master=0A=0ALin= k: http://git.php.net/?p=3Dweb/doc.git;a=3Dcommitdiff;h=3D38fa4251593= 2bd5e5d9fa1df138effb0a140a395=0A=0ALog:=0AClarified the download section=0A= =0AClarified the download section to include additional information and exa= mples, including information about svn externals.=0A=0AChanged paths:=0A M= tutorial/structure.md=0A=0A=0ADiff:=0Adiff --git a/tutorial/structure.md = b/tutorial/structure.md=0Aindex 2b6b851..a2ffe3b 100644=0A--- a/tutorial/st= ructure.md=0A+++ b/tutorial/structure.md=0A@@ -1,26 +1,49 @@=0A # Manual so= urces structure=0A =0A-## Downloading sources=0A+## Downloading the PHP Doc= umentation Source=0A The PHP Manual sources are currently stored in our Sub= version (SVN) repository.=0A You don't need SVN access to checkout (downloa= d) the files, but you do need it=0A if you want to send your changes to our= server.=0A =0A-This tutorial assumes that you have basic knowledge about S= VN.=0A-If not, you can read [Version Control with Subversion](http://svnboo= k.red-bean.com/).=0A-In order to checkout the manual files, use the followi= ng command:=0A+This tutorial assumes that you have basic terminal and Subve= rsion knowledge, although=0A+don't worry if you've never used Subversion as= only basic commands are used, and our=0A+setup is simple (e.g., no branche= s).=0A+=0A+To checkout the documentation source, use a modified version of = the following command=0A+where you change `{LANG}` to a desired language, s= uch as `en` for only English:=0A+=0A+```=0A+svn checkout https://svn.php.ne= t/repository/phpdoc/modules/doc-{LANG} phpdoc-{LANG}=0A+```=0A+=0A+This com= mand creates a directory named `phpdoc-{LANG}` because the source is =0A+th= e first 'svn checkout' argument, and the second argument defines the direct= ory name =0A+that stores the checked out directories and files (this name c= an be anything you wish).=0A+This directory will contain a directory with t= he sources of your chosen language,=0A+named *{LANG}*, and also *doc-base* = folder, which is home to some helpful tools.=0A+The "en" language will alwa= ys be present, as explained below.=0A+=0A+The documentation source is store= d under "en". To only edit the source files, and=0A+not a translation, use:= =0A =0A ```=0A-svn checkout https://svn.php.net/repository/phpdoc/modules/d= oc-{LANG} phpdoc=0A+svn checkout https://svn.php.net/repository/phpdoc/modu= les/doc-en phpdoc-en=0A ```=0A =0A-This command will create a directory nam= ed `phpdoc` (the name can be anything you wish).=0A-This directory will con= tain a folder with the sources of your chosen language=0A-(named *{LANG}*) = and a *doc-base* folder, which is home to some helpful tools.=0A+The "modul= es" directory used by these examples defines a set of SVN external definiti= ons =0A+that are configured to checkout multiple source directories. For ex= ample:=0A+=0A+- *doc-en*: checks out "en" and "doc-base"=0A+- *doc-fr*: che= cks out "en", "fr", and "doc-base"=0A+- *doc-all*: checks out all languages= (there are a lot!) along with "en" and "doc-base"=0A+=0A+For example, to t= ranslate the manual into French, use "doc-fr" instead of "doc-en":=0A+=0A+`= ``=0A+svn checkout https://svn.php.net/repository/phpdoc/modules/doc-fr php= doc-fr=0A+```=0A =0A-When checking-out manual sources, you can also supply = *all* as *{LANG}* making your=0A-URL `https://svn.php.net/repository/phpdoc= /modules/doc-all`. This is kind of "magical" module,=0A-which fetches every= single language version of the manual, as well as `doc-base` folder=0A-int= o your `phpdoc` dir.=0A+For additional information about language codes and= available translations, see `http://doc.php.net/revcheck.php`.=0A =0A ## F= iles structure=0A **Note for translators:** if any of the source files don'= t exist in your translation, the English content will be used=0A