STATUS revision 5e0a94ecb5d8389a83e32138ed3784d0b5897088
5253N/AApache HTTP Server 2.1 Documentation Status File.
5253N/ALast modified: $Date: 2003/05/31 22:00:27 $
5253N/A
5253N/AFor more information on how to contribute to the Apache Documentation
5253N/AProject, please see http://httpd.apache.org/docs-project/
5253N/A
5253N/A ------------------------------
5253N/A
5253N/ADecisions pending
5253N/A=================
5253N/A
5253N/A -Comment out .gz etc. AddEncoding lines in our default configuration.
5253N/A docs/conf/httpd-std.conf.in rev 1.32
5253N/A jerenkrantz said in the log message:
5253N/A Current browsers have a tendency to decompress the data when no one
5253N/A really wants it to do that. If you want the old behavior that leads to
5253N/A transparent decompression by modern browsers, uncomment these lines.
5253N/A But, this shouldn't be our default.
5253N/A Someone else said: Certainly wasn't in 1.3.
5253N/A nd adds: we should provide example solutions somewhere in the docs.
5253N/A e.g.: .tar.gz should get the content-type application/x-gzip
5253N/A (hmm, bad x-, better suggestions?).
5305N/A <Files *.tar.gz>
5253N/A Forcetype ...
5253N/A </Files>
5254N/A
5254N/A - Backport to 2.0
5254N/A +1: wrowe, slive, nd
5253N/A
5253N/A- Figure out what to do about the 2.0 FAQ
5253N/A - Copy important stuff from 1.3?
5253N/A - Some kind of XML?
5253N/A - Perhaps we can use the newly created Wiki for this. (SubWiki,
5253N/A with the possibility to get nice commit mails.)
5253N/A nd: someone should try to convince me, what the heck is
5253N/A so cool with wikis
5253N/A erik: it lowers the entry barrier and therefore users are able to
5253N/A contribute (handy for a FAQ, see PHP site)
5253N/A nd: yes, good bad example. The PHP docs would mostly be
5253N/A better without these comments. I don't want to censor
5253N/A the entries, but also don't want to leave them without
5253N/A control. IMHO it's better to incorporate changes into the
5253N/A static docs. We need some better way of feedback, anyway.
5253N/A
5253N/AThings That Need Fixing
5253N/A=======================
5253N/A
5253N/A- Windows platform docs are in desperate need of rewrites/updates for 2.0.
5253N/A - Bill Rowe and Bill Stoddard are good contacts for tech questions.
5253N/A - "using apache" has been done, "compiling apache" is still open
5253N/A - hints on uninstalling apache (exit monitor, close directories,
5256N/A registry entries etc) (PR 10154)
5256N/A - FAQ! UTF-8 config and URL encoding for non-ascii characters.
5256N/A
5256N/A- New Auth system
5256N/A - Much clean-up and enhancement of aaa howto
5256N/A - Independent note on how to upgrade to new auth system
5256N/A
5256N/A- modules docs
5253N/A - mod_suexec: very little documentation
5253N/A - mod_proxy: updates for 2.0
5253N/A - mod_status: updates for 2.0
5253N/A - mod_example: updates for 2.0
5253N/A - mod_rewrite: explain, when what variables are actually available
5253N/A (PR 16402)
5253N/A
5253N/A- man pages
5253N/A - Convert from nroff to our xml format. See list at bottom.
5253N/A - Then if someone gets creative, they can try to find an automatic
5253N/A way to convert back to nroff.
5253N/A - An example: http://cyberelk.net/tim/data/xmlto/db2man/
5253N/A This is designed for docbook, but it could be adapted.
5253N/A I'm not sure what the license is.
5253N/A
5305N/A- MPM documentation
5305N/A - explain what the following command line options do
5253N/A (perhaps in the developer/debugging docs):
5305N/A -D DEBUG
5305N/A -D ONE_PROCESS
5305N/A one-process-mode == no threads, i.e. only one
5305N/A process handling the requests in a single loop?
5305N/A -D NO_DETACH (not in every MPM avail.)
5305N/A no daemon, but detached from terminal?
5305N/A -D FOREGROUND (not in every MPM avail.)
5305N/A ?
5305N/A
5305N/A- Individual docs will need some cleanup.
5305N/A - misc/custom_errordocs.html needs to be updated to
5305N/A essentially describe how the international error
5305N/A docs included in 2.0 work
5305N/A - misc/perf-tuning.html - needs major rewrite for 2.0
5305N/A - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
5305N/A - platform/ebcdic.xml - needs major rework for 2.0
5305N/A
5305N/A- New build process.
5305N/A - install.html has had a first-pass rewrite, it is basically
5305N/A accurate, but very incomplete: many configure options are missing,
5305N/A especially those inherited from apr.
5305N/A
5305N/A- API documentation
5305N/A - Ben Laurie has written some hooks documentation
5305N/A - authn provider API documentation could be useful
5305N/A
5305N/A- Several features in Apache require write-access to the filesystem.
5253N/A Examples: CacheRoot, DavLockDB, ScriptLog
5253N/A We should treat the things consistently in the docs, and perhaps
5253N/A suggest the use of directory like /usr/local/apache2/var/ that is
5253N/A httpd-writable.
5253N/A
5253N/A- SSL docs are generally good, but they need a refreshing by someone
5305N/A familiar with mod_ssl and openssl.
5253N/A
5253N/ADocumentation improvements
5253N/A==========================
5253N/A
5253N/A* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
5253N/A
5253N/A* Enhancements to the DTD/XSL:
5253N/A - <glossary> tag that links to the glossary and uses some special
5253N/A style in the css.
5253N/A - New index: directives by context, including listing which directives
5253N/A are available for each AllowOverride setting.
5253N/A - New index: backout modules by type (aaa, mappers, loggers etc.)
5253N/A probably by introducing a <category> element in modulesynopsis
5253N/A - Use a tag like <var> in place of <em> for things like the
5253N/A <syntax> listing.
5253N/A - in progress
5253N/A - add letter links to glossary and quickreference,
5253N/A perhaps also a term overview (sidebar)
5253N/A - cross references between the different languages,
5253N/A at least links from non-en docs to the originals.
5253N/A - Javascript?
5253N/A - post processing (s&r, XML::Parser, ...)?
5253N/A - pre processing ([kind of] type maps
5256N/A generated from sitemap entries like:
5256N/A <page><variant lang="en" href="">title</variant>)?
5253N/A - looking for other good ideas ;-)
5253N/A - remove <pre> elements. Use <br /> and <indent> elements to get
5253N/A a similar effect.
5253N/A
5253N/A* Autogeneration of PDF
5253N/A - Andr� is working on this, Erik volunteers to help out
5253N/A
5253N/A* Improving the "security docs"
5253N/A - More content and better organisation.
5253N/A - mod_dav ressources are owned by the httpd
5253N/A
5253N/A* General cleaning and improving of module docs
5253N/A
5253N/A* Making the directive definitions "less terse" (i.e., adding more
5253N/A examples and details to the definitions of the directives)
5253N/A
5253N/A* Making site-specific enhancements easier, including a documented
5253N/A and robust way for 3P module docco to be added -- and have it
5253N/A survive a server docco upgrade
5253N/A
5253N/A - This could be something a simple and hackish as a manual/extra/
5253N/A directory (a la the 1.3 src/modules/extra/ directory) and a
5253N/A script in the support directory that scans the files there and
5253N/A updates the manual indices. (We do something like that now for
5253N/A httpd.conf file with apxs [LoadModule, etc.].)
5253N/A
5253N/A* Summarize all the implemented drafts/standards with short explanations
5253N/A within a document. (PR 16938)
5253N/A
5253N/A