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 2002/05/23 05:45:31 UTC

[STATUS] (httpd-docs-2.0) Wed May 22 23:45:25 EDT 2002

Apache HTTP Server 2.0 Documentation Status File.
Last modified: $Date: 2002/05/21 06:05:53 $

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.

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

- XML
    - The xsl transformations could be greatly improved to a) look better
      and b) use proper CSS+html rather than the horrible hack that
      Joshua did.
    - The build system does not work very well right now.

- modules docs
    - mod_suexec: very little documentation
    - mod_proxy: updates for 2.0
    - 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.

- 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.
          - the perchild directives in threaded/worker need docs

   - Individual docs will need some cleanup. 
        Status:  What docs still need to be touched here?
                 - misc/perf-tuning.html - needs major rewrite for 2.0
                 - misc/tutorials.html - mostly not relevant to 2.0
                 - misc/stopping.html
                 - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
                 - misc/known_client_problems.html - mostly ancient
                 - content-negotiation.html - Multiviews has changed
                   significantly since 1.3, so this needs updating
                   Bill Rowe can probably help with any questions

- New build process.
    - install.html has had a first-pass rewrite, but many things have
      changed in the build system since it was written.

- 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)
    - Luxembourgish (.lb)
    - 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)
    - Chinese (.zh)
    [Need this clarified --jsl]


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

* Directory Handling (mod_dir/mod_autoindex/etc)

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

* public_html - tutorial covering what is involved in helping users set
  up web serving out of their home directory.

* .htaccess - Perhaps as simple as an auto-generated listing of what
  directives are permitted in .htaccess files (possible with the
  appropriate xsl stylesheet). Would be nice if common
  examples (authentication, adding SSI or CGI capabilities, etc) could
  be given as well.


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

  - Every directive should have at least one example of usage, except
    those directives which list all possible usages in the Syntax
    description. And maybe some of those too. People like examples.
    mod/core.html has been checked all the way through, as have a few
    of the modules.

* 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.].)

* regex: We should at least document someplace what regex library we
  are using and how to find more information about it

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


Re: mhm

Posted by Volker Richter <vo...@nidura.de>.
Hi,
Ich antworte jetzt mal direkt an dich .. dafür aber in Deutsch, was
etwas einfacher ist. Die Mail enthält nur einige Grundlegende Fragen,
die sich mir noch stellen ;)


> sorry, I couldn't answer earlier, because a very good friend died two
> days ago :(

mein beileid :(

> We (currently two people - André & myself) are working at the
> translation of the version 2 docs. Lars will review it. Ehm... and we
> are in an early state yet.
>
> At the moment, every document of version 2 is converted from HTML to
> XML, which is done generally. Some files, especially the module docs,
> are already existing in XML. Other files have to be converted yet. We
> are doing the translation with XML files only. If they don't exist, we
> will have to convert them.

ok .. ich hab im cvs modules verzeichnis ganz viele xml files gefunden ..
aber bis jetzt nur englische ... wie sieht denn ein xml file in deutsch aus?
hat es auch die endung .xml? kommt der deutsche text einfach mit in das
vorhandene xml file rein?

> The next step should be a separate german
> discussion to organize the work for consitent translation.

Soll die auch hier in der Mailing List stattfinden oder wird dafür
eine eigene Newsgroup oder Ähnliches angelegt?


--
Grüsse aus Bochum

Volker


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


Re: mhm

Posted by Astrid Keßler <ke...@kess-net.de>.
Hi Volker,

sorry, I couldn't answer earlier, because a very good friend died two
days ago :(

We (currently two people - André & myself) are working at the
translation of the version 2 docs. Lars will review it. Ehm... and we
are in an early state yet.

At the moment, every document of version 2 is converted from HTML to
XML, which is done generally. Some files, especially the module docs,
are already existing in XML. Other files have to be converted yet. We
are doing the translation with XML files only. If they don't exist, we
will have to convert them.

You are welcome to work on version 2, too. I suggest, that
you look at the mailing list archive at
http://marc.theaimsgroup.com/?l=apache-docs and read
http://httpd.apache.org/docs-project/docsformat.html to understand the
stucture of the xml files. The next step should be a separate german
discussion to organize the work for consitent translation.

Is this okay for you? Lars?

Kess

--
E-Mail: kess@kess-net.de


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


Re: mhm

Posted by Cliff Woolley <jw...@virginia.edu>.
On Thu, 23 May 2002, Volker Richter wrote:

> I subscribed to the mailing list now and received the cvstree. But I '
> ve got another thing that I don't understand. There are many html files
> in the cvs ( .en | .fr .... ) but I can't find any german (.de) files.
> Does that mean no one has ever submitted one or am I just allowed to
> submit pages if the whole documetation is translated?

There are several people currently working on a translation of the docs to
German, several of whom are subscribed to this list.  I'm sure they can
guide you on what would be a good way to spend your time.  Lars?  Astrid?

> And if I translate those files step by step - how do i send them to cvs?
> do I just have to send the file to the mailing list? ( I've only found
> patches in the current list; a new file is no patch )

If you work on the project long enough, you may be granted commit
privileges so you can place your work directly into CVS.  For now, just
attach files to an email to the mailing list.

Welcome to the team.
--Cliff


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


mhm

Posted by Volker Richter <vo...@nidura.de>.
Hi again,

I subscribed to the mailing list now and received the cvstree. But I ' ve
got another thing that I don't understand. There are many html files in the
cvs ( .en | .fr .... ) but I can't find any german (.de) files. Does that
mean no one has ever submitted one or am I just allowed to submit pages if
the whole documetation is translated?
And if I translate those files step by step - how do i send them to cvs? do
I just have to send the file to the mailing list? ( I've only found patches
in the current list; a new file is no patch )

many questions, I know ;))


--
Volker Richter
Nidura ( Rover )
Administration, Technics & Development

URL: www.nidura.de
URL: www.volkerrichter.com
URL: www.webmailx.de

Mail: rover@nidura.de
Mail: me@volkerrichter.com
Mail: volker@php.net



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