1c42de6d020629af774dd9e9fc81be3f3ed9398egdApache HTTP Server 2.1 Documentation Status File.

1c42de6d020629af774dd9e9fc81be3f3ed9398egdLast modified: $Date: 2003/04/09 21:58:52 $

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

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

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

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd ------------------------------

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egdDecisions pending

1c42de6d020629af774dd9e9fc81be3f3ed9398egd=================

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd -Comment out .gz etc. AddEncoding lines in our default configuration.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd docs/conf/httpd-std.conf.in rev 1.32

1c42de6d020629af774dd9e9fc81be3f3ed9398egd jerenkranz: Current browsers have a tendency to decompress the data

1c42de6d020629af774dd9e9fc81be3f3ed9398egd when no one really wants it to do that. If you want the

1c42de6d020629af774dd9e9fc81be3f3ed9398egd 2.0 behavior that leads to transparent decompression

1c42de6d020629af774dd9e9fc81be3f3ed9398egd by modern browsers, uncomment these lines. But, this

1c42de6d020629af774dd9e9fc81be3f3ed9398egd shouldn't be our default, and certainly wasn't in 1.3.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Backport to 2.0

1c42de6d020629af774dd9e9fc81be3f3ed9398egd +1: wrowe, slive

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- Figure out what to do about the 2.0 FAQ

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Copy important stuff from 1.3?

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Some kind of XML?

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Something that allows dynamic contributions from users a la

1c42de6d020629af774dd9e9fc81be3f3ed9398egd FAQ-O-Matic? (I don't think any really good software exists

7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe for this.)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Perhaps we can use the newly created Wiki for this. (SubWiki,

1c42de6d020629af774dd9e9fc81be3f3ed9398egd with the possibility to get nice commit mails.)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd nd: someone should try to convince me, what the heck is

1c42de6d020629af774dd9e9fc81be3f3ed9398egd so cool with wikis -- nd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd erik: it lowers the entry barrier and therefore users are able to

1c42de6d020629af774dd9e9fc81be3f3ed9398egd contribute (handy for a FAQ, see PHP site)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd nd: yes, good bad example. The PHP docs would mostly be

1c42de6d020629af774dd9e9fc81be3f3ed9398egd better without these comments. I don't want to censor

1c42de6d020629af774dd9e9fc81be3f3ed9398egd the entries, but also don't want to leave them without

1c42de6d020629af774dd9e9fc81be3f3ed9398egd control. IMHO it's better to incorporate changes into the

1c42de6d020629af774dd9e9fc81be3f3ed9398egd static docs. We need some better way of feedback, anyway.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egdThings That Need Fixing

1c42de6d020629af774dd9e9fc81be3f3ed9398egd=======================

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- XML

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Rewriting of the remainder of the manual into xml is in

1c42de6d020629af774dd9e9fc81be3f3ed9398egd progress. See the bottom of this file for status info.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - add ids to non-directive sections of the module docs, so they

1c42de6d020629af774dd9e9fc81be3f3ed9398egd get a chance to be linked in the sidebar

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- Windows platform docs are in desperate need of rewrites/updates for 2.0.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Bill Rowe and Bill Stoddard are good contacts for tech questions.

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

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

1c42de6d020629af774dd9e9fc81be3f3ed9398egd registry entries etc) (PR 10154)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - FAQ! UTF-8 config and URL encoding for non-ascii characters.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- New Auth system

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

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

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- modules docs

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - mod_suexec: very little documentation

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - mod_proxy: updates for 2.0

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - mod_status: updates for 2.0

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - mod_example: updates for 2.0

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - mod_rewrite: explain, when what variables are actually available

1c42de6d020629af774dd9e9fc81be3f3ed9398egd (PR 16402)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- man pages

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - Convert from nroff to our xml format. See list at bottom.

7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe - Then if someone gets creative, they can try to find an automatic

7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe way to convert back to nroff.

7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe - An example: http://cyberelk.net/tim/data/xmlto/db2man/

1c42de6d020629af774dd9e9fc81be3f3ed9398egd This is designed for docbook, but it could be adapted.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd I'm not sure what the license is.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- MPM documentation

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - explain what the following command line options do

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

1c42de6d020629af774dd9e9fc81be3f3ed9398egd -D DEBUG

1c42de6d020629af774dd9e9fc81be3f3ed9398egd -D ONE_PROCESS

1c42de6d020629af774dd9e9fc81be3f3ed9398egd one-process-mode == no threads, i.e. only one

1c42de6d020629af774dd9e9fc81be3f3ed9398egd process handling the requests in a single loop?

1c42de6d020629af774dd9e9fc81be3f3ed9398egd -D NO_DETACH (not in every MPM avail.)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd no daemon, but detached from terminal?

1c42de6d020629af774dd9e9fc81be3f3ed9398egd -D FOREGROUND (not in every MPM avail.)

1c42de6d020629af774dd9e9fc81be3f3ed9398egd ?

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- Individual docs will need some cleanup.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - misc/custom_errordocs.html needs to be updated to

1c42de6d020629af774dd9e9fc81be3f3ed9398egd essentially describe how the international error

1c42de6d020629af774dd9e9fc81be3f3ed9398egd docs included in 2.0 work

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - misc/perf-tuning.html - needs major rewrite for 2.0

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0

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

1c42de6d020629af774dd9e9fc81be3f3ed9398egd

1c42de6d020629af774dd9e9fc81be3f3ed9398egd- New build process.

1c42de6d020629af774dd9e9fc81be3f3ed9398egd - install.html has had a first-pass rewrite, it is basically

accurate, but very incomplete: many configure options are missing,

especially those inherited from apr.

- API documentation

- Ben Laurie has written some hooks documentation

- authn provider API documentation could be useful

- Several features in Apache require write-access to the filesystem.

Examples: CacheRoot, DavLockDB, ScriptLog

We should treat the things consistently in the docs, and perhaps

suggest the use of directory like /usr/local/apache2/var/ that is

httpd-writable.

- SSL docs are generally good, but they need a refreshing by someone

familiar with mod_ssl and openssl.

Documentation improvements

==========================

* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)

* Enhancements to the DTD/XSL:

- <glossary> tag that links to the glossary and uses some special

style in the css.

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

- cross references between the different languages,

at least links from non-en docs to the originals.

- Javascript?

- post processing (s&r, XML::Parser, ...)?

- pre processing ([kind of] type maps

generated from sitemap entries like:

<page><variant lang="en" href="">title</variant>)?

- looking for other good ideas ;-)

- remove <pre> elements. Use <br /> and <indent> elements to get

a similar effect.

* Autogeneration of PDF

- Andr� is working on this, Erik volunteers to help out

* Windows help file

- David Shane Holden was working on this

* Improving the "security docs"

- More content and better organisation.

- mod_dav ressources are owned by the httpd

* General cleaning and improving of module docs

* Making the directive definitions "less terse" (i.e., adding more

examples and details to the definitions of the directives)

* Making site-specific enhancements easier, including a documented

and robust way for 3P module docco to be added -- and have it

survive a server docco upgrade

- This could be something a simple and hackish as a manual/extra/

directory (a la the 1.3 src/modules/extra/ directory) and a

script in the support directory that scans the files there and

updates the manual indices. (We do something like that now for

httpd.conf file with apxs [LoadModule, etc.].)

* Summarize all the implemented drafts/standards with short explanations

within a document. (PR 16938)

XML Conversions

===============

The following files need to be converted to XML as described at

expand.pl # delete after finishing everything

# These will require manual.xsl changes

faq/footer.html

# Perhaps these should be left in html to allow the developers to

# play with them

# nope. in order to create other formats, we need 'em as xml. --nd

# converting from nroff to xml