STATUS revision db186f1b105b3ae3c1ffe8c03292c07aef9f1d0d
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyApache HTTP Server 2.0 Documentation Status File.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyLast modified: $Date: 2002/09/16 23:41:12 $
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyIf you are interested in helping accomplish some of the tasks on this
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeylist or otherwise improving the documentation, please join the
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyapache-docs mailing list by mailing to docs-subscribe@httpd.apache.org
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyFor more information on how to contribute to the Apache Documentation
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyProject, please see http://httpd.apache.org/docs-project/, and
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyhttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytutorial on how to get started with making your contribution.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ------------------------------
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyThings That Need Fixing
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey=======================
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Rewriting of the remainder of the manual into xml is in
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey progress. See the bottom of this file for status info.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Get mod/mod_auth_ldap.xml to validate against the current dtd.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Some of the nested <dl>s in mod/mod_include.xml are not working
4a44f0a129f99893a7aef6325037c5e1fa702a0fAnurag S. Maskey in mozilla. Probably enclosing some of the bare paragraphs
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey in <p> would fix it.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - add ids to non-directive sections of the module docs, so they
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey get a chance to be linked in the sidebar
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- Windows platform docs are in desperate need of rewrites/updates for 2.0.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Bill Rowe and Bill Stoddard are good contacts for tech questions.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- New Auth system
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - With the new auth system, we have a bunch of directives that are
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey duplicated in multiple modules, where one of the modules is obsolete.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey We probably need to mark the old modules as <status>obsolete</status>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey and key on that to omit them from the directive index, etc.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Much clean-up and enhancement of docs
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Independent note on how to upgrade to new auth system
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- Figure out what to do about the 2.0 FAQ
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Copy important stuff from 1.3?
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Some kind of XML?
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Something that allows dynamic contributions from users a la
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey FAQ-O-Matic? (I don't think any really good software exists
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- modules docs
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - mod_suexec: very little documentation
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - mod_proxy: updates for 2.0
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - mod_status: updates for 2.0
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - mod_example: updates for 2.0
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Some of the man pages need to be updated for 2.0.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey Presently, these are generated from nroff man pages using
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey the program in the site-tools repository, but nobody seems
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey willing to update the nroff files at the moment.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey What should we do?
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - we should be able to setup an XSLT to convert XML to nroff,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey shouldn't we? --nd
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Theoretically? Yes. ;-) --Joshua
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- MPM documentation
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Non unix/windows MPMs still need to be completed.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - the perchild directives in threaded/worker need docs
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- Individual docs will need some cleanup.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - misc/custom_errordocs.html needs to be updated to
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey essentially describe how the international error
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey docs included in 2.0 work
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - misc/perf-tuning.html - needs major rewrite for 2.0
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - misc/tutorials.html - mostly not relevant to 2.0
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - misc/known_client_problems.html - mostly ancient
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- New build process.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - install.html has had a first-pass rewrite, it is basically
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey accurate, but very incomplete.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- API documentation
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey Status: Ben Laurie has written some hooks documentation
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey- Translations
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey There are several efforts underway to translate the documentation
03e9aa6d0661fbdf89669b14e801767d7e504fe8Renee Danson Sommerfeld into other languages. A detailed list of the currently known
03e9aa6d0661fbdf89669b14e801767d7e504fe8Renee Danson Sommerfeld translators (and the corresponding websites) can be found at
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey http://httpd.apache.org/docs-project/translations.html
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyDocumentation improvements
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey==========================
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* Enhancements to the DTD/XSL:
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - <glossary> tag that links to the glossary and uses some special
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey style in the css.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - <parentdocument href="...">...</parentdocument> tag to give some
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey more structure for the cookie-crumbs, etc.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - New index: directives by context, including listing which directives
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey are available for each AllowOverride setting.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Add a quickreference.html that contains summary info on each
03e9aa6d0661fbdf89669b14e801767d7e504fe8Renee Danson Sommerfeld - Joshua is working on this
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Use a tag like <var> in place of <em> for things like the
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey <syntax> listing.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - nd volunteers
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Use the sitemap.xml in place of allmodules.xml to generate the
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - Handle more levels of sub<section>s.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - add letter links to glossary, perhaps also a term overview (sidebar)
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* Autogeneration of PDF
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* Windows help file
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - David Shane Holden was working on this
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* Improving the "security docs"
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - More content and better organisation.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* General cleaning and improving of module docs
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* Making the directive definitions "less terse" (i.e., adding more
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey examples and details to the definitions of the directives)
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - We'll need to audit these and find out which ones need munging, as
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey some of it looks ok. --jsl
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey* Making site-specific enhancements easier, including a documented
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey and robust way for 3P module docco to be added -- and have it
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey survive a server docco upgrade
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey - This could be something a simple and hackish as a manual/extra/
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey directory (a la the 1.3 src/modules/extra/ directory) and a
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey script in the support directory that scans the files there and
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey updates the manual indices. (We do something like that now for
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey httpd.conf file with apxs [LoadModule, etc.].)
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyXML Conversions
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey===============
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. MaskeyThe following files need to be converted to XML as described at
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyhttp://httpd.apache.org/docs-project/docsformat.html
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyebcdic.html # Perhaps move to platform/
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyssl/ssl_glossary.html # delete. replaced by ../glossary.html
03e9aa6d0661fbdf89669b14e801767d7e504fe8Renee Danson Sommerfeldexpand.pl # delete after finishing everything
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey# These will require manual.xsl changes
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey# Perhaps these should be left in html to allow the developers to
03e9aa6d0661fbdf89669b14e801767d7e504fe8Renee Danson Sommerfeld# play with them
03e9aa6d0661fbdf89669b14e801767d7e504fe8Renee Danson Sommerfeld# These are currently generated from nroff, but nobody is editting
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey# the nroff sources. Should we just convert to pure xml and forget
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey# about man pages?