Translating the Documentation - The Apache HTTP Server Project
Essentials ¶ Download! About License FAQ Security Reports Source Repositories ¶ General Information Trunk 2.4 Documentation ¶ Version 2.4 Trunk (dev) Wiki Get Involved ¶ Mailing Lists Bug Reports Developer Info User Support Subprojects ¶ Docs Test Flood Modules mod_fcgid Related Projects ¶ Apache Traffic Server Apache Traffic Control Tomcat APR mod_perl Miscellaneous ¶ Contributors Thanks! Sponsorship Privacy Translating the Documentation ¶ Thank you for considering a translation contribution!
Translations make the Apache HTTP Server documentation accessible to millions of non-English-speaking administrators worldwide. Before you begin, please: Read the general documentation project information . Subscribe to the docs mailing list . Introduce yourself — let us know which language you'll be working in. There may already be a team for your language who can help coordinate. Getting Started ¶ 1. Set Up Your SVN Checkout ¶ Check out the documentation source: svn checkout https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs httpd-trunk-docs Start your translations in trunk .
Changes can be backported to the 2.4.x branch afterward. 2. Choose a File to Translate ¶ Check the translation status to see what's already been translated and what's needed. Pick an untranslated file — for example, suppose you want to translate configuring.xml into Spanish. 3. Create Your Translation File ¶ Copy the English source file, adding your two-letter language code as a file extension: cp configuring.xml configuring.xml.es 4.
Translate ¶ Open the new file in your editor and: Set encoding to UTF-8. Ensure the first line reads: <?xml version="1.0" encoding="UTF-8" ?> Mark the English revision. Replace $LastChangedRevision: with English Revision: followed by the current revision number. This helps future maintainers know when your translation was last synced. Add translator credits at the top of the file: <!-- Spanish translation: Your Name --> <!-- Reviewed by: Reviewer Name --> Translate the text content.
Translate text within: <p> , <title> , <description> , <name> , <compatibility> , <note> , <li> , <dd> , and similar elements. Leave code unchanged. Directives, configuration examples, and other literal code stay in English. Keep lines within 80 characters where practical, so reviewers can read the files easily. (Exceptions for complex XML tags and languages without word spacing, like Chinese and Japanese.) 5. Submit Your Translation ¶ Send your completed file (or a patch) to docs@httpd.apache.org .
A committer will review it and add it to the repository. Over time, you may gain commit access yourself. Review Standards ¶ Because the development team can't easily verify non-English content, we require that all translations be reviewed by another fluent speaker of the language before acceptance. Each commit message should name both the translator and the reviewer. We encourage you to place credits in a comment at the top of the file: <!-- ============================================= Translated by: Your Name <email> Reviewed by: Reviewer Name <email> ============================================= --> The build system tracks the SVN revision of the equivalent English version, so future translators know where to start updating.
Maintaining Translations ¶ Once your initial translation is committed, the ongoing work is keeping it up to date as the English source evolves. Here's a practical workflow for tracking changes and updating your translated files. The Basic Idea ¶ The English documentation changes over time — bugs get fixed, features get documented, examples get improved. As a translator, you need to: Detect which English files have changed since you last translated See what specifically changed Apply the equivalent changes to your translated files Verify your work builds correctly Set Up Your Working Environment ¶ Check out both active branches: svn checkout https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs httpd-trunk svn checkout https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/docs httpd-2.4 Track Changes with SVN ¶ The simplest way to see what's changed since a known revision is svn diff between revisions.
If you noted that you last synchronized your translation at revision 1900000, you can see all changes since then: svn log -r 1900000:HEAD docs/manual/mod/mod_rewrite.xml svn diff -r 1900000:HEAD docs/manual/mod/mod_rewrite.xml Tip: Note the current revision number each time you finish updating a translation. Add it as a comment at the top of your translated file: <!-- English Revision: 1912345 --> This makes it easy to check what's changed next time: svn diff -r 1912345:HEAD docs/manual/mod/mod_rewrite.xml Update Your Translation ¶ With the diff output showing what changed in the English source, apply the equivalent changes to your translated file.
Focus on: New paragraphs or sections that need translating Changed examples or directive descriptions Removed content that should also be removed from your translation Corrected technical information Verify Your Work ¶ Build the docs to confirm your XML is valid and the output looks right: cd docs/manual/build ./build.sh validate-xml ./build.sh <your-language-code> Open the generated HTML in a browser to review the final result.
Submit Your Updates ¶ Send your updated files as a patch: svn diff > translation-update.patch Email the patch to docs@httpd.apache.org , or attach it to a Bugzilla ticket . Staying in Sync ¶ A few habits that make maintenance easier: Update regularly — small, frequent updates are much easier than catching up after months of changes. Watch the commits list — subscribe to the svn commits to see documentation changes as they happen.
Coordinate with other translators — if there are multiple people working on your language, divide the work and communicate via the mailing list. Questions? ¶ If you get stuck or have questions about translating or maintaining translations, reach out to docs@httpd.apache.org . We're happy to help. Related Information ¶ Documentation Format — the XML format and how to build HTML from it Translation Status — what's been translated and what's needed Copyright © 1997-2026 The Apache Software Foundation.
Apache HTTP Server, Apache, the Apache logo and the Apache HTTP Server logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.