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

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