This is an automated email from the ASF dual-hosted git repository.
rbowen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/httpd-site.git
The following commit(s) were added to refs/heads/main by this push:
new 81131a4 Overhaul of the docs-project content to bring it into this decade. (#39)
81131a4 is described below
commit 81131a431194ac5eb25c74976f641dad0acbdd01
Author: Rich Bowen <[email protected]>
AuthorDate: Mon Jun 1 16:03:51 2026 -0400
Overhaul of the docs-project content to bring it into this decade. (#39)
* Overhaul of the docs-project content to bring it into this decade.
* Drop mention of IRC, since there's really no activity there any more
---
content/docs-project/avail_translations.md | 362 +++++++++++++++++++----------
content/docs-project/contribute.md | 170 ++++++--------
content/docs-project/contributors.md | 23 +-
content/docs-project/docsformat.md | 195 +++++++---------
content/docs-project/goingfurther.md | 138 +++++------
content/docs-project/index.md | 147 +++++-------
content/docs-project/svn.md | 113 +++++----
content/docs-project/tools.md | 141 +++++++++++
content/docs-project/translations.md | 156 ++++++-------
9 files changed, 823 insertions(+), 622 deletions(-)
diff --git a/content/docs-project/avail_translations.md b/content/docs-project/avail_translations.md
index 07b795e..878102f 100644
--- a/content/docs-project/avail_translations.md
+++ b/content/docs-project/avail_translations.md
@@ -1,131 +1,245 @@
-Title: Available Translations - Documentation Project
+Title: Translation Status
license: https://www.apache.org/licenses/LICENSE-2.0
-# Available Translations of the Documentation #
+# Translation Status
-The following modules have already been translated. If you are able to
-provide translations into any of these languages (or any others) please let
-us know. ( [Back to translations page](translations.html) )
+The table below shows which module documentation files have been
+translated into each language. There's plenty of room to help — if you
+see gaps in a language you speak, we'd welcome your contribution.
+
+To get started translating, see the [translation guide](translations.html).
+To learn about keeping translations up to date, see
+[Maintaining Translations](goingfurther.html).
+
+If you can provide translations into any of these languages (or any
+others not yet listed), please let us know on
+[[email protected]](mailto:[email protected]).
+
+<!--
+HOW TO REGENERATE THIS TABLE:
+
+The table below is generated by build/list_translations.py in the
+httpd 2.4 docs source tree. To produce a fresh version:
+
+ cd ~/devel/apache/httpd/httpd-2.4/docs/manual
+ python3 build/list_translations.py > /tmp/table.md
+
+Then paste the contents of /tmp/table.md below, replacing everything
+from the first "| Document |" line to the end of the file.
+-->
| Document | German | Spanish | French | Japanese | Korean | Turkish | Simplified Chinese |
-|----------|--------|---------|--------|----------|--------|---------|--------------------|
-| allmodules.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
-| core.xml | ✔ | ✔ | ✔ | ✔ | - | ✔ | - |
-| directive-dict.xml | - | - | - | ✔ | ✔ | ✔ | - |
-| directives.xml | ✔ | ✔ | - | ✔ | ✔ | ✔ | ✔ |
-| event.xml | - | - | ✔ | - | - | - | - |
+|----------|:------:|:------:|:------:|:------:|:------:|:------:|:------:|
+| bind.xml | ✔ | - | ✔ | ✔ | ✔ | ✔ | - |
+| caching.xml | - | - | ✔ | - | - | ✔ | - |
+| configuring.xml | ✔ | - | ✔ | ✔ | ✔ | ✔ | - |
+| content-negotiation.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| custom-error.xml | - | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| dns-caveats.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| dso.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| env.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| expr.xml | - | - | ✔ | - | - | - | - |
+| filter.xml | - | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| getting-started.xml | - | - | ✔ | - | - | - | - |
+| glossary.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| handler.xml | - | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| index.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
-| mod_access_compat.xml | - | - | ✔ | ✔ | - | - | - |
-| mod_actions.xml | ✔ | - | ✔ | ✔ | ✔ | - | - |
-| mod_alias.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_allowmethods.xml | - | - | - | - | - | - | - |
-| mod_asis.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_auth_basic.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_auth_digest.xml | - | - | ✔ | - | ✔ | - | - |
-| mod_auth_form.xml | - | - | - | - | - | - | - |
-| mod_authn_anon.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_authn_core.xml | - | - | ✔ | - | - | - | - |
-| mod_authn_dbd.xml | - | - | - | - | - | - | - |
-| mod_authn_dbm.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_authn_file.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_authn_socache.xml | - | - | - | - | - | - | - |
-| mod_authnz_ldap.xml | - | - | ✔ | - | - | - | - |
-| mod_authz_core.xml | - | - | - | - | - | - | - |
-| mod_authz_dbd.xml | - | - | - | - | - | - | - |
-| mod_authz_dbm.xml | - | - | - | - | ✔ | - | - |
-| mod_authz_groupfile.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_authz_host.xml | - | - | ✔ | - | - | - | - |
-| mod_authz_owner.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_authz_user.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_autoindex.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_buffer.xml | - | - | ✔ | - | - | - | - |
-| mod_cache.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_cache_disk.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_cern_meta.xml | - | - | - | - | ✔ | - | - |
-| mod_cgi.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_cgid.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_charset_lite.xml | - | - | - | - | ✔ | - | - |
-| mod_data.xml | - | - | - | - | - | - | - |
-| mod_dav.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_dav_fs.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_dav_lock.xml | - | - | - | ✔ | - | - | - |
-| mod_dbd.xml | - | - | - | - | - | - | - |
-| mod_deflate.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_dialup.xml | - | - | - | - | - | - | - |
-| mod_dir.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_dumpio.xml | - | - | - | ✔ | - | - | - |
-| mod_echo.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_env.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_example.xml | - | - | - | - | ✔ | - | - |
-| mod_expires.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_ext_filter.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_file_cache.xml | - | - | - | - | ✔ | - | - |
-| mod_filter.xml | - | - | - | - | - | - | - |
-| mod_headers.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_heartbeat.xml | - | - | - | - | - | - | - |
-| mod_heartmonitor.xml | - | - | - | - | - | - | - |
-| mod_ident.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_imagemap.xml | - | - | - | - | ✔ | - | - |
-| mod_include.xml | - | - | - | ✔ | - | - | - |
-| mod_info.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_isapi.xml | - | - | - | - | ✔ | - | - |
-| mod_lbmethod_bybusyness.xml | - | - | - | - | - | - | - |
-| mod_lbmethod_byrequests.xml | - | - | - | - | - | - | - |
-| mod_lbmethod_bytraffic.xml | - | - | - | - | - | - | - |
-| mod_lbmethod_heartbeat.xml | - | - | - | - | - | - | - |
-| mod_ldap.xml | - | - | ✔ | - | - | - | - |
-| mod_log_config.xml | - | - | - | ✔ | ✔ | ✔ | - |
-| mod_log_debug.xml | - | - | - | - | - | - | - |
-| mod_log_forensic.xml | - | - | - | ✔ | - | ✔ | - |
-| mod_logio.xml | - | - | - | ✔ | ✔ | ✔ | - |
-| mod_lua.xml | - | - | - | - | - | - | - |
-| mod_mime.xml | - | - | - | ✔ | - | - | - |
-| mod_mime_magic.xml | - | - | - | - | - | - | - |
-| mod_negotiation.xml | - | - | ✔ | ✔ | - | - | - |
-| mod_nw_ssl.xml | - | - | - | - | - | - | - |
-| mod_privileges.xml | - | - | - | - | - | - | - |
-| mod_proxy.xml | - | - | ✔ | ✔ | - | - | - |
-| mod_proxy_ajp.xml | - | - | - | ✔ | - | - | - |
-| mod_proxy_balancer.xml | - | - | - | ✔ | - | - | - |
-| mod_proxy_connect.xml | - | - | - | ✔ | - | - | - |
-| mod_proxy_express.xml | - | - | - | - | - | - | - |
-| mod_proxy_fcgi.xml | - | - | - | - | - | - | - |
-| mod_proxy_fdpass.xml | - | - | - | - | - | - | - |
-| mod_proxy_ftp.xml | - | - | - | - | - | - | - |
-| mod_proxy_http.xml | - | - | ✔ | - | - | - | - |
-| mod_proxy_scgi.xml | - | - | - | - | - | - | - |
-| mod_ratelimit.xml | - | - | - | - | - | - | - |
-| mod_reflector.xml | - | - | - | - | - | - | - |
-| mod_remoteip.xml | - | - | ✔ | - | - | - | - |
-| mod_reqtimeout.xml | - | - | - | - | - | - | - |
-| mod_request.xml | - | - | - | - | - | ✔ | - |
-| mod_rewrite.xml | - | - | ✔ | - | - | - | - |
-| mod_sed.xml | - | - | ✔ | - | - | - | - |
-| mod_session.xml | - | - | - | - | - | - | - |
-| mod_session_cookie.xml | - | - | - | - | - | - | - |
-| mod_session_crypto.xml | - | - | - | - | - | - | - |
-| mod_session_dbd.xml | - | - | - | - | - | - | - |
-| mod_setenvif.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_slotmem_plain.xml | - | - | - | - | - | - | - |
-| mod_slotmem_shm.xml | - | - | - | - | - | - | - |
-| mod_so.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_speling.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_ssl.xml | - | - | - | - | - | - | - |
-| mod_status.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
-| mod_substitute.xml | - | - | - | - | - | - | - |
-| mod_suexec.xml | - | - | - | ✔ | ✔ | ✔ | - |
-| mod_unique_id.xml | - | - | ✔ | ✔ | ✔ | - | - |
-| mod_unixd.xml | - | - | - | - | - | ✔ | - |
-| mod_userdir.xml | - | - | - | ✔ | ✔ | ✔ | - |
-| mod_usertrack.xml | - | - | - | - | - | - | - |
-| mod_version.xml | - | - | - | ✔ | ✔ | - | - |
-| mod_vhost_alias.xml | - | - | - | - | - | ✔ | - |
-| module-dict.xml | - | - | - | ✔ | ✔ | ✔ | - |
-| mpm_common.xml | ✔ | - | - | ✔ | - | ✔ | - |
-| mpm_netware.xml | - | - | - | - | - | - | - |
-| mpm_winnt.xml | ✔ | - | - | ✔ | - | - | - |
-| mpmt_os2.xml | - | - | - | - | - | - | - |
-| prefork.xml | ✔ | - | - | ✔ | - | ✔ | - |
-| quickreference.xml | ✔ | ✔ | - | ✔ | ✔ | ✔ | ✔ |
-| worker.xml | ✔ | - | - | ✔ | - | ✔ | - |
+| install.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| invoking.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| license.xml | - | - | - | - | - | - | - |
+| logs.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/allmodules.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
+| mod/core.xml | ✔ | ✔ | ✔ | ✔ | - | ✔ | - |
+| mod/directive-dict.xml | - | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| mod/directives.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
+| mod/event.xml | - | - | ✔ | - | - | - | - |
+| mod/index.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
+| mod/mod_access_compat.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_actions.xml | ✔ | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_alias.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_allowmethods.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_asis.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_auth_basic.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_auth_digest.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_auth_form.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authn_anon.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_authn_core.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authn_dbd.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authn_dbm.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_authn_file.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_authn_socache.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authnz_fcgi.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authnz_ldap.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authz_core.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authz_dbd.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authz_dbm.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_authz_groupfile.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_authz_host.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_authz_owner.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_authz_user.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_autoindex.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_brotli.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_buffer.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_cache.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_cache_disk.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_cache_socache.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_cern_meta.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_cgi.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_cgid.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_charset_lite.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_data.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_dav.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_dav_fs.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_dav_lock.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_dbd.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_deflate.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_dialup.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_dir.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_dumpio.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_echo.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_env.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_example_hooks.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_expires.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_ext_filter.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_file_cache.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_filter.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_headers.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_heartbeat.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_heartmonitor.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_http2.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_ident.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_imagemap.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_include.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_info.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_isapi.xml | - | - | ✔ | - | ✔ | - | - |
+| mod/mod_lbmethod_bybusyness.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_lbmethod_byrequests.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_lbmethod_bytraffic.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_lbmethod_heartbeat.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_ldap.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_log_config.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_log_debug.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_log_forensic.xml | - | - | ✔ | ✔ | - | ✔ | - |
+| mod/mod_logio.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_lua.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_macro.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_md.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_mime.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_mime_magic.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_negotiation.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_nw_ssl.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_privileges.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_proxy_ajp.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_proxy_balancer.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_proxy_connect.xml | - | - | ✔ | ✔ | - | - | - |
+| mod/mod_proxy_express.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_fcgi.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_fdpass.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_ftp.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_hcheck.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_html.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_http.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_http2.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_scgi.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_uwsgi.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_proxy_wstunnel.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_ratelimit.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_reflector.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_remoteip.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_reqtimeout.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_request.xml | - | - | ✔ | - | - | ✔ | - |
+| mod/mod_rewrite.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_sed.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_session.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_session_cookie.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_session_crypto.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_session_dbd.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_setenvif.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_slotmem_plain.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_slotmem_shm.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_so.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_socache_dbm.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_socache_dc.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_socache_memcache.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_socache_redis.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_socache_shmcb.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_speling.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_ssl.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_status.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_substitute.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_suexec.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_systemd.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_unique_id.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_unixd.xml | - | - | ✔ | - | - | ✔ | - |
+| mod/mod_userdir.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mod_usertrack.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_version.xml | - | - | ✔ | ✔ | ✔ | - | - |
+| mod/mod_vhost_alias.xml | - | - | ✔ | - | - | ✔ | - |
+| mod/mod_watchdog.xml | - | - | ✔ | - | - | - | - |
+| mod/mod_xml2enc.xml | - | - | ✔ | - | - | - | - |
+| mod/module-dict.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| mod/mpm_common.xml | ✔ | - | ✔ | ✔ | - | ✔ | - |
+| mod/mpm_netware.xml | - | - | ✔ | - | - | - | - |
+| mod/mpm_winnt.xml | ✔ | - | ✔ | ✔ | - | - | - |
+| mod/mpmt_os2.xml | - | - | ✔ | - | - | - | - |
+| mod/overrides.xml | - | - | ✔ | - | - | - | - |
+| mod/prefork.xml | ✔ | - | ✔ | ✔ | - | ✔ | - |
+| mod/quickreference.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
+| mod/worker.xml | ✔ | - | ✔ | ✔ | - | ✔ | - |
+| mpm.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
+| new_features_2_0.xml | ✔ | - | ✔ | ✔ | ✔ | ✔ | - |
+| new_features_2_2.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| new_features_2_4.xml | - | - | ✔ | - | - | ✔ | - |
+| programs/ab.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/apachectl.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/apxs.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/configure.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/dbmmanage.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/fcgistarter.xml | - | - | ✔ | - | - | ✔ | - |
+| programs/htcacheclean.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/htdbm.xml | - | - | ✔ | - | - | ✔ | - |
+| programs/htdigest.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/htpasswd.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/httpd.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/httxt2dbm.xml | - | - | ✔ | - | - | ✔ | - |
+| programs/index.xml | - | ✔ | ✔ | - | ✔ | ✔ | ✔ |
+| programs/log_server_status.xml | - | - | ✔ | - | - | - | - |
+| programs/logresolve.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/other.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/rotatelogs.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| programs/split-logfile.xml | - | - | ✔ | - | - | - | - |
+| programs/suexec.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| rewrite/access.xml | - | - | ✔ | - | - | - | - |
+| rewrite/advanced.xml | - | - | ✔ | - | - | - | - |
+| rewrite/avoid.xml | - | - | ✔ | - | - | - | - |
+| rewrite/flags.xml | - | - | ✔ | - | - | - | - |
+| rewrite/htaccess.xml | - | - | ✔ | - | - | - | - |
+| rewrite/index.xml | - | - | ✔ | - | - | ✔ | ✔ |
+| rewrite/intro.xml | - | - | ✔ | - | - | - | - |
+| rewrite/proxy.xml | - | - | ✔ | - | - | - | - |
+| rewrite/remapping.xml | - | - | ✔ | - | - | - | - |
+| rewrite/rewritemap.xml | - | - | ✔ | - | - | - | - |
+| rewrite/tech.xml | - | - | ✔ | - | - | - | - |
+| rewrite/vhosts.xml | - | - | ✔ | - | - | - | - |
+| sections.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| server-wide.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| sitemap.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
+| socache.xml | - | - | ✔ | - | - | - | - |
+| ssl/index.xml | - | - | ✔ | ✔ | - | ✔ | ✔ |
+| ssl/ssl_compat.xml | - | - | ✔ | - | - | - | - |
+| ssl/ssl_faq.xml | - | - | ✔ | - | - | - | - |
+| ssl/ssl_howto.xml | - | - | ✔ | - | - | - | - |
+| ssl/ssl_intro.xml | - | - | ✔ | ✔ | - | - | - |
+| stopping.xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - |
+| suexec.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| upgrading.xml | - | - | ✔ | - | - | - | - |
+| urlmapping.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| vhosts/details.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| vhosts/examples.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| vhosts/fd-limits.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| vhosts/index.xml | ✔ | - | ✔ | ✔ | ✔ | ✔ | ✔ |
+| vhosts/ip-based.xml | - | - | ✔ | ✔ | ✔ | ✔ | - |
+| vhosts/mass.xml | - | - | ✔ | - | ✔ | ✔ | - |
+| vhosts/name-based.xml | ✔ | - | ✔ | ✔ | ✔ | ✔ | - |
diff --git a/content/docs-project/contribute.md b/content/docs-project/contribute.md
index 60cd619..1a68d15 100644
--- a/content/docs-project/contribute.md
+++ b/content/docs-project/contribute.md
@@ -1,126 +1,96 @@
-Title: Contributing to the Apache HTTP Server Documentation
+Title: Contributing to the Documentation
license: https://www.apache.org/licenses/LICENSE-2.0
-# Contributing to the Apache HTTP Server Documentation #
+# Contributing to the Apache HTTP Server Documentation
-The Documentation Project is an effort to maintain and improve the quality
-of the documentation included with the Apache HTTP Server. Participation is
-open to anyone willing to write documentation, edit for spelling, grammer
-or readability, or [translate](translations.html) documentation into
-another language. Some knowledge of the Apache HTTP Server is helpful, but
-not required. No programming knowledge is required, so this is a great way
-for non-programmers to contribute to the success of the Apache HTTP Server
-project, and to have their work read by millions of Apache users.
+We'd love your help improving the Apache HTTP Server documentation. You
+don't need to be a programmer — if you can spot a confusing sentence, fix
+a typo, or explain something more clearly, you're already making a
+difference. Your work will be read by millions of httpd users worldwide.
-This is **not** a mailing list where users should ask questions on how to
-configure Apache. The [Users List](../userslist.html) is available for that
-purpose.
+This page is about *contributing to the docs*, not about configuring
+httpd. For configuration help, see the
+[Users mailing list](../userslist.html).
-# How to get Involved #
+## Ways to Contribute
-There are several ways that you can contribute to the documentation effort.
-You can:
+There's something for every skill level:
-- [Subscribe to the [email protected] mailing
-list](mailto:[email protected]) and tell us something that
-could be improved.
+### Quick Wins (no SVN needed)
-- Join #httpd on irc.libera.chat and tell us there.
+- **Report a problem** — [Open a Bugzilla
+ ticket](https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation)
+ describing what's wrong or confusing.
+- **Suggest an improvement** — Send a note to the
+ [docs mailing list](mailto:[email protected]) with your
+ idea.
+- **Join the conversation** — Subscribe to `[email protected]` and
+ weigh in on ongoing discussions.
-- Submit a ticket to the [bug database](../bug_report.html).
+### Fix and Improve (SVN patch workflow)
-- Check out the documentation from svn ( [instructions here](svn.html) ),
-and send us a patch.
+- Fix typos, broken examples, or unclear explanations.
+- Add missing configuration examples.
+- Update outdated information.
+- Improve the documentation for a module you know well.
-There are lots of ways to contribute to the documentation project,
-including fixing typos and spelling mistakes, translating the documentation
-into other languages, writing tutorials to help new users, or just
-expressing your opinion about suggested changes.
+For these, you'll check out the docs from SVN, make your changes, and
+send us a patch. See our [SVN workflow guide](svn.html) for step-by-step
+instructions — it's straightforward even if you haven't used SVN before.
-For information on our use of XML in the documentation, see our
-[Documentation Format and Transformation](docsformat.html) page. For
-markup conventions and prose style, see the [Documentation Style
-Guide](style-guide.html).
+### Larger Contributions
-If you need inspiration for something to work on, look at our
-[STATUS](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/STATUS)
-file for a list of things that we think need doing, and pick something that
-you think you can do. Patches against trunk are greatly appreciated, but
-contributions in any format are helpful.
+- Write a new how-to or tutorial.
+- Document a module that's missing coverage.
+- Translate documentation into another language (see the
+ [translation guide](translations.html)).
-# Translation Projects #
+For anything substantial, we recommend introducing yourself on the
+mailing list first. That way you can get feedback on your approach
+before investing a lot of time.
-Information about translating the documentation into other languages is
-available at the [translations page](translations.html).
+## Getting Set Up
-# Participants #
+1. **Subscribe to the mailing list** — Send email to
+ [[email protected]](mailto:[email protected]).
+2. **Check out the source** — Follow our [SVN instructions](svn.html).
+3. **Learn the format** — Read about the
+ [documentation XML format](docsformat.html) and the
+ [style guide](style-guide.html).
+4. **Set up your tools** — See [Tools for Contributors](tools.html) for
+ editor and workflow recommendations.
-Some of the participants are:
+## Submitting Your Work
-- [Erik Abele](http://www.codefaktor.de/)
+The standard workflow is:
-- [Ryan Bloom](http://rkbloom.net/rbb/)
+1. Make your changes in your SVN checkout.
+2. Run `svn diff > my-changes.patch` to create a patch file.
+3. Send the patch to `[email protected]`, or attach it to a
+ [Bugzilla ticket](https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation).
+4. Include a brief description of what you changed and why.
-- [Rich Bowen](http://www.rcbowen.com/)
+Don't worry about getting everything perfect on the first try. We review
+all contributions and are happy to help you iterate.
-- Vincent Bray
+## Communication Channels
-- [Ken Coar](http://Golux.Com/coar/)
+- **Mailing list:** `[email protected]`
+ ([subscribe](mailto:[email protected]) |
+ [archives](https://lists.apache.org/[email protected]))
+- **IRC:** #httpd on [irc.libera.chat](https://libera.chat/)
+- **Bug tracker:**
+ [Bugzilla](https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation)
-- Eric Cholet
+## The XML Format
-- [Tony Finch](http://dotat.at/)
+The documentation is written in a custom XML format, transformed to HTML
+via XSLT. If you're not familiar with XML, don't let that stop you — it's
+quite readable, and the community will help you with markup questions.
+See the [documentation format](docsformat.html) page for details, and
+the [style guide](style-guide.html) for markup conventions.
-- Yoshiki Hayashi
-
-- [Astrid Keßler](http://www.kess-net.de/)
-
-- [Jason Lingohr](http://geeklog.lucid.net.au/)
-
-- André L. Malo
-
-- [Chris Pepper](http://www.reppep.com/~pepper/)
-
-- Dan Poirier
-
-- [Noirin Plunkett](http://www.nerdchic.net/)
-
-- William A. Rowe, Jr.
-
-- [Joshua Slive](http://slive.ca/)
-
-- [Tony Stevenson](http://blog.pc-tony.com/)
-
-- [Mads Toftum](http://www.toftum.org/)
-
-The localized custom error messages in the 2.x version of the Apache HTTP
-Server were contributed by
-
-- Ricardo Leite (Brazilian)
-
-- Marcel Kolaja (Czech)
-
-- Peter Van Biesen (Dutch)
-
-- Lars Eilebrecht (English and German)
-
-- Cecile de Crecy (French)
-
-- Luigi Rosa (Italian)
-
-- Noirin Plunkett (Irish)
-
-- Jaeho Shin (Korean)
-
-- Tomasz Kepczynski (Polish)
-
-- Andrei Besleaga (Romanian)
-
-- Nikola Smolenski (Serbian)
-
-- Karla Quintero (Spanish)
-
-- Thomas Sjögren (Swedish)
-
-- Emre Sokullu (Turkish)
+## Translation Projects
+If you'd like to translate the documentation into another language, see
+the [translations page](translations.html) for how to get started.
diff --git a/content/docs-project/contributors.md b/content/docs-project/contributors.md
index e1d93d9..c78b30e 100644
--- a/content/docs-project/contributors.md
+++ b/content/docs-project/contributors.md
@@ -1,11 +1,18 @@
-Title: Documentation - Contributors
+Title: Contributors
license: https://www.apache.org/licenses/LICENSE-2.0
-# Documentation - Contributors
+# Contributors
-The Apache HTTP Server documentation is the product of the work of many,
-many people. The following people have at one time or another contributed
-to the Apache HTTP Server documentation. Thanks to all of them!
+The Apache HTTP Server documentation is the product of many people's
+work over more than two decades. The following individuals have
+contributed to the documentation at one time or another. We're grateful
+to every one of them.
+
+This is a historical record — not a closed list. New contributors are
+always welcome, and we'd love to add your name here. See the
+[contribution guide](contribute.html) to get started.
+
+## Documentation Contributors
- aaron : Aaron Bannert
- akosut : Alexei Kosut
@@ -96,8 +103,9 @@ to the Apache HTTP Server documentation. Thanks to all of them!
- wsanchez : Wilfredo Sanchez
- yoshiki : Yoshiki Hayashi
-The localized custom error messages in the 2.x version of the Apache HTTP
-Server were contributed by
+## Localized Error Messages
+
+The custom error messages in the 2.x releases were contributed by:
- Ricardo Leite (Brazilian)
- Marcel Kolaja (Czech)
@@ -113,4 +121,3 @@ Server were contributed by
- Karla Quintero (Spanish)
- Thomas Sjögren (Swedish)
- Emre Sokullu (Turkish)
-
diff --git a/content/docs-project/docsformat.md b/content/docs-project/docsformat.md
index b34cd00..b787463 100644
--- a/content/docs-project/docsformat.md
+++ b/content/docs-project/docsformat.md
@@ -1,141 +1,110 @@
-Title: Module Format and Transformation
+Title: Documentation Format and Build
license: https://www.apache.org/licenses/LICENSE-2.0
-# Module Format and Transformation #
+# Documentation Format and Build
-This document describes the format of the Apache HTTP Server documentation
-xml source files and the technique used to transform them to html.
+This page describes the XML format used for the Apache HTTP Server
+documentation and how to transform it into HTML for review.
-# Format #
+## Format Overview
-A DTD is located in the [style
-directory](https://httpd.apache.org/docs/current/style/) of the manual. An
-example of the format with extensive comments is also available in
-[mod_template.txt](mod_template.txt). (Ordinarily, the file extension
-will be `xml`. It is changed here to make online viewing simpler.)
-
-For detailed conventions on which markup elements to use and when, see the
+The documentation is written in a custom XML format with its own DTD.
+The DTD is in the
+[style directory](https://httpd.apache.org/docs/current/style/) of the
+manual. For detailed markup conventions, see the
[Documentation Style Guide](style-guide.html).
-Various formatting syntax can be used such as:
+### Common Markup Elements
+
+| Element | Purpose |
+|---------|---------|
+| `<example> ... </example>` | Wraps a code example block |
+| `<highlight language="config"> ... </highlight>` | Configuration example with syntax highlighting |
+| `<highlight language="perl"> ... </highlight>` | Perl code with highlighting |
+| `<highlight language="lua"> ... </highlight>` | Lua code with highlighting |
+| `<highlight language="C"> ... </highlight>` | C code with highlighting |
+| `<directive module="...">Name</directive>` | Cross-reference to a directive |
+| `<module>mod_name</module>` | Cross-reference to a module |
+| `<program>name</program>` | Cross-reference to an httpd program |
+| `<var>placeholder</var>` | User-supplied value |
+| `<note> ... </note>` | Informational callout |
+| `<note type="warning"> ... </note>` | Warning callout |
+
+The full format is best learned by reading existing documentation files.
+Start with a simple page and the patterns will become clear quickly.
+
+## Viewing Your Changes
+
+Modern browsers can render the XML files directly by applying the
+referenced XSLT stylesheet. Simply open the `.xml` file in your browser
+to see a reasonable approximation of the final output. This lets you
+check your work without any build setup.
+
+For the authoritative rendering, use the Ant build system described
+below.
+
+## Building the Documentation
-<table border="1">
-<tr><th>Keyword</th><th>Purpose</th></tr>
-<tr><td><example> ... </example></td><td>Format an example as monospaced font</td></tr>
-<tr><td><highlight language="config"> ... </highlight></td>
-<td>A configuration example, syntax highlighted. Can also use language="perl", "lua", or "C"</td></tr>
-</table>
+The official build uses Xalan + Xerces (Java) via Apache Ant. This
+ensures consistent HTML output across all contributors.
-# Transformation #
+### Prerequisites
-The easiest way to view the transformed docs is to simply open the xml file
-directly in a recent verions of MSIE, Netscape, or Mozilla. (MSIE 6 seems
-to work consistently. The Gecko/Mozilla based browsers, however, do not
-incorporate the referenced DTDs, so they have problems with documents
-containing character entities). These browsers will read the xsl file and
-perform the transformation for you automatically, so that you can see what
-the final output will look like. This means that you can work on the docs
-and check your work without any special transformation setup.
+- Java 8 or later (JRE or JDK)
+- An SVN checkout of the docs (see [SVN workflow](svn.html))
-For the final presentation, it is still necessary to transform to html to
-accomodate older browsers. Although any standards-compliant xslt engine
-should do, changing engines can lead to massive diffs on the transformed
-files. Therefore, we have chosen a single recommended transformation system
-based on Xalan+Xerces Java and Ant. These are all Apache projects
-distributed under the Apache license.
+### Build Steps
-The only prerequisite for the transformation is a Java 8 or greater JVM.
-Assuming you already have
-[httpd/httpd/branches/2.4.x/docs/](https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.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).)
+From your checkout:
-><code>$ cd docs/manual<br></br>$ svn co
-https://svn.apache.org/repos/asf/httpd/docs-build/trunk build<br></br>$ cd
-build<br></br>$./build.sh all</code>
+ cd docs/manual
+ svn co https://svn.apache.org/repos/asf/httpd/docs-build/trunk build
+ cd build
+ ./build.sh all
-If you are running under win32, the `build.sh` script will work if cygwin is
-installed. Alternatively, on Win32, you should be able to run the
-`build.bat` script.
+The `all` target builds documentation for all available languages. To
+build only English:
-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
-directory](http://www.apache.org/dyn/closer.lua/httpd/docs/).
+ ./build.sh
-The default target builds only the english-language docs. To build other
-docs, you should specify the language-code (ja, de, etc) as an argument, or
-use the `all` target. To find the available languages, please see our
-[translations page](translations.html).
+To build a specific language (e.g., French):
-You can get an overview of all possible build targets by typing:
+ ./build.sh fr
-> `
-./build.sh -projecthelp
-`
+### Available Build Targets
-# Validating changes #
+To see all available targets:
-Before submitting or committing changes, you should check that the XML is
-correct, and the generated HTML:
+ ./build.sh -projecthelp
-><code>./build.sh validate-xml<br></br>./build.sh validate-xhtml</code>
+## Validating Your Changes {#validation}
The `validate-xhtml` target uses the W3C Nu HTML Checker. If you don't
already have it, download `vnu.jar` into the `build/` directory:
-><code>curl -L -o vnu.jar https://github.com/validator/validator/releases/download/latest/vnu.jar</code>
+ curl -L -o vnu.jar https://github.com/validator/validator/releases/download/latest/vnu.jar
See [https://github.com/validator/validator](https://github.com/validator/validator) for details.
-# Special Files #
-
-When adding a new module, the transformation process tries to generate an
-appropriate entry within `mod/allmodules.xml` and to create an accompanying
-metafile ( `newfilename.xml.meta` ). Since these tasks are written in
-[perl](http://www.perl.org/) , you'll need a working perl installation for
-this. If not, you should take these steps manually, or just leave a note on
-the project mailing list so that someone else can do it.
-
-# Generating a PDF version #
-
-The PDF version of the docs is generated by transforming the xml files to
-LaTeX using the "latex-en" Ant target. The XSLT style files for the
-transformation are under `style/latex/`. Once you have the `.tex`
-equivalent of each `.xml` file, you can use `pdflatex` to convert this into
-a pdf file. Recommended versions of pdflatex can be obtained as part of
-TeTeX (unix) or MikTeX (win32), but any version of TeX should be fine, as
-long as it is sufficiently complete and modern. To generate the PDF, you
-should process the `sitemap.tex` file, which contains the main LaTeX
-document code and will include all the other files. The outputed PDF will
-then be called `sitemap.pdf` , which you can rename how you choose.
-
-Some notes about the XML to LaTeX conversion are necessary. Although HTML
-and LaTeX have many similarities, there are enough differences between the
-two to make targetting both outputs a difficult task. In particular, the
-methods for handling tables are very different. To aid in the conversion to
-LaTeX of tables designed for HTML, a `<columnspec>` section should be
-added to each table. Inside the `<columnspec>` , place a `<column
-width=".xx"/>` for each column in the table, where `xx` is the
-percentage of the line-width devoted to that column. This will assist in
-the conversion of basic tables. More complex stuff (like spanning rows or
-columns) is not currently convertible.
-
-Further, `pdflatex` cannot incorporate GIF files in a generated PDF, so any
-graphics must be available in PNG format.
-
-There are various other restrictive assumptions embedded in the XSLT that
-work for the current docs, but may need to be modified in the future. For
-example, the code that transforms HTML-style links to LaTeX
-cross-references will only work within the main directory and one level of
-subdirectory. Also, `<pre>` sections rarely work well in LaTeX
-because of differences in escaping and formatting rules in `verbatim`
-sections.
-
-Finally, there are various differences in escaping rules between XML/HTML
-and LaTeX. Some characters need to be backslash-escaped in LaTeX, and all
-XML entitites (&whatever;) must be converted to LaTeX equivalents. This
-is currently handled for a limited set of characters using a big, ugly
-search-replace in the XSLT. This may need to be modified in the future,
-especially to handle translations. Pre-processing with a perl script and a
-substitution table may be a better solution.
+Before submitting a patch, validate your XML and the generated HTML:
+
+ ./build.sh validate-xml
+ ./build.sh validate-xhtml
+
+These checks will catch malformed XML, broken cross-references, and
+invalid HTML output. Please run them before sending patches — it saves
+everyone time.
+
+## Special Files
+
+When adding a new module, the build process generates entries in
+`mod/allmodules.xml` and creates accompanying metafiles. This step
+requires a working Perl installation. If you don't have Perl available,
+just note this in your patch submission and someone on the team will
+handle it.
+
+## See Also
+
+- [Style Guide](style-guide.html) — markup conventions and prose style
+- [SVN Workflow](svn.html) — checking out and submitting patches
+- [Tools for Contributors](tools.html) — editors and validation tools
diff --git a/content/docs-project/goingfurther.md b/content/docs-project/goingfurther.md
index 44bc823..6404473 100644
--- a/content/docs-project/goingfurther.md
+++ b/content/docs-project/goingfurther.md
@@ -1,102 +1,92 @@
-Title: Translations - Documentation Project
+Title: Maintaining Translations
license: https://www.apache.org/licenses/LICENSE-2.0
-# Introduction #
+# Maintaining Translations
-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.
+Once you've started translating, the ongoing work is keeping your
+translations up to date as the English source evolves. This page
+describes a practical workflow for tracking changes and updating your
+translated files.
-Doc manual is divided in branches:
+## The Basic Idea
-- <b>trunk:</b> It's the development branch; in other words, 2.4 branch plus new
- 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
+The English documentation changes over time — bugs get fixed, features
+get documented, examples get improved. As a translator, you need to:
-Good to see [what has already been
-translated](http://home.apache.org/~takashi/translation-status/test.html#2.4) and
-whether it's up to date or not.
+1. Detect which English files have changed since you last translated
+2. See what specifically changed
+3. Apply the equivalent changes to your translated files
+4. Verify your work builds correctly
-# Downloading svn repository #
+## Recommended Workflow
-In order to work properly, you have to download the `doc` tree (svn repository) onto
-your computer:
+### Set Up Your Working Environment
-- Create a directory called <b>"httpd-doc"</b> on your computer : `mkdir
- httpd-doc`
-- cd to this directory: `cd httpd-doc`
-- Download svn repository:
- - `svn co https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs
- httpd-trunk`
- - `svn co
- https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/docs
- httpd-2.4`</br>
-
- **Note:** SVN is a powerful program; see more [here](svn.html) and of course
- "`svn --help`" or "`man svn`" if you work in a Unix-like environment.
+Check out both active branches:
-# New translations #
+ 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
-Translate documents that are not yet translated as shown in [Translations
-document](translations.html).
+### Track Changes with SVN
-# Maintaining your translations #
+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:
-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.
+ svn log -r 1900000:HEAD docs/manual/mod/mod_rewrite.xml
+ svn diff -r 1900000:HEAD docs/manual/mod/mod_rewrite.xml
-- cd to your repository root <b>"httpd-doc"</b>
+**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:
-- Create a directory called <b>"working"</b> (it will be used later): `mkdir
- working`
+ <!-- English Revision: 1912345 -->
-- Create a directory called <b>"sav"</b> (reference directory for updates detection -
- see below): `mkdir sav`
-- Copy svn repository you downloaded above in <b>"sav"</b> directory:
- - `cp -a httpd-trunk sav`
- - `cp -a httpd-2.4 sav`
+This makes it easy to check what's changed next time:
-- Once you have finished to work on a file, say <b>file.xml.fr</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 it
- from there.
-Modifications will be displayed for each branch.
+ svn diff -r 1912345:HEAD docs/manual/mod/mod_rewrite.xml
-- Suppose modifications for 2.4 branch contains this line:<br />
+### Update Your Translation
- <b>U manual/bind.xml</b><br/>
+With the diff output showing what changed in the English source, apply
+the equivalent changes to your translated file. Focus on:
- 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 />
+- 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
- `diff sav/httpd-2.4/manual/bind.xml httpd-2.4/manual/bind.xml > working/diff-bind`
+### Verify Your Work
-- `working/diff-bind` file covers now all modifications you have to transfer after
- translation to your own bind.xml.ll (ll-> Local Language), say bind.xml.fr for a (good) example.
+Build the docs to confirm your XML is valid and the output looks right:
-- When you're finished, don't forget to save your work (new versions of
- bind.xml and bind.xml.fr in the appropriate <b>"sav"</b> subdirectory).
+ cd docs/manual/build
+ ./build.sh validate-xml
+ ./build.sh <your-language-code>
-- 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)).
+Open the generated HTML in a browser to review the final result.
-- Once you're satisfied with your work, submit a patch to [https://bz.apache.org/bugzilla/](https://bz.apache.org/bugzilla/)
+### Submit Your Updates
+Send your updated files as a patch:
-# Questions #
+ svn diff > translation-update.patch
-Feel free to send your questions to [email protected]
+Email the patch to `[email protected]`, or attach it to a
+[Bugzilla ticket](https://bz.apache.org/bugzilla/).
+
+## 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 maintaining translations, reach
+out to `[email protected]`. We're happy to help.
diff --git a/content/docs-project/index.md b/content/docs-project/index.md
index 502ee83..3470c43 100644
--- a/content/docs-project/index.md
+++ b/content/docs-project/index.md
@@ -1,115 +1,96 @@
Title: Documentation Project
license: https://www.apache.org/licenses/LICENSE-2.0
-# Documentation Project #
+# Apache HTTP Server Documentation Project
-The documentation of the Apache HTTP Server is a collaborative effort, made
-possible by the participation of the entire HTTP Server community. We'd
-love to have your help too.
+The Apache HTTP Server documentation is written and maintained by
+volunteers like you. Whether you're fixing a typo, improving an example,
+translating a page, or writing something entirely new — we'd love your
+help.
-- [I want to report a problem](#report)
+You don't need to be a programmer. You don't need to be an httpd expert.
+If you can read the docs and spot something that could be clearer, you're
+already qualified to contribute.
-- [I'd like to make a suggestion](#suggestion)
+## Quick Links
-- [I know how to use svn and want to checkout the latest manual](#svn)
+- [Report a problem](#report)
+- [Make a suggestion](#suggestion)
+- [Contribute to the docs](#contribute)
+- [Translate the documentation](#translate)
+- [Find the docs](#docs)
+- [Join the mailing list](#ml)
+- [Chat with us on IRC](#irc)
-- [I'd like to build the manual from local source](#build)
+## Report a Problem {#report}
-- [I want to follow the documentation style conventions](#style)
+Found something wrong? The best way to report it is to [open a
+Bugzilla ticket](https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation)
+with "Documentation" selected as the component.
-- [I'd like to join the docs team mailing list](#ml)
+You can also check the [list of open documentation
+bugs](http://s.apache.org/httpd-doc-bugs) to see if it's already known.
-- [I want to help translate the documentation](#translate)
+## Make a Suggestion {#suggestion}
-- [Actually, I was just looking for the docs](#docs)
+Have an idea for how we could explain something better? Want to propose
+a new how-to or tutorial?
-# Reporting a problem {#report}
+The best approach is to [join the mailing list](#ml) and start a
+conversation. You can also [open a Bugzilla ticket](#report) with your
+suggestion. Either way, we're glad to hear from you.
-The best way to report a problem with the documentation is to make a comment
-on the docs page in question, or to [open a
-ticket](https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation).
-Select 'Documentation' as the component. Have a look at the [list of open
-documentation bugs](http://s.apache.org/httpd-doc-bugs) to see if it's
-already covered. We try to keep that list very short.
+## Contribute {#contribute}
-# Making a suggestion {#suggestion}
+Ready to dive in? Our [contribution guide](contribute.html) walks you
+through the different ways to help — from quick fixes to substantial new
+content. The workflow uses SVN and patches, and we have a
+[step-by-step SVN guide](svn.html) to get you started.
-If you have a suggestion of something that we could do better, or even want
-to write a new or replacement document, there are a number of ways to go
-about it.
+New to the XML format we use? That's fine — take a look at the
+[documentation format](docsformat.html) page, and don't hesitate to ask
+questions on the mailing list. We're happy to help you get oriented.
-The best way is probably to [join the mailing list](#ml) and strike up a
-conversation. We always love to have new people on the project.
+See also: [Tools for Contributors](tools.html) for editor and workflow
+recommendations.
-Or, you can [open a ticket](#report) , as discussed above. We are very
-interested in your suggestions, and any way that you think we can improve
-the documentation. We look forward to hearing from you.
+## Style Guide {#style}
-The 2.2, 2.4 and trunk documentation also have a comment feature, where
-you can quickly add a comment about the documentation. To access this,
-click the "Comments" link on a page or simply scroll down to the bottom.
+When writing or editing documentation, please follow the conventions in
+our [Documentation Style Guide](style-guide.html). It covers markup,
+prose style, and formatting standards.
-# SVN information {#svn}
+## The Mailing List {#ml}
-Our documentation is kept in svn, along with the source code, and the
-actual changes are all made there. If you intend to be a long-term
-contributor to the documentation, the best thing to do is to get an svn
-checkout and submit patches. We've got a [document that gives you all of
-the necessary details](svn.html).
-
-# Building the docs {#build}
-
-Once you have a checkout from SVN, you need to also check out the
-docs-build directory and run the relevant build scripts to produce all of the
-relevant transformations. Please see [docs build](docsformat.html) for
-more information.
-
-# Style Guide {#style}
-
-When writing or editing documentation, please follow the conventions in our
-[Documentation Style Guide](style-guide.html). It covers inline markup,
-directive syntax definitions, prose style, and formatting standards.
-
-# The docs mailing list {#ml}
-
-The discussion surrounding the documentation project happens on the
-`[email protected]` mailing list. To subscribe to this mailing list,
-send email to
+All discussion about the docs project happens on
+`[email protected]`. To subscribe, send email to
[[email protected]](mailto:[email protected])
-and follow the instructions in the response you receive.
+and follow the instructions in the reply.
-If you're not subscribed, messages may be moderated through if they are
-appropriate to the list.
-
-You may also view the list, as well as past archives, at
+You can browse current and past messages at
[lists.apache.org](https://lists.apache.org/[email protected]).
-# Translations {#translate}
-
-The documentation is available in several different languages. Some of
-these translations are out of date, and some important languages are
-missing. If you are fluent in a non-English language, and would like to
-provide a translation of all or part of the documentation, there's [another
-document](translations.html) about how to get started on that. Before you
-get started, please [join the mailing list](#ml) , introduce yourself, and
-let us know what you're working on. In that way, other translators can
-coordinate with you in this effort.
+If you're not subscribed, your messages may still be moderated through
+if they're on-topic.
-# Where are the docs? {#docs}
+## Translate the Documentation {#translate}
-Documentation is available for several different versions of the server:
+The documentation is available in several languages, but many
+translations are incomplete or out of date. If you're fluent in a
+non-English language, we'd welcome your help. See our
+[translation guide](translations.html) to get started, and check the
+[translation status](avail_translations.html) to see what's needed.
-Online Documentation: [Version 2.0](../docs/2.0/) | [Version
-2.2](../docs/2.2/) | [Version 2.4](../docs/2.4/) | [Version 2.5
-(Development branch)](../docs/trunk/) |
-[Wiki](http://wiki.apache.org/httpd/)
+Please [introduce yourself on the mailing list](#ml) before you begin so
+other translators can coordinate with you.
-Downloadable documentation in Microsoft Help (CHM) format is available from
-the [distribution
-directory](https://downloads.apache.org/httpd/docs/).
+## Where Are the Docs? {#docs}
-# Participants #
+- [Version 2.4](../docs/2.4/) (current stable release)
+- [Trunk / Development](../docs/trunk/) (next version in progress)
-The Apache HTTP Server documentation is the product of the work of many,
-many people. We've listed them [over here](contributors.html).
+## Contributors
+The Apache HTTP Server documentation is the product of many people's
+work over many years. See the [contributors page](contributors.html)
+for the full list — and we hope to add your name there soon.
diff --git a/content/docs-project/svn.md b/content/docs-project/svn.md
index f04806b..6804bec 100644
--- a/content/docs-project/svn.md
+++ b/content/docs-project/svn.md
@@ -1,65 +1,94 @@
-Title: Documentation Project: Subversion
+Title: SVN Workflow
license: https://www.apache.org/licenses/LICENSE-2.0
-# Documentation Project: Subversion #
+# SVN Workflow
-The documentation of the Apache HTTP Server is in the same Subversion
-revision control repository as the code. If you wish to work on the
-documentation, you can check out the entire source code repository, or just
-the documentation.
+The Apache HTTP Server documentation lives in the same Subversion (SVN)
+repository as the server source code. This page walks you through
+checking out the docs and submitting patches.
-To check out the entire repository, you'll do the following:
+If you're new to SVN, don't worry — the commands below are all you need
+to get started.
+
+## Checking Out the Repository
+
+There are two active branches:
+
+- **trunk** — the development branch (next release)
+- **2.4.x** — the current stable release
+
+To check out both:
svn checkout https://svn.apache.org/repos/asf/httpd/httpd/trunk httpd-trunk
svn checkout https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x httpd-2.4
-By checking out both trunk and 2.4, you'll be able to submit patches
-against both the development version, and the current latest released
-version.
+We recommend checking out both so you can submit patches against either
+branch. Most documentation patches should target **trunk** first, then
+be backported to 2.4.x if applicable.
+
+### Docs-Only Checkout
+
+If you only want the documentation (smaller download), append `/docs`
+to the checkout URLs:
+
+ svn checkout https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs httpd-trunk-docs
+ svn checkout https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/docs httpd-2.4-docs
-To check out just the documentation portion of the repository, append '
-`/docs` ' to the end of the checkout URLs shown above. This will give you a
-much smaller checkout, but perhaps you'll lack some of the resources you
-might need to verify your documentation changes.
+This gives you a lighter checkout, though you won't have the full source
+tree for context.
-# Creating a patch #
+## Creating a Patch
-Once you have a checkout, creating a patch takes four steps.
+Once you have a checkout, the process is:
-1. Update your checkout, to be sure that you have the latest changes in the
- repository, in case someone else has changed something since the last time
- you worked on the docs:
+### 1. Update Your Checkout
+
+Always pull the latest changes before you start editing:
- <div class="example"><pre>
svn update
- </pre></div>
-2. Edit the file that you wish to modify. Make the desired changes, and then
- save your changes. Documentation files are in the `/docs/manual` subdirectory
- of your checkout.
+### 2. Edit the Documentation
+
+Documentation files are in the `docs/manual/` subdirectory. Find the
+file you want to change, make your edits, and save.
+
+### 3. Generate a Patch
+
+Create a unified diff of your changes:
+
+ svn diff > my-changes.patch
+
+To generate a patch for just one file:
+
+ svn diff docs/manual/mod/mod_rewrite.xml > mod_rewrite_fix.patch
-3. At the command line, type the following to create a patch file:
+### 4. Submit the Patch
- <div class="example"><pre>
- svn diff > patch.txt
- </pre></div>
+Send your patch to `[email protected]` with:
-4. Send email to the `[email protected]` mailing list and attach
- `patch.txt`.
+- The patch file attached
+- Which branch it's against (trunk, 2.4.x)
+- A brief description of what you changed and why
+- A reference to the Bugzilla ticket, if there is one
-If you have more than one changed file, you can supply the file name on the
-`svn diff` command line, in order to just record the changes in one file.
+Alternatively, attach the patch directly to a
+[Bugzilla ticket](https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=Documentation).
-<div class="example"><pre>
-svn diff mod_rewrite.xml > mod_rewrite_patch.txt
-</pre></div>
+## Tips
-# See Also #
+- **Name your patches descriptively** — `fix-proxy-example.patch` is
+ more helpful than `patch.txt`.
+- **Keep patches focused** — one logical change per patch is easier to
+ review.
+- **Check your XML** — run the validation targets before submitting
+ (see [documentation format](docsformat.html)).
+- **Don't worry about being perfect** — we're happy to work with you
+ on revisions.
-See also the document on [documentation format and
-transformation](docsformat.html) for details about verifying that your
-changes are compliant with our documentation format and standards. In your
-email message, indicate what branch of the code the patch is against
-(trunk, 2.4, 2.2, etc.) what file(s) are affected, and what change you are
-making. If it's in reference to a specific bug ticket, mention that, too.
+## See Also
+- [Documentation Format and Build](docsformat.html) — how to validate
+ and build the docs locally
+- [Style Guide](style-guide.html) — markup and prose conventions
+- [Tools for Contributors](tools.html) — recommended editors and
+ utilities
diff --git a/content/docs-project/tools.md b/content/docs-project/tools.md
new file mode 100644
index 0000000..4d2137f
--- /dev/null
+++ b/content/docs-project/tools.md
@@ -0,0 +1,141 @@
+Title: Tools for Contributors
+license: https://www.apache.org/licenses/LICENSE-2.0
+
+# Tools for Contributors
+
+You don't need much to contribute to the Apache HTTP Server
+documentation — a text editor and SVN will get you started. But the
+right tools can make the workflow smoother, especially if XML or SVN
+are new to you.
+
+Everything here is optional. Use whatever works for you.
+
+## Text Editors
+
+The documentation is written in XML, so an editor with XML support
+makes life easier — syntax highlighting, auto-closing tags, and
+validation feedback help catch mistakes early.
+
+- **VS Code** with the
+ [XML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml)
+ — good highlighting, schema validation, and auto-completion. Free and
+ cross-platform.
+- **Emacs** with `nxml-mode` — excellent built-in XML editing with
+ real-time validation against the DTD. Ships with Emacs.
+- **Vim** with XML plugins (e.g., `vim-xml`, `xmledit`) — tag matching
+ and completion for Vim users.
+- **Any editor** — the XML format is readable plain text. If you're
+ comfortable in your editor, it will work fine.
+
+## SVN Clients
+
+The command-line `svn` client is what most contributors use, and it's
+what our workflow documentation assumes. It's available on all platforms:
+
+- **Command-line svn** (recommended) — ships with most Linux
+ distributions. On macOS, install via Homebrew (`brew install svn`). On
+ Windows, available via
+ [SlikSVN](https://sliksvn.com/) or
+ [TortoiseSVN](https://tortoisesvn.net/) (which includes command-line
+ tools).
+- **TortoiseSVN** (Windows) — integrates with Windows Explorer. Good if
+ you prefer a GUI, but command-line is still recommended for generating
+ patches.
+- **svnX** (macOS) — a macOS GUI for SVN. Useful for browsing history
+ and viewing diffs visually.
+
+See the [SVN workflow page](svn.html) for checkout and patch
+instructions.
+
+## XML Validation
+
+Always validate your XML before submitting. Malformed XML breaks the
+build for everyone.
+
+- **The Ant build targets** — the official way. From your
+ `docs/manual/build/` directory:
+
+ ./build.sh validate-xml
+ ./build.sh validate-xhtml
+
+- **xmllint** (from libxml2) — quick command-line validation:
+
+ xmllint --noout --valid docs/manual/mod/mod_rewrite.xml
+
+ Available on most systems (`brew install libxml2` on macOS, usually
+ pre-installed on Linux).
+
+## Viewing Your Changes
+
+- **Browser XSLT** — modern browsers (Firefox, Chrome, Safari) can
+ render the XML files directly by applying the XSLT stylesheet. Just
+ open the `.xml` file in your browser for a quick preview.
+- **The Ant build** — for the authoritative rendering, build the HTML:
+
+ cd docs/manual/build
+ ./build.sh
+
+ Then open the generated HTML files in your browser.
+
+## Diff and Merge Tools
+
+For comparing revisions and reviewing changes:
+
+- **svn diff** — built into SVN, always available. Produces unified
+ diffs on the command line.
+- **Meld** — visual three-way diff/merge tool. Free, cross-platform.
+ Excellent for comparing your translation against updated English
+ source.
+- **vimdiff** — Vim's built-in diff mode. Fast and keyboard-driven.
+- **Beyond Compare** — commercial, but powerful for large comparison
+ tasks.
+- **VS Code** — built-in diff viewer works well for side-by-side
+ comparison of two files.
+
+## Regex Testing (for mod_rewrite docs)
+
+If you're working on `mod_rewrite` documentation, these tools help
+verify that regex examples are correct:
+
+- **[regex101.com](https://regex101.com/)** — interactive regex tester
+ with explanation. Select the PCRE2 flavor for httpd-compatible
+ patterns.
+- **[RegExr](https://regexr.com/)** — another visual regex tool with
+ a good reference panel.
+- **pcre2test** — command-line PCRE2 testing. The definitive tool for
+ verifying patterns exactly as httpd processes them.
+- **[grex](https://github.com/pemistahl/grex)** — generates regex
+ patterns from example strings. Useful for verifying that a documented
+ pattern matches what you expect.
+
+## AI Assistants
+
+AI coding assistants (GitHub Copilot, Claude, etc.) can help with XML
+markup if you're not familiar with the format — they're good at
+generating boilerplate tags, converting plain text to properly marked-up
+XML, and suggesting element structures.
+
+**However:** Always review AI-generated markup carefully. These tools
+can produce plausible-looking but incorrect XML, use wrong element
+names, or miss project-specific conventions. Human review is always
+needed. When in doubt, check the [style guide](style-guide.html).
+
+## Apache httpd Docs MCP Server
+
+The [Apache httpd docs MCP server](https://github.com/rbowen/apache-httpd-docs-mcp)
+lets you query the documentation programmatically — search directives,
+look up module details, and browse pages via AI assistants or scripts.
+Useful for quickly finding related documentation when writing new
+content or checking cross-references.
+
+## Summary
+
+| Task | Recommended Tool |
+|------|------------------|
+| Editing XML | VS Code + XML extension, Emacs nxml-mode, or Vim |
+| Version control | Command-line svn |
+| Validating XML | `./build.sh validate-xml` or xmllint |
+| Previewing output | Open .xml in browser, or full Ant build |
+| Comparing changes | svn diff, Meld, or vimdiff |
+| Testing regex | regex101.com (PCRE2 mode) |
+| Querying docs | Apache httpd docs MCP server |
diff --git a/content/docs-project/translations.md b/content/docs-project/translations.md
index 16067f4..04fb23e 100644
--- a/content/docs-project/translations.md
+++ b/content/docs-project/translations.md
@@ -1,107 +1,107 @@
-Title: Translations - Documentation Project
+Title: Translating the Documentation
license: https://www.apache.org/licenses/LICENSE-2.0
-# Welcome ! #
+# Translating the Documentation
-We encourage translations of the documentation into other languages and thank
-you in advance for your contribution. If you would like to assist in translating
-the docs, please start by reading the general [documentation project
-information](./) , and subscribing to the [documentation project mailing
-list](https://lists.apache.org/[email protected]). The documentation
-project participants are usually very willing to help you with any questions or
-technical difficulties that may arise during your work.
+Thank you for considering a translation contribution! Translations make
+the Apache HTTP Server documentation accessible to millions of
+non-English-speaking administrators worldwide.
-# Getting Started #
+Before you begin, please:
-To get started translating whole or part(s) of the doc and keep it up to date,
-you'll need to do the following.
+1. Read the general [documentation project information](./).
+2. Subscribe to the
+ [docs mailing list](mailto:[email protected]).
+3. 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.
-- Join the docs mailing list by sending a message to
- [[email protected]](mailto:[email protected]).
+## Getting Started
-- Send a message to the list above to say that you wish to get involved in
- translating the doc into your language. Maybe there's already in place a
- translation team for your language that will help you in your work.
+### 1. Set Up Your SVN Checkout
-- Let's suppose you look at https://httpd.apache.org/docs/trunk/configuring.html
- and see that there's no version of this page in your language.
+Check out the documentation source:
-- Get english version of the source file [here](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/manual/configuring.xml)
- Note that you must download the .xml file, not the .html one.
+ svn checkout https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs httpd-trunk-docs
-- Make a copy of that file with the two-letter file extension representing your
- language. For example, for a Spanish translation, you'd copy `configuring.xml`
- to `configuring.xml.es`. You are now ready to start well said translation :
+Start your translations in **trunk**. Changes can be backported to the
+2.4.x branch afterward.
- - If your language contains accented and/or multi-bytes characters, set
- your text editor encoding to "UTF-8" , and check that the first line
- of the file is:<br />
- <?xml version="1.0" encoding="UTF-8" ?>
- - In the header, replace the string "$LastChangedRevision:" by the
- string "English Revision:"
- - Make sure you put your name at the top of the file if you are
- translating or reviewing the documentation like this:<br />
- <!-- French translation : <translator name> --><br />
- <!-- Reviewed by : <reviewer name> -->
- - Translate all textual portions of the document, leaving directives,
- examples, and other literal code portions unchanged.
- - What has to be translated ? All text parts between <p> and
- </p>, <title> and </title>, <description> and
- </description>, <name> and </name>,
- <compatibility> and </compatibility>, <note> and
- </note>, <li> and </li>, <dd> and </dd>.
- - We strongly encourage xml file to fit within <b>80</b> console width, so
- it is easy for any maintainer to review the files. Exceptions do happen for
- complex xml tags and unspaced languages such as Chinese and Japanese.
+### 2. Choose a File to Translate
-- Send your results - either complete files, or the output of `svn diff` to the
- docs mailing list, in order someone can commit it to the repository. Eventually,
- you can do this step yourself.
+Check the [translation status](avail_translations.html) to see what's
+already been translated and what's needed.
-# Going further ! #
+Pick an untranslated file — for example, suppose you want to translate
+`configuring.xml` into Spanish.
-If you wish to go further in translating of the doc, in other words maintaining
-your translations and keep them up-to-date, read [this
-document](goingfurther.html).
+### 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.
-# Related Information #
+- **Add translator credits** at the top of the file:
-Please note the following documents. They give you further information which may
-be helpful.
+ <!-- Spanish translation: Your Name -->
+ <!-- Reviewed by: Reviewer Name -->
-- The [Documentation Format and
- Transformation](https://httpd.apache.org/docs-project/docsformat.html) page
- gives some information about the transformation from xml to html.
- Translations of documentation for Apache version 2.0 and higher should be sent
- as xml file. Committers will take care of generating and committing the
- corresponding html file.
+- **Translate the text content.** Translate text within: `<p>`,
+ `<title>`, `<description>`, `<name>`, `<compatibility>`, `<note>`,
+ `<li>`, `<dd>`, and similar elements.
-# Review Standards #
+- **Leave code unchanged.** Directives, configuration examples, and
+ other literal code stay in English.
-Because English is the main development language of the Apache HTTP Server, it
-is difficult for the developers to check the quality of documentation submitted
-in other languages. Therefore, we require that all translated documentation be
-reviewed by another fluent speaker of the relevant language, before it can be
-accepted. Each commit message should list the reviewer. If the translator is not
-the same as the committer, the translator should also be named in the commit
-message.
+- **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.)
-We also encourage you to place the name of the translator in a comment at the
-top of the file, like this:
+### 5. Submit Your Translation
- <!-- ===================================================== Translated by:
- Nilgün Belma Bugüner <nilgun belgeler.org> Reviewed by: Orhan Berent
- <berent belgeler.org>
- ========================================================== -->
-
-The build system keeps track of the svn revision number of the equivalent
-English version, so that future translators have an idea of where they need to
-start.
+Send your completed file (or a patch) to `[email protected]`. A
+committer will review it and add it to the repository. Over time, you
+may gain commit access yourself.
+## Keeping Translations Current
+Once your initial translation is committed, you'll want to keep it up to
+date as the English source evolves. See
+[Maintaining Translations](goingfurther.html) for a practical workflow.
+
+## 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.
+
+## Related Information
+
+- [Documentation Format](docsformat.html) — the XML format and how to
+ build HTML from it
+- [Translation Status](avail_translations.html) — what's been
+ translated and what's needed
+- [Maintaining Translations](goingfurther.html) — keeping your work
+ up to date
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.