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

   1 Apache HTTP Server 2.1 Documentation Status File.
   2 Last modified: $Date$
   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 Things That Need Fixing
  13 =======================
  14
  15 - Windows platform docs are in desperate need of rewrites/updates for 2.x.
  16     - Bill Rowe and Bill Stoddard are good contacts for tech questions.
  17     - "using apache" has been done, "compiling apache" is still open
  18     - hints on uninstalling apache (exit monitor, close directories,
  19       registry entries etc) (PR 10154)
  20     - FAQ: UTF-8 config and URL encoding for non-ascii characters.
  21
  22 - New Auth system
  23     - Much clean-up and enhancement of aaa howto
  24     - Independent note on how to upgrade to new auth system
  25
  26 - modules docs
  27     - mod_suexec: very little documentation
  28     - mod_rewrite: explain, when which variables are actually available
  29       (PR 16402)
  30
  31 - MPM documentation
  32      - explain what the following command line options do
  33        (perhaps in the developer/debugging docs):
  34         -D DEBUG
  35         -D ONE_PROCESS
  36               one-process-mode == no threads, i.e. only one
  37               process handling the requests in a single loop?
  38
  39 - Individual docs will need some cleanup.
  40      - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
  41      - platform/ebcdic.xml - needs major rework for 2.0
  42
  43 - API documentation
  44     - Ben Laurie has written some hooks documentation
  45     - authn provider API documentation could be useful
  46
  47 - SSL docs need serious update and enhancement
  48     - compat docs are wrong
  49     - no basic how to setup ssl doc
  50     mads said he was working on this, but...
  51
  52 - How does <Proxy> fit into sections.html?
  53
  54 Documentation improvements
  55 ==========================
  56
  57 * Missing documentation for the support program checkgid
  58
  59 * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
  60   (draft available in wiki)
  61
  62 * Enhancements to the DTD/XSL:
  63   - New index: directives by context, including listing which directives
  64     are available for each AllowOverride setting.
  65   - New index: backout modules by type (aaa, mappers, loggers etc.)
  66     probably by introducing a <category> element in modulesynopsis
  67   - Use a tag like <var> in place of <em> for things like the
  68     <syntax> listing.
  69     - in progress
  70   - add letter links to glossary and quickreference,
  71     perhaps also a term overview (sidebar)
  72   - remove <pre> elements. Use <br /> and <indent> elements to get
  73     a similar effect.
  74
  75 * Improving the documentation of the documentations' build system
  76   itself (requirements, procedures)
  77
  78 * Improving the "security docs"
  79   - More content and better organisation
  80   - mod_dav ressources are owned by the httpd
  81
  82 * Provide example solutions for the mapping of encodings, especially
  83   for .gz etc. (also in regard to our default configuration)
  84
  85 * Change the name 'Apache' to 'Apache HTTP Server' or 'http'.
  86
  87 LaTeX Todo list
  88 ==================
  89
  90 - Dozens of other little problems with presentation, cross-referencing,
  91   etc.
  92
  93 - Cleanup xsl to make it more readable.  Almost everything
  94   that is currently in latex.xsl should probably be moved to common.xsl.
  95   There may be a license problem with the atbeginend.sty file, since
  96   latex style files rarely have explict licenses.  At worst, we can
  97   drop this and manually adjust the relevant spacing.
  98
  99 - Reduce the size of the pdf (both bytes and pages) in any way possible.
 100
 101 - Translations.