You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Rodent of Unusual Size <Ke...@Golux.Com> on 2001/09/20 05:45:22 UTC

[STATUS] (httpd-docs-2.0) Wed Sep 19 23:45:22 EDT 2001

Apache HTTP Server 2.0 Documentation Status File.
Last modified: $Date: 2001/09/17 18:32:45 $

If you are interested in helping accomplish some of the tasks on this
list or otherwise improving the documentation, please join the
apache-docs mailing list by mailing to 
apache-docs-subscribe@apache.org

For more information on how to contribute to the Apache Documentation
Project, please see http://httpd.apache.org/docs-project/, and
http://apache-server.com/tutorials/ATdocs-project.html for an excellent
tutorial on how to get started with making your contribution.

              ------------------------------

- modules docs
    - mod_ssl/mod_tls: no docs
    - mod_suexec: very little documentation
    - mod_status: updates for 2.0
    - mod_example: updates for 2.0


- man pages
    - Some of the man pages need to be updated for 2.0.  At least
      the httpd man page appears to be outdated, and perhaps other.
      After this is done, the manual/programs/ versions can be
      regenerated.

- XHTML conversion
        Status: unknown

- MPM documentation
   - Each MPM needs to have a documentation file in manual/mod/
     which lists the directives it provides, and some details
     about its operation.
        Status: Initial outlines done.  Much more details need to be
          filled in.
          - Non unix/windows MPMs still need to be completed.
          - worker has no docs
          - the perchild directives in threaded/worker need docs

   - Individual docs will need some cleanup. 
        Status:  What docs still need to be touched here?
                 - invoking.html has had a first-pass cleaning done.
                 - misc/perf-tuning.html - needs major rewrite for 2.0
                 - misc/tutorials.html - mostly not relevant to 2.0
                 - misc/stopping.html
                 - dso.html
                 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
                 - misc/known_client_problems.html - mostly ancient

- New build process.
    - install.html has had a first-pass rewrite, but needs more
      work to be complete, and needs to track changes/bug-fixes
      in the build system.

- Documentation of new features.
   - This will probably require more input from new-httpd, since
     not many people here follow the development process close
     enough to know what is going on.

- API documentation
    Status: Ben Laurie has written some hooks documentation

- Translations
    We appear to have people working on translation into the following
    languages.  These may just be the 'it worked' page, but if so
    the authors of those should perhaps be contacted to help do the
    rest.. :-)  Note that this list is NOT identical to that for the
    1.3 documentation project..!

  [Should we attempt to get a known-current authorlist together? --jsl]

    - Catalan (.ca)
    - Czech Republic (.cz)
    - German (.de)
    - Danish (.dk)
    - Estonia (.ee)
    - Greek (.el)
    - Spanish (.es)
    - Estonian (.et)
    - French (.fr)
    - Hebrew (.he.iso8859-8)
    - Italian (.it)
    - Japanese (.ja.iso2022-jp, .ja.jis)
    - Korean (.kr.iso2022-kr, .kt.iso-kr)
    - ? (.ltz)
    - ? (.lu)
    - Dutch (.nl)
    - Norwegian (.no)
    - Polish (.po.iso-pl)
    - Portuguese (.pt)
    - Portuguese [Brasilian] (.pt-br)
    - Russian (.ru.cp-1251, .ru.cp866, .ru.iso-ru, .ru.koi8-r, .ru.ucs[248])
    - Swedish (.se)
    - Twi (.tw, .tw.big5)
      (is that supposed to be Chinese/Taiwanese?  Because if so, it is using
      the code reserved for Twi..)
    [Need this clarified --jsl]



Things to be done in both the 1.3 and 2.0 trees
===============================================


Tutorials
=========

* Tutorial on user authentication with Apache.  Rich Bowen has contributed
  his tutorial from ApacheToday, but it needs to be cleaned up and put in
  a good format for the docs.

New User documentation
======================

* Directory Handling (mod_dir/mod_autoindex/etc)

* Sections (<Directory>/<Files>/<Location>)


Documentation improvements
==========================

* Improving the "security docs"

  - More content and better organisation.

* General cleaning and improving of module docs

* Making the directive definitions "less terse" (i.e., adding more
  examples and details to the definitions of the directives)

  - We'll need to audit these and find out which ones need munging, as
    some of it looks ok.  --jsl

* Making site-specific enhancements easier, including a documented
  and robust way for 3P module docco to be added -- and have it
  survive a server docco upgrade

  - This could be something a simple and hackish as a manual/extra/
    directory (a la the 1.3 src/modules/extra/ directory) and a
    script in the support directory that scans the files there and
    updates the manual indices.  (We do something like that now for
    httpd.conf file with apxs [LoadModule, etc.].)

---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: [STATUS] (httpd-docs-2.0) Wed Sep 19 23:45:22 EDT 2001

Posted by Rich Bowen <rb...@rcbowen.com>.
On Fri, 21 Sep 2001, Rich Bowen wrote:

> On Fri, 21 Sep 2001, William A. Rowe, Jr. wrote:
>
> > From: "Rich Bowen" <rb...@rcbowen.com>
> > Sent: Friday, September 21, 2001 6:05 AM
> >
> >
> > > On Wed, 19 Sep 2001, Rodent of Unusual Size wrote:
> > >
> > > > - XHTML conversion
> > > >         Status: unknown
> > >
> > > I was wondering about this. A few weeks ago I submitted some mod docs
> > > that had been xhtml-ized via w3c tidy. Did anyone have any complaints
> > > with those? If not, I can xhtml-ize the entire documentation tree in
> > > about a minute.
> >
> > +1, just do it.  Give everyone fair warning (say Saturday evening/US
> > afternoon/EU) so they can get work-in-progress committed.  After such
> > changes, it's very hard to fix version conflicts.
> >
> > We get several bonuses, not the least of which is finally folding all
> > tags to lower case, which is better for character and token-based
> > compression, and more consistent docs are easier to maintain.
>
> ok, WARNING, I will be doing this Saturday afternoon, during my
> daughter's nap.

Completed. See my other note. Thanks.

-- 
Rich Bowen - rbowen@rcbowen.com
Author - Apache Server Unleashed - http://www.apacheunleashed.com/


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: [STATUS] (httpd-docs-2.0) Wed Sep 19 23:45:22 EDT 2001

Posted by Rich Bowen <rb...@rcbowen.com>.
On Fri, 21 Sep 2001, William A. Rowe, Jr. wrote:

> From: "Rich Bowen" <rb...@rcbowen.com>
> Sent: Friday, September 21, 2001 6:05 AM
>
>
> > On Wed, 19 Sep 2001, Rodent of Unusual Size wrote:
> >
> > > - XHTML conversion
> > >         Status: unknown
> >
> > I was wondering about this. A few weeks ago I submitted some mod docs
> > that had been xhtml-ized via w3c tidy. Did anyone have any complaints
> > with those? If not, I can xhtml-ize the entire documentation tree in
> > about a minute.
>
> +1, just do it.  Give everyone fair warning (say Saturday evening/US
> afternoon/EU) so they can get work-in-progress committed.  After such
> changes, it's very hard to fix version conflicts.
>
> We get several bonuses, not the least of which is finally folding all
> tags to lower case, which is better for character and token-based
> compression, and more consistent docs are easier to maintain.

ok, WARNING, I will be doing this Saturday afternoon, during my
daughter's nap.

-- 
Pilgrim, how you journey on the road you chose
To find out where the winds die and where the stories go
 --Pilgrim (Enya - A Day Without Rain)


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: [STATUS] (httpd-docs-2.0) Wed Sep 19 23:45:22 EDT 2001

Posted by "William A. Rowe, Jr." <wr...@rowe-clan.net>.
From: "Rich Bowen" <rb...@rcbowen.com>
Sent: Friday, September 21, 2001 6:05 AM


> On Wed, 19 Sep 2001, Rodent of Unusual Size wrote:
> 
> > - XHTML conversion
> >         Status: unknown
> 
> I was wondering about this. A few weeks ago I submitted some mod docs
> that had been xhtml-ized via w3c tidy. Did anyone have any complaints
> with those? If not, I can xhtml-ize the entire documentation tree in
> about a minute.

+1, just do it.  Give everyone fair warning (say Saturday evening/US
afternoon/EU) so they can get work-in-progress committed.  After such
changes, it's very hard to fix version conflicts.

We get several bonuses, not the least of which is finally folding all
tags to lower case, which is better for character and token-based
compression, and more consistent docs are easier to maintain.

Bill


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: [STATUS] (httpd-docs-2.0) Wed Sep 19 23:45:22 EDT 2001

Posted by Rich Bowen <rb...@rcbowen.com>.
On Wed, 19 Sep 2001, Rodent of Unusual Size wrote:

> - XHTML conversion
>         Status: unknown

I was wondering about this. A few weeks ago I submitted some mod docs
that had been xhtml-ized via w3c tidy. Did anyone have any complaints
with those? If not, I can xhtml-ize the entire documentation tree in
about a minute.

-- 
And everyone said, "If we only live,
We too will go to sea in a Sieve -
To the hills of the Chankly Bore!"
 (The Jumblies, by Edward Lear)


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org


Re: [STATUS] (httpd-docs-2.0) Wed Sep 19 23:45:22 EDT 2001

Posted by Rich Bowen <rb...@rcbowen.com>.
On Wed, 19 Sep 2001, Rodent of Unusual Size wrote:

> Apache HTTP Server 2.0 Documentation Status File.
> Last modified: $Date: 2001/09/17 18:32:45 $
>
> - XHTML conversion
>         Status: unknown

All the 2.0 documentation has been converted to XHTML. It is now ...

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

I would appreciate it if folks could verify that I did not screw
anything up, particularly in the non-english documents, and particularly
in the non-latin charset documents. I noticed one ja.jis document
(howto/ssi.html.ja.jis) got completely hosed with the conversion, and I
was left with a file with no contents. I did not commit that change.
That is the one file that is not xhtml yet.

-- 
Nothing is perfekt. Certainly not me.
Success to failure. Just a matter of degrees.


---------------------------------------------------------------------
To unsubscribe, e-mail: apache-docs-unsubscribe@apache.org
For additional commands, e-mail: apache-docs-help@apache.org