1 Apache HTTP Server 2.1 Documentation Status File.
2 Last modified: $Date: 2003/04/09 20:47:33 $
4 For more information on how to contribute to the Apache Documentation
5 Project, please see http://httpd.apache.org/docs-project/
7 ------------------------------
12 -Comment out .gz etc. AddEncoding lines in our default configuration.
13 docs/conf/httpd-std.conf.in rev 1.32
14 jerenkranz: Current browsers have a tendency to decompress the data
15 when no one really wants it to do that. If you want the
16 2.0 behavior that leads to transparent decompression
17 by modern browsers, uncomment these lines. But, this
18 shouldn't be our default, and certainly wasn't in 1.3.
22 - Where to put docs checkout on website
23 - Leave it at /docs-x.y/
24 +1: slive, Erik, Kess, Mads
34 though it's probably my suggestion, I don't like it
37 - Figure out what to do about the 2.0 FAQ
38 - Copy important stuff from 1.3?
40 - Something that allows dynamic contributions from users a la
41 FAQ-O-Matic? (I don't think any really good software exists
43 - Perhaps we can use the newly created Wiki for this. (SubWiki,
44 with the possibility to get nice commit mails.)
45 nd: someone should try to convince me, what the heck is
46 so cool with wikis -- nd
47 erik: it lowers the entry barrier and therefore users are able to
48 contribute (handy for a FAQ, see PHP site)
49 nd: yes, good bad example. The PHP docs would mostly be
50 better without these comments. I don't want to censor
51 the entries, but also don't want to leave them without
52 control. IMHO it's better to incorporate changes into the
53 static docs. We need some better way of feedback, anyway.
55 Things That Need Fixing
56 =======================
59 - Rewriting of the remainder of the manual into xml is in
60 progress. See the bottom of this file for status info.
61 - add ids to non-directive sections of the module docs, so they
62 get a chance to be linked in the sidebar
64 - Windows platform docs are in desperate need of rewrites/updates for 2.0.
65 - Bill Rowe and Bill Stoddard are good contacts for tech questions.
66 - "using apache" has been done, "compiling apache" is still open
67 - hints on uninstalling apache (exit monitor, close directories,
68 registry entries etc) (PR 10154)
69 - FAQ! UTF-8 config and URL encoding for non-ascii characters.
72 - Much clean-up and enhancement of aaa howto
73 - Independent note on how to upgrade to new auth system
76 - mod_suexec: very little documentation
77 - mod_proxy: updates for 2.0
78 - mod_status: updates for 2.0
79 - mod_example: updates for 2.0
80 - mod_rewrite: explain, when what variables are actually available
84 - Convert from nroff to our xml format. See list at bottom.
85 - Then if someone gets creative, they can try to find an automatic
86 way to convert back to nroff.
87 - An example: http://cyberelk.net/tim/data/xmlto/db2man/
88 This is designed for docbook, but it could be adapted.
89 I'm not sure what the license is.
92 - explain what the following command line options do
93 (perhaps in the developer/debugging docs):
96 one-process-mode == no threads, i.e. only one
97 process handling the requests in a single loop?
98 -D NO_DETACH (not in every MPM avail.)
99 no daemon, but detached from terminal?
100 -D FOREGROUND (not in every MPM avail.)
103 - Individual docs will need some cleanup.
104 - misc/custom_errordocs.html needs to be updated to
105 essentially describe how the international error
106 docs included in 2.0 work
107 - misc/perf-tuning.html - needs major rewrite for 2.0
108 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
109 - platform/ebcdic.xml - needs major rework for 2.0
112 - install.html has had a first-pass rewrite, it is basically
113 accurate, but very incomplete: many configure options are missing,
114 especially those inherited from apr.
117 - Ben Laurie has written some hooks documentation
118 - authn provider API documentation could be useful
120 - Several features in Apache require write-access to the filesystem.
121 Examples: CacheRoot, DavLockDB, ScriptLog
122 We should treat the things consistently in the docs, and perhaps
123 suggest the use of directory like /usr/local/apache2/var/ that is
126 - SSL docs are generally good, but they need a refreshing by someone
127 familiar with mod_ssl and openssl.
129 Documentation improvements
130 ==========================
132 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
134 * Enhancements to the DTD/XSL:
135 - <glossary> tag that links to the glossary and uses some special
137 - New index: directives by context, including listing which directives
138 are available for each AllowOverride setting.
139 - New index: backout modules by type (aaa, mappers, loggers etc.)
140 probably by introducing a <category> element in modulesynopsis
141 - Use a tag like <var> in place of <em> for things like the
144 - add letter links to glossary and quickreference,
145 perhaps also a term overview (sidebar)
146 - cross references between the different languages,
147 at least links from non-en docs to the originals.
149 - post processing (s&r, XML::Parser, ...)?
150 - pre processing ([kind of] type maps
151 generated from sitemap entries like:
152 <page><variant lang="en" href="">title</variant>)?
153 - looking for other good ideas ;-)
154 - remove <pre> elements. Use <br /> and <indent> elements to get
157 * Autogeneration of PDF
158 - André is working on this, Erik volunteers to help out
161 - David Shane Holden was working on this
163 * Improving the "security docs"
164 - More content and better organisation.
165 - mod_dav ressources are owned by the httpd
167 * General cleaning and improving of module docs
169 * Making the directive definitions "less terse" (i.e., adding more
170 examples and details to the definitions of the directives)
172 * Making site-specific enhancements easier, including a documented
173 and robust way for 3P module docco to be added -- and have it
174 survive a server docco upgrade
176 - This could be something a simple and hackish as a manual/extra/
177 directory (a la the 1.3 src/modules/extra/ directory) and a
178 script in the support directory that scans the files there and
179 updates the manual indices. (We do something like that now for
180 httpd.conf file with apxs [LoadModule, etc.].)
182 * Summarize all the implemented drafts/standards with short explanations
183 within a document. (PR 16938)
188 The following files need to be converted to XML as described at
189 http://httpd.apache.org/docs-project/docsformat.html
191 expand.pl # delete after finishing everything
193 # These will require manual.xsl changes
199 # Perhaps these should be left in html to allow the developers to
201 # nope. in order to create other formats, we need 'em as xml. --nd
204 # converting from nroff to xml
207 programs/dbmmanage.html
210 programs/htdigest.html
211 programs/htpasswd.html
213 programs/logresolve.html
215 programs/rotatelogs.html