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