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

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