128N/AApache HTTP Server 2.1 Documentation Status File.
128N/ALast modified: $Date: 2003/04/10 18:03:58 $
128N/AFor more information on how to contribute to the Apache Documentation
128N/A ------------------------------
128N/A -Comment out .gz etc. AddEncoding lines in our default configuration.
128N/A jerenkrantz said in the log message:
128N/A Current browsers have a tendency to decompress the data when no one
128N/A really wants it to do that. If you want the old behavior that leads to
128N/A transparent decompression by modern browsers, uncomment these lines.
128N/A But, this shouldn't be our default.
128N/A Someone else said: Certainly wasn't in 1.3.
128N/A- Figure out what to do about the 2.0 FAQ
128N/A - Copy important stuff from 1.3?
1226N/A - Something that allows dynamic contributions from users a la
618N/A FAQ-O-Matic? (I don't think any really good software exists
1244N/A - Perhaps we can use the newly created Wiki for this. (SubWiki,
128N/A with the possibility to get nice commit mails.)
844N/A nd: someone should try to convince me, what the heck is
618N/A erik: it lowers the entry barrier and therefore users are able to
1289N/A contribute (handy for a FAQ, see PHP site)
128N/A nd: yes, good bad example. The PHP docs would mostly be
128N/A better without these comments. I don't want to censor
128N/A the entries, but also don't want to leave them without
128N/A control. IMHO it's better to incorporate changes into the
128N/A static docs. We need some better way of feedback, anyway.
128N/A - Rewriting of the remainder of the manual into xml is in
128N/A progress. See the bottom of this file for status info.
128N/A - add ids to non-directive sections of the module docs, so they
128N/A get a chance to be linked in the sidebar
128N/A - Bill Rowe and Bill Stoddard are good contacts for tech questions.
128N/A - "using apache" has been done, "compiling apache" is still open
128N/A - hints on uninstalling apache (exit monitor, close directories,
128N/A registry entries etc) (PR 10154)
128N/A - FAQ! UTF-8 config and URL encoding for non-ascii characters.
128N/A - Much clean-up and enhancement of aaa howto
128N/A - Independent note on how to upgrade to new auth system
128N/A - mod_suexec: very little documentation
181N/A - mod_proxy: updates for 2.0
128N/A - mod_status: updates for 2.0
181N/A - mod_example: updates for 2.0
128N/A - mod_rewrite: explain, when what variables are actually available
128N/A - Convert from nroff to our xml format. See list at bottom.
128N/A - Then if someone gets creative, they can try to find an automatic
128N/A way to convert back to nroff.
128N/A This is designed for docbook, but it could be adapted.
I'm not sure what the license is.
- explain what the following command line options do
one-process-mode == no threads,
i.e. only one
process handling the requests in a single loop?
-D NO_DETACH (not in every MPM avail.)
no daemon, but detached from terminal?
-D FOREGROUND (not in every MPM avail.)
- Individual docs will need some cleanup.
essentially describe how the international error
docs included in 2.0 work
-
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.
- 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
- SSL docs are generally good, but they need a refreshing by someone
familiar with mod_ssl and openssl.
Documentation improvements
==========================
- <glossary> tag that links to the glossary and uses some special
- 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
- 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.
- 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
- Andr� is working on this, Erik volunteers to help out
- 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/
script in the support directory that scans the files there and
updates the manual indices. (We do something like that now for
within a document. (PR 16938)
The following files need to be converted to XML as described at
expand.pl # delete after finishing everything
# Perhaps these should be left in html to allow the developers to
# nope. in order to create other formats, we need 'em as xml. --nd
# converting from nroff to xml