0N/AApache HTTP Server 2.1 Documentation Status File.
0N/ALast modified: $Date: 2003/04/30 23:25:08 $
0N/AFor more information on how to contribute to the Apache Documentation
0N/A ------------------------------
0N/A - Backport removal of SSI from docs directory in default config
0N/A -Comment out .gz etc. AddEncoding lines in our default configuration.
0N/A jerenkrantz said in the log message:
2362N/A Current browsers have a tendency to decompress the data when no one
2362N/A really wants it to do that. If you want the old behavior that leads to
2362N/A transparent decompression by modern browsers, uncomment these lines.
0N/A But, this shouldn't be our default.
0N/A Someone else said: Certainly wasn't in 1.3.
0N/A nd adds: we should provide example solutions somewhere in the docs.
0N/A (hmm, bad x-, better suggestions?).
0N/A +1: wrowe, slive, nd
0N/A- Figure out what to do about the 2.0 FAQ
0N/A - Copy important stuff from 1.3?
0N/A - Something that allows dynamic contributions from users a la
0N/A FAQ-O-Matic? (I don't think any really good software exists
0N/A - Perhaps we can use the newly created Wiki for this. (SubWiki,
0N/A with the possibility to get nice commit mails.)
0N/A nd: someone should try to convince me, what the heck is
0N/A erik: it lowers the entry barrier and therefore users are able to
0N/A contribute (handy for a FAQ, see PHP site)
0N/A nd: yes, good bad example. The PHP docs would mostly be
0N/A better without these comments. I don't want to censor
0N/A the entries, but also don't want to leave them without
0N/A control. IMHO it's better to incorporate changes into the
0N/A static docs. We need some better way of feedback, anyway.
0N/AThings That Need Fixing
0N/A=======================
0N/A - Rewriting of the remainder of the manual into xml is in
0N/A progress. See the bottom of this file for status info.
0N/A - add ids to non-directive sections of the module docs, so they
0N/A get a chance to be linked in the sidebar
0N/A - Bill Rowe and Bill Stoddard are good contacts for tech questions.
0N/A - "using apache" has been done, "compiling apache" is still open
0N/A - hints on uninstalling apache (exit monitor, close directories,
0N/A registry entries etc) (PR 10154)
0N/A - FAQ! UTF-8 config and URL encoding for non-ascii characters.
0N/A - Much clean-up and enhancement of aaa howto
0N/A - Independent note on how to upgrade to new auth system
0N/A - mod_suexec: very little documentation
0N/A - mod_proxy: updates for 2.0
0N/A - mod_status: updates for 2.0
0N/A - mod_example: updates for 2.0
0N/A - mod_rewrite: explain, when what variables are actually available
0N/A - Convert from nroff to our xml format. See list at bottom.
0N/A - Then if someone gets creative, they can try to find an automatic
0N/A way to convert back to nroff.
0N/A This is designed for docbook, but it could be adapted.
0N/A I'm not sure what the license is.
0N/A - explain what the following command line options do
0N/A one-process-mode == no threads,
i.e. only one
0N/A process handling the requests in a single loop?
0N/A -D NO_DETACH (not in every MPM avail.)
0N/A no daemon, but detached from terminal?
0N/A -D FOREGROUND (not in every MPM avail.)
0N/A- Individual docs will need some cleanup.
0N/A essentially describe how the international error
0N/A docs included in 2.0 work
0N/A accurate, but very incomplete: many configure options are missing,
0N/A especially those inherited from apr.
0N/A - Ben Laurie has written some hooks documentation
0N/A - authn provider API documentation could be useful
0N/A- Several features in Apache require write-access to the filesystem.
0N/A Examples: CacheRoot, DavLockDB, ScriptLog
0N/A We should treat the things consistently in the docs, and perhaps
0N/A- SSL docs are generally good, but they need a refreshing by someone
0N/A familiar with mod_ssl and openssl.
0N/ADocumentation improvements
0N/A==========================
0N/A - <glossary> tag that links to the glossary and uses some special
0N/A - New index: directives by context, including listing which directives
0N/A are available for each AllowOverride setting.
0N/A - New index: backout modules by type (aaa, mappers, loggers etc.)
0N/A probably by introducing a <category> element in modulesynopsis
0N/A - Use a tag like <var> in place of <em> for things like the
0N/A - add letter links to glossary and quickreference,
0N/A perhaps also a term overview (sidebar)
0N/A - cross references between the different languages,
0N/A at least links from non-en docs to the originals.
0N/A - post processing (s&r, XML::Parser, ...)?
0N/A - pre processing ([kind of] type maps
0N/A generated from sitemap entries like:
0N/A <page><variant lang="en" href="">title</variant>)?
0N/A - looking for other good ideas ;-)
0N/A - remove <pre> elements. Use <br /> and <indent> elements to get
0N/A* Autogeneration of PDF
0N/A - Andr� is working on this, Erik volunteers to help out
0N/A* Improving the "security docs"
0N/A - More content and better organisation.
0N/A - mod_dav ressources are owned by the httpd
0N/A* General cleaning and improving of module docs
0N/A* Making the directive definitions "less terse" (
i.e., adding more
0N/A examples and details to the definitions of the directives)
0N/A* Making site-specific enhancements easier, including a documented
0N/A and robust way for 3P module docco to be added -- and have it
0N/A survive a server docco upgrade
0N/A script in the support directory that scans the files there and
0N/A updates the manual indices. (We do something like that now for
0N/A within a document. (PR 16938)
0N/AThe following files need to be converted to XML as described at
0N/A# Perhaps these should be left in html to allow the developers to
0N/A# nope. in order to create other formats, we need 'em as xml. --nd
0N/A# converting from nroff to xml