STATUS revision fc574f5c47e8a186de37def3495ec1820f64fed7
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkApache HTTP Server 2.1 Documentation Status File.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkLast modified: $Date: 2003/01/09 20:15:04 $
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkFor more information on how to contribute to the Apache Documentation
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkProject, please see http://httpd.apache.org/docs-project/
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk ------------------------------
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkDecisions pending
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk=================
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- Where to put docs checkout on website
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Leave it at /docs-x.y/
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- Figure out what to do about the 2.0 FAQ
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Copy important stuff from 1.3?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Some kind of XML?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Something that allows dynamic contributions from users a la
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk FAQ-O-Matic? (I don't think any really good software exists
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkThings That Need Fixing
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk=======================
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Rewriting of the remainder of the manual into xml is in
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk progress. See the bottom of this file for status info.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - add ids to non-directive sections of the module docs, so they
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk get a chance to be linked in the sidebar
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- Windows platform docs are in desperate need of rewrites/updates for 2.0.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Bill Rowe and Bill Stoddard are good contacts for tech questions.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - "using apache" has been done, "compiling apache" is still open
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- New Auth system
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Much clean-up and enhancement of aaa howto
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Independent note on how to upgrade to new auth system
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- modules docs
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - mod_suexec: very little documentation
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - mod_proxy: updates for 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - mod_status: updates for 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - mod_example: updates for 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Convert from nroff to our xml format. See list at bottom.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Then if someone gets creative, they can try to find an automatic
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk way to convert back to nroff.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - An example: http://cyberelk.net/tim/data/xmlto/db2man/
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk This is designed for docbook, but it could be adapted.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk I'm not sure what the license is.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- MPM documentation
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - explain what the following command line options do
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk (perhaps in the developer/debugging docs):
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk -D ONE_PROCESS
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk one-process-mode == no threads, i.e. only one
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk process handling the requests in a single loop?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk -D NO_DETACH (not in every MPM avail.)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk no daemon, but detached from terminal?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk -D FOREGROUND (not in every MPM avail.)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- Individual docs will need some cleanup.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - misc/custom_errordocs.html needs to be updated to
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk essentially describe how the international error
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk docs included in 2.0 work
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - misc/perf-tuning.html - needs major rewrite for 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - misc/tutorials.html - mostly not relevant to 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - misc/known_client_problems.html - mostly ancient
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - platform/ebcdic.xml - needs major rework for 2.0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- New build process.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - install.html has had a first-pass rewrite, it is basically
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk accurate, but very incomplete: many configure options are missing,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk especially those inherited from apr.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- API documentation
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Status: Ben Laurie has written some hooks documentation
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- Several features in Apache require write-access to the filesystem.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Examples: CacheRoot, DavLockDB, ScriptLog
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk We should treat the things consistently in the docs, and perhaps
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk suggest the use of directory like /usr/local/apache2/var/ that is
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk httpd-writable.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk- SSL docs are generally good, but they need a refreshing by someone
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk familiar with mod_ssl and openssl.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkDocumentation improvements
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk==========================
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* Enhancements to the DTD/XSL:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - <glossary> tag that links to the glossary and uses some special
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk style in the css.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - New index: directives by context, including listing which directives
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk are available for each AllowOverride setting.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - New index: backout modules by type (aaa, mappers, loggers etc.)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk probably by introducing a <category> element in modulesynopsis
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Use a tag like <var> in place of <em> for things like the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <syntax> listing.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - in progress
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - add letter links to glossary and quickreference,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk perhaps also a term overview (sidebar)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - cross references between the different languages,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk at least links from non-en docs to the originals.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - Javascript?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - post processing (s&r, XML::Parser, ...)?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - pre processing ([kind of] type maps
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk generated from sitemap entries like:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk <page><variant lang="en" href="">title</variant>)?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - looking for other good ideas ;-)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - remove <pre> elements. Use <br /> and <indent> elements to get
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk same effect.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - need to add new <parentdocument> element to more docs
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* Autogeneration of PDF
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* Windows help file
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - David Shane Holden was working on this
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* Improving the "security docs"
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - More content and better organisation.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - mod_dav ressources are owned by the httpd
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* General cleaning and improving of module docs
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* Making the directive definitions "less terse" (i.e., adding more
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk examples and details to the definitions of the directives)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk* Making site-specific enhancements easier, including a documented
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk and robust way for 3P module docco to be added -- and have it
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk survive a server docco upgrade
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk - This could be something a simple and hackish as a manual/extra/
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk directory (a la the 1.3 src/modules/extra/ directory) and a
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk script in the support directory that scans the files there and
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk updates the manual indices. (We do something like that now for
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk httpd.conf file with apxs [LoadModule, etc.].)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkXML Conversions
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk===============
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkThe following files need to be converted to XML as described at
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkhttp://httpd.apache.org/docs-project/docsformat.html
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkindex.html.en # leave in html?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkexpand.pl # delete after finishing everything
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk# These will require manual.xsl changes
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk# Perhaps these should be left in html to allow the developers to
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk# play with them
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk# converting from nroff to xml