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/11/21 05:45:56 UTC
[STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
Apache HTTP Server 2.0 Documentation Status File.
Last modified: $Date: 2002/11/14 19:20:54 $
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 docs-subscribe@httpd.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.
------------------------------
Things That Need Fixing
=======================
- XML
- Rewriting of the remainder of the manual into xml is in
progress. See the bottom of this file for status info.
- add ids to non-directive sections of the module docs, so they
get a chance to be linked in the sidebar
- Windows platform docs are in desperate need of rewrites/updates for 2.0.
- Bill Rowe and Bill Stoddard are good contacts for tech questions.
- New Auth system
(Wait on this until the code has stabalized a little)
- With the new auth system, we have a bunch of directives that are
duplicated in multiple modules, where one of the modules is obsolete.
We probably need to mark the old modules as <status>obsolete</status>
and key on that to omit them from the directive index, etc.
- Much clean-up and enhancement of docs
- Independent note on how to upgrade to new auth system
- Figure out what to do about the 2.0 FAQ
- Copy important stuff from 1.3?
- Some kind of XML?
- Something that allows dynamic contributions from users a la
FAQ-O-Matic? (I don't think any really good software exists
for this.)
- 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
- Convert from nroff to our xml format. See list at bottom.
- Then if someone gets creative, they can try to find an automatic
way to convert back to nroff.
- An example: http://cyberelk.net/tim/data/xmlto/db2man/
This is designed for docbook, but it could be adapted.
I'm not sure what the license is.
- MPM documentation
- Non unix/windows MPMs still need to be completed.
- the perchild directives in threaded/worker need docs
- Individual docs will need some cleanup.
- misc/custom_errordocs.html needs to be updated to
essentially describe how the international error
docs included in 2.0 work
- 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
- platform/ebcdic.xml - needs major rework for 2.0
- New build process.
- install.html has had a first-pass rewrite, it is basically
accurate, but very incomplete.
- API documentation
Status: Ben Laurie has written some hooks documentation
- Translations
There are several efforts underway to translate the documentation
into other languages. A detailed list of the currently known
translators (and the corresponding websites) can be found at
http://httpd.apache.org/docs-project/translations.html
Documentation improvements
==========================
* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
* Enhancements to the DTD/XSL:
- <glossary> tag that links to the glossary and uses some special
style in the css.
- New index: directives by context, including listing which directives
are available for each AllowOverride setting.
- Use a tag like <var> in place of <em> for things like the
<syntax> listing.
- nd volunteers
- add letter links to glossary and quickreference,
perhaps also a term overview (sidebar)
- cross references between the different languages,
at least links from non-en docs to the originals.
- Javascript?
- post processing (s&r, XML::Parser, ...)?
- pre processing ([kind of] type maps
generated from sitemap entries like:
<page><variant lang="en" href="">title</variant>)?
- looking for other good ideas ;-)
- remove <pre> elements. Use <br /> and <indent> elements to get
same effect.
- need to add new <parentdocument> element to more docs
* Autogeneration of PDF
- FOP?
* Windows help file
- David Shane Holden was working on this
* 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.].)
XML Conversions
===============
The following files need to be converted to XML as described at
http://httpd.apache.org/docs-project/docsformat.html
index.html.en # leave in html?
howto/auth.html.en
misc/custom_errordocs.html # obsolete?
misc/descriptors.html # obsolete?
misc/fin_wait_2.html # obsolete?
misc/known_client_problems.html # obsolete?
misc/tutorials.html # obsolete?
expand.pl # delete after finishing everything
# These will require manual.xsl changes
faq/footer.html
faq/header.html
faq/index.html
faq/support.html
# Perhaps these should be left in html to allow the developers to
# play with them
developer/API.html
developer/debugging.html
developer/documenting.html
developer/filters.html
developer/footer.html
developer/header.html
developer/hooks.html
developer/index.html
developer/layeredio.html
developer/request.html
developer/thread_safety.html
developer/modules.html.en
# converting from nroff to xml
programs/ab.html
programs/apxs.html
programs/dbmmanage.html
programs/footer.html
programs/header.html
programs/htdigest.html
programs/htpasswd.html
programs/index.html
programs/logresolve.html
programs/other.html
programs/rotatelogs.html
programs/suexec.html
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: [STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
Posted by Kyle Hamilton <wi...@sbcglobal.net>.
Ok cool yea im starting work on a web stie for people just staring with
apache cause it took me like 3 days to get apache down but if I had some
better documention I would have had it down nothing flat and thats my goal I
sort of want to see Apache power 99.9 of the web mainly to spite microsoft
but im getting off topic so yea I already have some stuff on installing
Apache and V.Hosting in win32
Kyle
www.kyleserver.com
----- Original Message -----
From: "André Malo" <nd...@perlig.de>
To: <do...@httpd.apache.org>
Sent: Thursday, November 21, 2002 12:34 AM
Subject: Re: [STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
* Kyle Hamilton wrote:
> Im willing to Help with the Windows Help Docs can someone email me and ill
> do what i can I just dont want to start something someone else is all
ready
> doing
hmm, don't know the state of Shane's work.
I'm currently working on some xml and xslt for automatic builds, too. My
current state is a (just working, but not more...)
ant+xslt+manual-compiler-start hack, that needs a complete rework.
(actually it was an experiment for me)
There are also some (CSS) style issues to consider, I think.
However, additional ideas and/or solutions are always welcome ;-)
nd
--
die (eval q-qq:Just Another Perl Hacker
:-)
# André Malo, <http://www.perlig.de/> #
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: [STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
Posted by David Shane Holden <dp...@yahoo.com>.
André Malo wrote:
> * Kyle Hamilton wrote:
>
>
>>Im willing to Help with the Windows Help Docs can someone email me and ill
>>do what i can I just dont want to start something someone else is all ready
>>doing
>
>
> hmm, don't know the state of Shane's work.
> I'm currently working on some xml and xslt for automatic builds, too. My
> current state is a (just working, but not more...)
> ant+xslt+manual-compiler-start hack, that needs a complete rework.
> (actually it was an experiment for me)
>
> There are also some (CSS) style issues to consider, I think.
>
> However, additional ideas and/or solutions are always welcome ;-)
>
> nd
I put what I have up at http://cvs.apache.org/~dpejesh/htmlhelp.zip.
Extract the htmlhelp directory into httpd-docs-2.0/manual and run
htmlhelp/build/build.cmd. Make sure that the htmlhelp compiler is in
the PATH and that's about it. It's pretty raw and rudimentary, so be
warned. There's still quite a bit that can be done to improve upon it.
I just rebuilt the htmlhelp file and I didn't notice any CSS issues, but
I didn't dig around to much.
Shane
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: [STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
Posted by André Malo <nd...@perlig.de>.
* Kyle Hamilton wrote:
> Im willing to Help with the Windows Help Docs can someone email me and ill
> do what i can I just dont want to start something someone else is all ready
> doing
hmm, don't know the state of Shane's work.
I'm currently working on some xml and xslt for automatic builds, too. My
current state is a (just working, but not more...)
ant+xslt+manual-compiler-start hack, that needs a complete rework.
(actually it was an experiment for me)
There are also some (CSS) style issues to consider, I think.
However, additional ideas and/or solutions are always welcome ;-)
nd
--
die (eval q-qq:Just Another Perl Hacker
:-)
# André Malo, <http://www.perlig.de/> #
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: [STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
Posted by Kyle Hamilton <wi...@sbcglobal.net>.
Im willing to Help with the Windows Help Docs can someone email me and ill
do what i can I just dont want to start something someone else is all ready
doing
-Kyle
kylehamilton@kylehamilton.net
----- Original Message -----
From: "Rodent of Unusual Size" <Ke...@Golux.Com>
To: "Apache httpd documenters" <ap...@Apache.Org>
Sent: Wednesday, November 20, 2002 8:45 PM
Subject: [STATUS] (httpd-docs-2.0) Wed Nov 20 23:45:56 EST 2002
> Apache HTTP Server 2.0 Documentation Status File.
> Last modified: $Date: 2002/11/14 19:20:54 $
>
> 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 docs-subscribe@httpd.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.
>
> ------------------------------
>
> Things That Need Fixing
> =======================
>
> - XML
> - Rewriting of the remainder of the manual into xml is in
> progress. See the bottom of this file for status info.
> - add ids to non-directive sections of the module docs, so they
> get a chance to be linked in the sidebar
>
> - Windows platform docs are in desperate need of rewrites/updates for 2.0.
> - Bill Rowe and Bill Stoddard are good contacts for tech questions.
>
> - New Auth system
> (Wait on this until the code has stabalized a little)
> - With the new auth system, we have a bunch of directives that are
> duplicated in multiple modules, where one of the modules is
obsolete.
> We probably need to mark the old modules as
<status>obsolete</status>
> and key on that to omit them from the directive index, etc.
> - Much clean-up and enhancement of docs
> - Independent note on how to upgrade to new auth system
>
> - Figure out what to do about the 2.0 FAQ
> - Copy important stuff from 1.3?
> - Some kind of XML?
> - Something that allows dynamic contributions from users a la
> FAQ-O-Matic? (I don't think any really good software exists
> for this.)
>
> - 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
> - Convert from nroff to our xml format. See list at bottom.
> - Then if someone gets creative, they can try to find an automatic
> way to convert back to nroff.
> - An example: http://cyberelk.net/tim/data/xmlto/db2man/
> This is designed for docbook, but it could be adapted.
> I'm not sure what the license is.
>
> - MPM documentation
> - Non unix/windows MPMs still need to be completed.
> - the perchild directives in threaded/worker need docs
>
> - Individual docs will need some cleanup.
> - misc/custom_errordocs.html needs to be updated to
> essentially describe how the international error
> docs included in 2.0 work
> - 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
> - platform/ebcdic.xml - needs major rework for 2.0
>
> - New build process.
> - install.html has had a first-pass rewrite, it is basically
> accurate, but very incomplete.
>
> - API documentation
> Status: Ben Laurie has written some hooks documentation
>
> - Translations
> There are several efforts underway to translate the documentation
> into other languages. A detailed list of the currently known
> translators (and the corresponding websites) can be found at
>
> http://httpd.apache.org/docs-project/translations.html
>
>
> Documentation improvements
> ==========================
>
> * New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
>
> * Enhancements to the DTD/XSL:
> - <glossary> tag that links to the glossary and uses some special
> style in the css.
> - New index: directives by context, including listing which directives
> are available for each AllowOverride setting.
> - Use a tag like <var> in place of <em> for things like the
> <syntax> listing.
> - nd volunteers
> - add letter links to glossary and quickreference,
> perhaps also a term overview (sidebar)
> - cross references between the different languages,
> at least links from non-en docs to the originals.
> - Javascript?
> - post processing (s&r, XML::Parser, ...)?
> - pre processing ([kind of] type maps
> generated from sitemap entries like:
> <page><variant lang="en" href="">title</variant>)?
> - looking for other good ideas ;-)
> - remove <pre> elements. Use <br /> and <indent> elements to get
> same effect.
> - need to add new <parentdocument> element to more docs
>
> * Autogeneration of PDF
> - FOP?
>
> * Windows help file
> - David Shane Holden was working on this
>
> * 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.].)
>
> XML Conversions
> ===============
>
> The following files need to be converted to XML as described at
> http://httpd.apache.org/docs-project/docsformat.html
>
> index.html.en # leave in html?
> howto/auth.html.en
> misc/custom_errordocs.html # obsolete?
> misc/descriptors.html # obsolete?
> misc/fin_wait_2.html # obsolete?
> misc/known_client_problems.html # obsolete?
> misc/tutorials.html # obsolete?
> expand.pl # delete after finishing everything
>
> # These will require manual.xsl changes
> faq/footer.html
> faq/header.html
> faq/index.html
> faq/support.html
>
> # Perhaps these should be left in html to allow the developers to
> # play with them
> developer/API.html
> developer/debugging.html
> developer/documenting.html
> developer/filters.html
> developer/footer.html
> developer/header.html
> developer/hooks.html
> developer/index.html
> developer/layeredio.html
> developer/request.html
> developer/thread_safety.html
> developer/modules.html.en
>
> # converting from nroff to xml
> programs/ab.html
> programs/apxs.html
> programs/dbmmanage.html
> programs/footer.html
> programs/header.html
> programs/htdigest.html
> programs/htpasswd.html
> programs/index.html
> programs/logresolve.html
> programs/other.html
> programs/rotatelogs.html
> programs/suexec.html
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
> For additional commands, e-mail: docs-help@httpd.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org