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