STATUS revision 5aaaff4f4eb36456ebf766bccdd1f3b611034f90
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncApache HTTP Server 2.0 Documentation Status File.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncLast modified: $Date: 2002/11/21 17:55:51 $
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncIf you are interested in helping accomplish some of the tasks on this
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsynclist or otherwise improving the documentation, please join the
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncapache-docs mailing list by mailing to docs-subscribe@httpd.apache.org
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncFor more information on how to contribute to the Apache Documentation
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsyncProject, please see http://httpd.apache.org/docs-project/, and
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsynchttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsynctutorial on how to get started with making your contribution.
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsync ------------------------------
82bcaaf8077ba892f39afb721dca149353c63d2cvboxsyncThings That Need Fixing
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync=======================
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Rewriting of the remainder of the manual into xml is in
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync progress. See the bottom of this file for status info.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - add ids to non-directive sections of the module docs, so they
43747b1f0bc8302a238fb35e55857a5e9aa1933dvboxsync get a chance to be linked in the sidebar
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- Windows platform docs are in desperate need of rewrites/updates for 2.0.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Bill Rowe and Bill Stoddard are good contacts for tech questions.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- New Auth system
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync (Wait on this until the code has stabalized a little)
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - With the new auth system, we have a bunch of directives that are
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync duplicated in multiple modules, where one of the modules is obsolete.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync We probably need to mark the old modules as <status>obsolete</status>
f5e53763b0a581b0299e98028c6c52192eb06785vboxsync and key on that to omit them from the directive index, etc.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Much clean-up and enhancement of docs
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Independent note on how to upgrade to new auth system
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- Figure out what to do about the 2.0 FAQ
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Copy important stuff from 1.3?
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Some kind of XML?
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Something that allows dynamic contributions from users a la
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync FAQ-O-Matic? (I don't think any really good software exists
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- modules docs
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - mod_suexec: very little documentation
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - mod_proxy: updates for 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - mod_status: updates for 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - mod_example: updates for 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Convert from nroff to our xml format. See list at bottom.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Then if someone gets creative, they can try to find an automatic
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync way to convert back to nroff.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - An example: http://cyberelk.net/tim/data/xmlto/db2man/
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync This is designed for docbook, but it could be adapted.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync I'm not sure what the license is.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- MPM documentation
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Non unix/windows MPMs still need to be completed.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - the perchild directives in threaded/worker need docs
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- Individual docs will need some cleanup.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - misc/custom_errordocs.html needs to be updated to
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync essentially describe how the international error
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync docs included in 2.0 work
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - misc/perf-tuning.html - needs major rewrite for 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - misc/tutorials.html - mostly not relevant to 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - misc/known_client_problems.html - mostly ancient
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - platform/ebcdic.xml - needs major rework for 2.0
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- New build process.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - install.html has had a first-pass rewrite, it is basically
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync accurate, but very incomplete.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- API documentation
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync Status: Ben Laurie has written some hooks documentation
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- Several features in Apache require write-access to the filesystem.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync Examples: CacheRoot, DavLockDB, ScriptLog
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync We should treat the things consistently in the docs, and perhaps
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync suggest the use of directory like /usr/local/apache2/var/ that is
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync httpd-writable.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync- Translations
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync There are several efforts underway to translate the documentation
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync into other languages. A detailed list of the currently known
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync translators (and the corresponding websites) can be found at
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync http://httpd.apache.org/docs-project/translations.html
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncDocumentation improvements
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync==========================
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* Enhancements to the DTD/XSL:
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - <glossary> tag that links to the glossary and uses some special
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync style in the css.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - New index: directives by context, including listing which directives
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync are available for each AllowOverride setting.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Use a tag like <var> in place of <em> for things like the
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync <syntax> listing.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - nd volunteers
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - add letter links to glossary and quickreference,
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync perhaps also a term overview (sidebar)
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - cross references between the different languages,
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync at least links from non-en docs to the originals.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - Javascript?
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - post processing (s&r, XML::Parser, ...)?
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - pre processing ([kind of] type maps
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync generated from sitemap entries like:
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync <page><variant lang="en" href="">title</variant>)?
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - looking for other good ideas ;-)
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - remove <pre> elements. Use <br /> and <indent> elements to get
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync same effect.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - need to add new <parentdocument> element to more docs
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* Autogeneration of PDF
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* Windows help file
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - David Shane Holden was working on this
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* Improving the "security docs"
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - More content and better organisation.
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* General cleaning and improving of module docs
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* Making the directive definitions "less terse" (i.e., adding more
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync examples and details to the definitions of the directives)
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync - We'll need to audit these and find out which ones need munging, as
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync some of it looks ok. --jsl
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync* Making site-specific enhancements easier, including a documented
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync and robust way for 3P module docco to be added -- and have it
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync survive a server docco upgrade
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync - This could be something a simple and hackish as a manual/extra/
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync directory (a la the 1.3 src/modules/extra/ directory) and a
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync script in the support directory that scans the files there and
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync updates the manual indices. (We do something like that now for
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync httpd.conf file with apxs [LoadModule, etc.].)
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncXML Conversions
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync===============
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncThe following files need to be converted to XML as described at
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsynchttp://httpd.apache.org/docs-project/docsformat.html
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncindex.html.en # leave in html?
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsyncexpand.pl # delete after finishing everything
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync# These will require manual.xsl changes
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync# Perhaps these should be left in html to allow the developers to
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync# play with them
82dbd9ef3e383af63ce3e6ac225143182711adffvboxsync# converting from nroff to xml