STATUS revision ba5d7fee8dc1fca43c388024b0cebb7afd675052
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekApache HTTP Server 2.0 Documentation Status File.
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekLast modified: $Date: 2002/10/05 23:03:58 $
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekIf you are interested in helping accomplish some of the tasks on this
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozeklist or otherwise improving the documentation, please join the
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozekapache-docs mailing list by mailing to docs-subscribe@httpd.apache.org
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekFor more information on how to contribute to the Apache Documentation
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekProject, please see http://httpd.apache.org/docs-project/, and
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozekhttp://apache-server.com/tutorials/ATdocs-project.html for an excellent
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozektutorial on how to get started with making your contribution.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek ------------------------------
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekThings That Need Fixing
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek=======================
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Rewriting of the remainder of the manual into xml is in
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek progress. See the bottom of this file for status info.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - add ids to non-directive sections of the module docs, so they
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek get a chance to be linked in the sidebar
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina- Windows platform docs are in desperate need of rewrites/updates for 2.0.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Bill Rowe and Bill Stoddard are good contacts for tech questions.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek- New Auth system
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek (Wait on this until the code has stabalized a little)
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - With the new auth system, we have a bunch of directives that are
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek duplicated in multiple modules, where one of the modules is obsolete.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek We probably need to mark the old modules as <status>obsolete</status>
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina and key on that to omit them from the directive index, etc.
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina - Much clean-up and enhancement of docs
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina - Independent note on how to upgrade to new auth system
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina- Figure out what to do about the 2.0 FAQ
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina - Copy important stuff from 1.3?
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina - Some kind of XML?
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina - Something that allows dynamic contributions from users a la
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina FAQ-O-Matic? (I don't think any really good software exists
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina- modules docs
d387c4608dbd3ca056e18e85313ef51aac146fd2Pavel Březina - mod_suexec: very little documentation
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - mod_proxy: updates for 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - mod_status: updates for 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - mod_example: updates for 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Some of the man pages need to be updated for 2.0.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek Presently, these are generated from nroff man pages using
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek the program in the site-tools repository, but nobody seems
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek willing to update the nroff files at the moment.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek What should we do?
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - we should be able to setup an XSLT to convert XML to nroff,
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek shouldn't we? --nd
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Theoretically? Yes. ;-) --Joshua
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek- MPM documentation
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Non unix/windows MPMs still need to be completed.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - the perchild directives in threaded/worker need docs
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek- Individual docs will need some cleanup.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - misc/custom_errordocs.html needs to be updated to
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek essentially describe how the international error
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek docs included in 2.0 work
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - misc/perf-tuning.html - needs major rewrite for 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - misc/tutorials.html - mostly not relevant to 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - misc/known_client_problems.html - mostly ancient
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - platform/ebcdic.xml - needs major rework for 2.0
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek- New build process.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - install.html has had a first-pass rewrite, it is basically
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek accurate, but very incomplete.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek- API documentation
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek Status: Ben Laurie has written some hooks documentation
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek- Translations
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek There are several efforts underway to translate the documentation
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek into other languages. A detailed list of the currently known
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek translators (and the corresponding websites) can be found at
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek http://httpd.apache.org/docs-project/translations.html
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekDocumentation improvements
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek==========================
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* Enhancements to the DTD/XSL:
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - <glossary> tag that links to the glossary and uses some special
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek style in the css.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - <parentdocument href="...">...</parentdocument> tag to give some
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek more structure for the cookie-crumbs, etc.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - New index: directives by context, including listing which directives
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek are available for each AllowOverride setting.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Use a tag like <var> in place of <em> for things like the
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek <syntax> listing.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - nd volunteers
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - add letter links to glossary and quickreference,
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek perhaps also a term overview (sidebar)
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - cross references between the different languages,
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek at least links from non-en docs to the originals.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - Javascript?
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - post processing (s&r, XML::Parser, ...)?
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - pre processing ([kind of] type maps
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek generated from sitemap entries like:
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek <page><variant lang="en" href="">title</variant>)?
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - looking for other good ideas ;-)
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - remove <pre> elements. Use <br /> and <indent> elements to get
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek same effect.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* Autogeneration of PDF
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* Windows help file
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - David Shane Holden was working on this
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* Improving the "security docs"
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - More content and better organisation.
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* General cleaning and improving of module docs
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* Making the directive definitions "less terse" (i.e., adding more
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek examples and details to the definitions of the directives)
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - We'll need to audit these and find out which ones need munging, as
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek some of it looks ok. --jsl
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek* Making site-specific enhancements easier, including a documented
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek and robust way for 3P module docco to be added -- and have it
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek survive a server docco upgrade
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek - This could be something a simple and hackish as a manual/extra/
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek directory (a la the 1.3 src/modules/extra/ directory) and a
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek script in the support directory that scans the files there and
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek updates the manual indices. (We do something like that now for
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek httpd.conf file with apxs [LoadModule, etc.].)
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekXML Conversions
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek===============
590582be38cdbfde387fcc57df92903d48c5a083Jakub HrozekThe following files need to be converted to XML as described at
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozekhttp://httpd.apache.org/docs-project/docsformat.html
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozekindex.html.en # leave in html?
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozekexpand.pl # delete after finishing everything
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek# These will require manual.xsl changes
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek# Perhaps these should be left in html to allow the developers to
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek# play with them
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek# These are currently generated from nroff, but nobody is editting
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek# the nroff sources. Should we just convert to pure xml and forget
590582be38cdbfde387fcc57df92903d48c5a083Jakub Hrozek# about man pages?