granicus.if.org Git - apache/blob - docs/STATUS

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