httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1740745 - /httpd/site/trunk/content/docs-project/goingfurther.mdtext
Date Mon, 25 Apr 2016 00:17:15 GMT
Author: lgilbernabe
Date: Mon Apr 25 00:17:15 2016
New Revision: 1740745

This file has been Created by Lucien G. I have reviewed it. Explains the easy way to have
a translation ongoing work by the translators.


Added: httpd/site/trunk/content/docs-project/goingfurther.mdtext
--- httpd/site/trunk/content/docs-project/goingfurther.mdtext (added)
+++ httpd/site/trunk/content/docs-project/goingfurther.mdtext Mon Apr 25 00:17:15 2016
@@ -0,0 +1,126 @@
+Title: Translations - Documentation Project
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+# Introduction #
+In order to work more efficiently with your translations and keep them
+up-to-date, it's recommended that
+you download the svn repository into your computer, so you can regularly check what
+english files have been updated since your last visit/change, and transfer these
+changes to your existing translated files. Also, in this manner, you will be
+able to build locally the doc (transform it to HTML files) in order to see how
+your changes look like.
+Doc manual is divided in branches :
+- <b>trunk</b> : it's the development branch ; in other words, 2.4 branch plus
+  features, changes; you allways must begin to translate files in this branch,
+  then port your work to other branches.
+- <b>2.4</b> : It's the current stable branch, recommended for a prod server
+- <b>2.2</b> : it's the older branch still maintained.
+Good to see [what has already been
+translated]( and
+whether it's up to date or not.
+# Downloading svn repository #
+In order to work properly, you have to download the doc tree (svn repository) onto
+your computer :
+- Create a directory called <b>"httpd-doc"</b> on your computer : <em>mkdir
+  httpd-doc</em>
+- cd to this directory : <em>cd httpd-doc</em>
+- Download svn repository :
+	- <em>svn co
+	  httpd-trunk</em>
+	- <em>svn co
+	  httpd-2.4</em>
+	- <em>svn co
+	  httpd-2.2</em>
+- Note : svn is a powerful program; see more [here](svn.html) and of course
+  "svn --help".	  
+# New translations #
+Translate documents that are not yet translated as shown in [Translations
+# Maintaining your translations #
+There are several ways to do that.
+Here is the method I use since several years ; its probably not the best, but it
+will help you to get started.
+- cd to your repository root <b>"httpd-doc"</b>
+- Create a directory called <b>"working"</b> ; it will be use later : <em>mkdir
+  working</em>
+- Create a directory called <b>"sav"</b> (reference directory for updates detection
+  see below) : <em>mkdir sav</em>
+- Copy svn repository you downloaded above in <b>"sav"</b> directory :
+	- <em>cp -a httpd-trunk sav</em>
+	- <em>cp -a httpd-2.4 sav</em>
+	- <em>cp -a httpd-2.2 sav</em>
+- Once you have finished to work on a file, say <b></b>, save it to
+  corresponding directory in sav tree, along with its english version
+  <b>file.xml</b> ;
+  you'll understand why in a next step.
+- Say a week later, you wish to see if doc gurus have made some changes : cd to
+  your repository root <b>"httpd-doc"</b> which contains the different branches
+- Copy [this script](modifs-detection) in <b>"httpd-doc"</b> directory and launch
+  from there.
+Modifications will be displayed for each branch.
+- Suppose modifications for 2.4 branch contain this line :<br />
+	<b>U manual/bind.xml</b><br />
+	That means manual/bind.xml file has been modified since your last visit.
+In order to check these modifications, you have to compare the last version of
+manual/bind.xml with the one you have saved above into the <b>"sav"</b> directory
+during your last working session ; for
+this purpose, you can use the diff command this way:<br />
+	<em>diff sav/httpd-2.4/manual/bind.xml httpd-2.4/manual/bind.xml >
+- working/diff-bind file covers now all modifications you have to transfer after
+  translation to your own bind.xml.ll (ll-> Local Languaje), say for a (good)
+- When you're finished, don't forget to save your work  (new versions of
+  bind.xml and in the appropriate <b>"sav"</b> subdirectory).
+- In order to check how your modifications look like, you have to build the docs
+  to generate HTML files from xml ones (see [this document](docsformat.html)).
+- Once you're satisfied with your work, submit a patch to
+# Questions #
+Feel free to send your questions to

View raw message