1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncApache HTTP Server Trunk Documentation Status File.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncLast modified: $Date$

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncFor more information on how to contribute to the Apache Documentation

1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncProject, please see http://httpd.apache.org/docs-project/ and

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync ------------------------------

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsyncTo Do List

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync=======================

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- The 1.3 docs need to have links from each directive forward to the

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync /docs/current/ version of that directive, or a note that it's not

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync avaialble in this century. See core.html for examples of how this

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync might be done. This is a large undertaking, and involves a lot of

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync grunt work, but will be greatly appreciated by the folks that make it

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync to the wrong doc via Google. (Update: This is clearly going to take

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync many months of effort, due to the volume of work and the mind-numbing

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync tediousness.)

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- Update the http://httpd.apache.org/docs-project/docsformat.html

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync document to be useful. In particular:

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Document the various macros that can be used in documents.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Document the translation process.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Generally update it to make it reflect the current reality of how

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync we work.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Improving the documentation of the documentations' build system

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync itself (requirements, procedures)

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- Identify which documents are grossly out of date, and fix.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- The FAQ never amounted to much. Review the current FAQ, which is

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync 1.3-era, and bring it into this century. (RBowen - I've copied the FAQ

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync into the wiki at http://wiki.apache.org/httpd/FAQ and am editing it

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync there. Consensus seems to be that this should be its new home.)

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- Security docs are unhelpful, and assume that the reader knows nothing.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync Need something a little more advanced, which either discusses

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync application-level security, or links to something that does. I'm not

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync even sure what to say needs done. Can we get someone to elaborate on

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync what, exactly, needs written? Ivan Ristic has said maybe he would be

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync willing to contribute.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - More content and better organisation

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_dav resources are owned by the httpd. Perhaps write up the

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync two-httpd dav setup covered in Rich Bowen's DAV Apachecon

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync presentation.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- Performance doc is way too low-level. Several people have said that

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync they might help out here, but it's a significant undertaking, and more

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync than a little daunting.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- Windows platform docs are in desperate need of rewrites/updates for 2.x.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Bill Rowe is a good contact for tech questions.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - "using apache" has been done, "compiling apache" is still open

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - hints on uninstalling apache (exit monitor, close directories,

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync registry entries etc) (PR 10154)

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - FAQ: UTF-8 config and URL encoding for non-ascii characters.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- New Auth system

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Much clean-up and enhancement of aaa howto

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Independent note on how to upgrade to new auth system

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - Discussion of DBD auth, and, in particular, examples of how to set

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync up auth using each of the supported databases.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync Start is in expr.xml, igalic is working on this

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- modules docs

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - the follwing modules added since 2.2 lack documentation

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_serf

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_watchdog

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_heartbeat

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_heartmonitor

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_lbmethod_bybusyness

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_lbmethod_byrequests

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_lbmethod_bytraffic

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_lbmethod_heartbeat

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_socache_dbm

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_socache_memcache

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_socache_shmcb

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mpm_simple

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync the list may be incomplete

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync maybe some of the modules will not be included in 2.4

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - The following modules have new docs added since 2.2, but are

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync grossly lacking in details and examples.

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_dialup

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_suexec: very little documentation

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - mod_rewrite: explain, when which variables are actually available

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync (PR 16402)

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- mod_substitute and reverse proxies: Add example using mod_filter

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync- MPM documentation

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync - explain what the following command line options do

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync (perhaps in the developer/debugging docs):

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync -D DEBUG

1b33c96954667ba382fa595baf7b31290bfdd517vboxsync -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.

- platform/ebcdic.xml - needs major rework for 2.0

- dso.xml - Reads as though this is a nifty new thing we just came

up with recently.

- 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 <Proxy> 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 <category> element in modulesynopsis

- Use a tag like <var> in place of <em> for things like the

<syntax> listing.

- in progress

- add letter links to glossary and quickreference,

perhaps also a term overview (sidebar)

- remove <pre> elements. Use <br /> and <indent> 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, log rotation, and log reporting

- Secure mod_dav configuration

- 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

- API docs are generated via 'make dox'. Find somewhere that we can

do this on a schedule, and link to that from the documentation.

- 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.

- I'd like to expand the discussion of conditional logging, and add a

few more useful exmaples.

That would be a good place to document logging of cache hit/miss:

https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2

- Is it worth having a doc that discusses recommended (what does this

mean?) third-party modules like mod_security, mod_php, and so on - the

things that we all assume everyone uses, but some folks might not know

about.

- Clarify which directives only affect requests when they're handled

by the default handler. (e.g. ForceType, TraceEnable, etc.)

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.