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

   1 Apache HTTP Server 2.1 Documentation Status File.
   2 Last modified: $Date: 2003/10/31 08:05:42 $
   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 - Remove manual/search/manual-index.cgi from the distribution and
  13   httpd-2.0-docs/ repository?  These can be maintained in the httpd-site
  14   repository but don't belong in distributions unless we introduce the
  15   tools to generate the index database or keep a current database checked
  16   into cvs.
  17   +1: wrowe, nd, slive, erikabele, kess, mads
  18
  19 - Remove several out-of-place files into somewhere in the tree outside
  20   of the actual web site content?  Erik suggests we merge the two icons
  21   readmes into one.  Perhaps all of these go into httpd-2.0/docs/README?
  22     error/readme
  23     icons/readme
  24     icons/small/readme.txt
  25   Votes for a single top-level README reference?
  26   +1: wrowe, slive, nd, erikabele, kess, mads
  27
  28
  29 Things That Need Fixing
  30 =======================
  31
  32 - Windows platform docs are in desperate need of rewrites/updates for 2.0.
  33     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  34     - "using apache" has been done, "compiling apache" is still open
  35     - hints on uninstalling apache (exit monitor, close directories,
  36       registry entries etc) (PR 10154)
  37     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  38     - FAQ: AcceptEx failed / virusscanner, firewall fun
  39
  40 - New Auth system
  41     - Much clean-up and enhancement of aaa howto
  42     - Independent note on how to upgrade to new auth system
  43
  44 - modules docs
  45     - mod_suexec: very little documentation
  46     - mod_proxy: updates for 2.0
  47     - mod_status: updates for 2.0
  48     - mod_example: updates for 2.0
  49     - mod_rewrite: explain, when which variables are actually available
  50       (PR 16402)
  51
  52 - MPM documentation
  53      - explain what the following command line options do
  54        (perhaps in the developer/debugging docs):
  55         -D DEBUG
  56         -D ONE_PROCESS
  57               one-process-mode == no threads, i.e. only one
  58               process handling the requests in a single loop?
  59         -D NO_DETACH (not in every MPM avail.)
  60               no daemon, but detached from terminal?
  61         -D FOREGROUND (not in every MPM avail.)
  62               ?
  63
  64 - Individual docs will need some cleanup.
  65      - misc/custom_errordocs.html needs to be updated to
  66        essentially describe how the international error
  67        docs included in 2.0 work
  68      - misc/perf-tuning.html - needs major rewrite for 2.0
  69      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
  70      - platform/ebcdic.xml - needs major rework for 2.0
  71
  72 - New build process.
  73     - install.html has had a first-pass rewrite, it is basically
  74       accurate, but very incomplete: many configure options are missing,
  75       especially those inherited from apr.
  76
  77 - API documentation
  78     - Ben Laurie has written some hooks documentation
  79     - authn provider API documentation could be useful
  80
  81 - SSL docs are generally good, but they need a refreshing by someone
  82   familiar with mod_ssl and openssl.
  83
  84   - I've begun working on this (again) --mads
  85
  86 - How does <Proxy> fit into sections.html?
  87
  88 Documentation improvements
  89 ==========================
  90
  91 * Missing documentation for the support programs htdbm and checkgid
  92
  93 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
  94
  95 * Enhancements to the DTD/XSL:
  96   - <glossary> tag that links to the glossary and uses some special
  97     style in the css.
  98   - New index: directives by context, including listing which directives
  99     are available for each AllowOverride setting.
 100   - New index: backout modules by type (aaa, mappers, loggers etc.)
 101     probably by introducing a <category> element in modulesynopsis
 102   - Use a tag like <var> in place of <em> for things like the
 103     <syntax> listing.
 104     - in progress
 105   - add letter links to glossary and quickreference,
 106     perhaps also a term overview (sidebar)
 107   - remove <pre> elements. Use <br /> and <indent> elements to get
 108     a similar effect.
 109
 110 * Improving the documentation of the documentations' build system
 111   itself (requirements, procedures)
 112
 113 * Improving the "security docs"
 114   - More content and better organisation
 115   - mod_dav ressources are owned by the httpd
 116
 117 * General cleaning and improving of module docs
 118
 119 * Making the directive definitions "less terse" (i.e., adding more
 120   examples and details to the definitions of the directives)
 121
 122 * Making site-specific enhancements easier, including a documented
 123   and robust way for 3P module docco to be added -- and have it
 124   survive a server docco upgrade
 125
 126   - This could be something a simple and hackish as a manual/extra/
 127     directory (a la the 1.3 src/modules/extra/ directory) and a
 128     script in the support directory that scans the files there and
 129     updates the manual indices.  (We do something like that now for
 130     httpd.conf file with apxs [LoadModule, etc.].)
 131
 132 * Summarize all the implemented drafts/standards with short explanations
 133   within a document. (PR 16938)
 134
 135   - I've begun working on this --jsl
 136
 137 * Provide example solutions for the mapping of encodings, especially
 138   for .gz etc. (also in regard to our default configuration)
 139
 140 * Several features in Apache require write-access to the filesystem.
 141     Examples: CacheRoot, DavLockDB, ScriptLog
 142     We should treat the things consistently in the docs, and perhaps
 143     suggest the use of directory like /usr/local/apache2/var/ that is
 144     httpd-writable.
 145
 146 * Change the name 'Apache' to 'Apache HTTP Server' or 'http'.
 147
 148 LaTeX Todo list
 149 ==================
 150
 151 - Tables
 152   Add <columnspec> to xml files.
 153
 154 - Images
 155
 156   A quick search makes me believe that pdftex will not handle gifs.
 157   It probably will handle png.
 158
 159 - Hundreds of other little problems with presentation, cross-referencing,
 160   etc.
 161
 162 - Fix build system
 163
 164 - Cleanup xsl to make it more readable and add licenses.  Almost everything
 165   that is currently in latex.xsl should probably be moved to common.xsl.
 166   There may be a license problem with the atbeginend.sty file, since
 167   latex style files rarely have explict licenses.  At worst, we can
 168   drop this and manually adjust the relevant spacing.
 169
 170 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 171
 172 - Speed up the XSLT tranform.
 173
 174 - Translations.