STATUS revision 1cbf9d079817c2891a506006a9664be9685dc42e
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffApache HTTP Server 2.0 Documentation Status File.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffLast modified: $Date: 2002/09/06 19:07:36 $
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffIf you are interested in helping accomplish some of the tasks on this
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcdufflist or otherwise improving the documentation, please join the
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffapache-docs mailing list by mailing to apache-docs-subscribe@apache.org
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffFor more information on how to contribute to the Apache Documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffProject, please see http://httpd.apache.org/docs-project/, and
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffhttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcdufftutorial on how to get started with making your contribution.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff ------------------------------
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - The xsl transformations could be greatly improved to a) look better
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff and b) use proper CSS+html rather than the horrible hack that
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff Joshua did (in progress).
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - Rewriting of the remainder of the manual into xml is in
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff progress. See the bottom of this file for status info.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff- modules docs
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - mod_suexec: very little documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - mod_proxy: updates for 2.0
eb9158dea141f092a53bcc111a8e965b42fa9502jvergara - mod_status: updates for 2.0
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - mod_example: updates for 2.0
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - Some of the man pages need to be updated for 2.0. At least
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff the httpd man page appears to be outdated, and perhaps other.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff After this is done, the manual/programs/ versions can be
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff regenerated using the program in the site-tools repository.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff- MPM documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - Each MPM needs to have a documentation file in manual/mod/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff which lists the directives it provides, and some details
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff about its operation.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff Status: Initial outlines done. Much more details need to be
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - Non unix/windows MPMs still need to be completed.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - the perchild directives in threaded/worker need docs
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - Individual docs will need some cleanup.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff Status: What docs still need to be touched here?
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - misc/custom_errordocs.html needs to be updated to
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff essentially describe how the international error
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff docs included in 2.0 work
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - misc/perf-tuning.html - needs major rewrite for 2.0
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - misc/tutorials.html - mostly not relevant to 2.0
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - misc/known_client_problems.html - mostly ancient
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff- New build process.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - install.html has had a first-pass rewrite, but many things have
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff changed in the build system since it was written.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff- Documentation of new features.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - This will probably require more input from new-httpd, since
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff not many people here follow the development process close
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff enough to know what is going on.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff- API documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff Status: Ben Laurie has written some hooks documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff- Translations
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff There are several efforts underway to translate the documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff into other languages. A detailed list of the currently known
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff translators (and the corresponding websites) can be found at
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff http://httpd.apache.org/docs-project/translations.html
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffNew User documentation
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff======================
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff* Directory Handling (mod_dir/mod_autoindex/etc)
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffDocumentation improvements
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff==========================
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff* Improving the "security docs"
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - More content and better organisation.
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff* General cleaning and improving of module docs
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff* Making the directive definitions "less terse" (i.e., adding more
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff examples and details to the definitions of the directives)
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - We'll need to audit these and find out which ones need munging, as
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff some of it looks ok. --jsl
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff* Making site-specific enhancements easier, including a documented
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff and robust way for 3P module docco to be added -- and have it
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff survive a server docco upgrade
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff - This could be something a simple and hackish as a manual/extra/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff directory (a la the 1.3 src/modules/extra/ directory) and a
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff script in the support directory that scans the files there and
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff updates the manual indices. (We do something like that now for
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff httpd.conf file with apxs [LoadModule, etc.].)
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff* regex: We should at least document someplace what regex library we
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff are using and how to find more information about it
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffXML Conversions
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff===============
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffThe following files need to be converted to XML as described at
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffebcdic.html # Perhaps move to platform/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcdufffooter.html # delete after finishing manual/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffheader.html # delete after finishing manual/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffindex.html.en # leave in html?
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffhowto/footer.html # delete after finishing howto/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffhowto/header.html # delete after finishing howto/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffmisc/footer.html # delete after finishing misc/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffmisc/header.html # delete after finishing misc/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffmod/footer.html # delete after finishing mod/ directory
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffmod/header.html # delete after finishing mod/ directory
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffplatform/footer.html # delete after finishing platform/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffplatform/header.html # delete after finishing platform/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffssl/footer.html # delete after finishing ssl/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffssl/header.html # delete after finishing ssl/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffssl/ssl_glossary.html # delete. replaced by ../glossary.html
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffvhosts/footer.html # delete after finishing vhosts/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffvhosts/header.html # delete after finishing vhosts/
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduffexpand.pl # delete after finishing everything
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff# These will require manual.xsl changes
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff# Perhaps these should be left in html to allow the developers to
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff# play with them
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff# These are currently generated from nroff, but nobody is editting
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff# the nroff sources. Should we just convert to pure xml and forget
d25372dc8e65a9ed019a88fdf659ca61313f1b31jcduff# about man pages?