Apache HTTP Server Trunk Documentation Status File. Last modified: $Date$ For more information on how to contribute to the Apache Documentation Project, please see http://httpd.apache.org/docs-project/ and http://httpd.apache.org/docs-project/docsformat.html ------------------------------ Decisions pending ================= - Determine what The Right Way to use the terms "Apache", "Apache HTTP Server" and "httpd" are. Whether they require specific markup or links. (Rich) I've been using Apache HTTP Server in the first mention, and httpd thereafter, but there are some contexts in which this is awkward. To Do List ======================= - Refer to this product as either 'Apache HTTP Server' or 'httpd', as appropriate in context, rather than just 'Apache'. 'Apache' is the Apache Software Foundation. - Remove mentions of the 1.2 and 1.3 versions of the server. - Update the http://httpd.apache.org/docs-project/docsformat.html document to be useful. In particular: - Document the various macros that can be used in documents. - Document the translation process. - Generally update it to make it reflect the current reality of how we work. - Improving the documentation of the documentations' build system itself (requirements, procedures) - Update this document. Determine which of these issues are in fact still open, and which have already been dealt with. - Identify which documents are grossly out of date, and fix. - The FAQ never amounted to much. Review the current FAQ, which is 1.3-era, and bring it into this century. - Security docs are unhelpful, and assume that the reader knows nothing. Need something a little more advanced, which either discusses application-level security, or links to something that does. I'm not even sure what to say needs done. Can we get someone to elaborate on what, exactly, needs written? Ivan Ristic has said maybe he would be willing to contribute. - More content and better organisation - mod_dav resources are owned by the httpd. Perhaps write up the two-httpd dav setup covered in Rich Bowen's DAV Apachecon presentation. - Performance doc is way too low-level. Several people have said that they might help out here, but it's a significant undertaking, and more than a little daunting. - Windows platform docs are in desperate need of rewrites/updates for 2.x. - Bill Rowe and Bill Stoddard are good contacts for tech questions. - "using apache" has been done, "compiling apache" is still open - hints on uninstalling apache (exit monitor, close directories, registry entries etc) (PR 10154) - FAQ: UTF-8 config and URL encoding for non-ascii characters. - New Auth system - Much clean-up and enhancement of aaa howto - Independent note on how to upgrade to new auth system - Discussion of DBD auth, and, in particular, examples of how to set up auth using each of the supported databases. - modules docs - mod_suexec: very little documentation - mod_rewrite: explain, when which variables are actually available (PR 16402) - MPM documentation - explain what the following command line options do (perhaps in the developer/debugging docs): -D DEBUG -D ONE_PROCESS one-process-mode == no threads, i.e. only one process handling the requests in a single loop? - Individual docs will need some cleanup. - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0 - platform/ebcdic.xml - needs major rework for 2.0 - API documentation - Ben Laurie has written some hooks documentation - authn provider API documentation could be useful - SSL docs need serious update and enhancement - compat docs are wrong - no basic how to setup ssl doc mads said he was working on this, but... - How does fit into sections.html? - Missing documentation for the support program checkgid - New user docs: Directory Handling (mod_dir/mod_autoindex/etc) (draft available in wiki) - Enhancements to the DTD/XSL: - New index: directives by context, including listing which directives are available for each AllowOverride setting. - New index: backout modules by type (aaa, mappers, loggers etc.) probably by introducing a element in modulesynopsis - Use a tag like in place of for things like the listing. - in progress - add letter links to glossary and quickreference, perhaps also a term overview (sidebar) - remove 
 elements. Use 
 and  elements to get
    a similar effect.

- Provide example solutions for the mapping of encodings, especially
  for .gz etc. (also in regard to our default configuration)

- How-To style documents for more of the daily tasks
    - Logging and log reporting
    - ?

- Writing modules - Can we provide a basic intro to writing modules,
  perhaps based around mod_example, or one of the other simple example
  modules?

- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
  profound embarrassment.
    - Purge all the dead links
    - Figure out how to auto-generate API docs, and do it
    - Introductory module authoring doc
    - Verify links to external resources at least every year

- Update the list of translations at
  http://httpd.apache.org/docs-project/translations.html  Some of those
  are accurate, and others are way outdated.

- Rewriting the 'custom error' doc, which is ancient and doesn't flow
  very well.

- I'd like to expand the discussion of conditional logging, and add a
  few more useful exmaples.

LaTeX Todo list
==================

- Dozens of other little problems with presentation, cross-referencing,
  etc.

- Cleanup xsl to make it more readable.  Almost everything
  that is currently in latex.xsl should probably be moved to common.xsl.
  There may be a license problem with the atbeginend.sty file, since
  latex style files rarely have explict licenses.  At worst, we can
  drop this and manually adjust the relevant spacing.

- Reduce the size of the pdf (both bytes and pages) in any way possible.

- Translations.