Index: docsformat.mdtext =================================================================== --- docsformat.mdtext (revision 1737345) +++ docsformat.mdtext (working copy) @@ -27,7 +27,7 @@ directory](http://httpd.apache.org/docs/2.2/style/) of the manual. An example of the format with extensive comments is also available in [mod_template.txt](mod_template.txt). Obviously, the file extension should -be `xml`. It was changed to make online viewing simpler. +be `xml`. It was changed to make the online viewing simpler. To ensure that your documentation follows the defined format, you should parse it using the DTD. Some help using Emacs with XML files is available @@ -42,6 +42,27 @@ <highlight language="config"> ... </highlight> A configuration example, syntax highlighted. Can also use language="perl", "lua", or "C" + +When translating the documentation, you should know the following: + +- Set UTF-8 charset to your editor. +- We suggest you use the trunk branch of the documentation, because it is in constant develop. +obviously you can use the [2.2.x](http://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x/docs/) or [2.4.x](http://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/docs/) thats in your onwn. +- Be aware that each line gots a max lenght of 80 characters, this is for a better read. +- Remember to change the top comment like: + > + To: + > + This is a good practice so we can keep track on + [what have been updated and translated (Trunk link)] (http://home.apache.org/~takashi/translation-status/test.html#trunk) +- Make sure you put your name at the top of the file. If you are translating or reviewer of the documentation like this: + + > + > + as shows the [translation page](translations.html) + +If you want to do any changes to the Web-page of the doc-project there is more information about how is made [here.](http://www.apache.org/dev/cmsref#markdown) + # Transformation # @@ -63,19 +84,31 @@ distributed under the Apache license. The only prerequisite for the transformation is a Java 1.2 or greater JVM -(which can be obtained free from Sun). Assuming you already have +(which can be obtained free from Oracle). Assuming you already have [httpd/httpd/branches/2.2.x/docs/](http://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x/docs/) -(or the equivalent from another branch) checked out from SVN, here is what -you need to do to build: (If you need instructions on setting up SVN, see -[this page](http://www.apache.org/dev/version-control.html).) +(or the equivalent from another branch for example +[2.4.x](http://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/docs/)) checked +out from SVN (If you need instructions on setting up SVN, see +[this page](http://www.apache.org/dev/version-control.html).). +##Here is what you need to do to build## +You have to add the build scripts files to the `/httpd-trunk/docs/manual/` location of your +actual working documentation brunch locally as shown below: + >$ cd docs/manual

$ svn co http://svn.apache.org/repos/asf/httpd/docs-build/trunk build

$ cd build

$./build.sh -If you are running under win32, the build.sh script will work if cygwin is +If every thing goes good you should get something like: +>BUILD SUCCESSFUL
Total time: 2 seconds + +If you are running under win32, the build.sh script will work if +[cygwin](https://www.cygwin.com/) is installed. Alternatively, on Win32, you should be able to run the `build.bat` script. +You may need to add the JAVA_HOME enviroment variable +when buillding the documentation, and change the amount of ram needed in the `.bat` file +if you get a `java.lang.StackOverflow` error. If you don't want to get the build files from SVN, you can download a pkzipped version of the current build tools from our [distribution