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

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