On Tue, 18 Jun 2002, Rich Bowen wrote:
I know, it is gravely lacking, and needs help. And I intend to do something about that. But I have a few questions before I burn a lot of time on that.
OK, so, given the various comments, I gather that the following.
The document itself meets with general approval, as a concept.
We should leave it exceedingly simple, and provide links to additional documentation in the guide, where available.
Currently it has no fit into the mod_perl documentation. I don't see anything in this doc which is already not covered in the docs that I've committed just a few days ago:
http://perl.apache.org/release/docs/2.0/user/config/config.html
http://perl.apache.org/release/docs/2.0/user/handlers/handlers.html
All these people who comment in favor of your doc, haven't even seen what we have already and don't know what has been planned.
What I was saying that if you prefer to still keep it, don't extend on it, but provide pointers to directives discussions. Which I'd also hold off, because the 2.0 docs are on move and their layout will change a lot as more docs get written.
Of course nobody is trying to prevent other people who instead of helping with a single source of documentation try to duplicate the efforts and simply bring a lot of confusion to poor users who already somehow have to sip through hundreds of pages of docs.
Rich, what don't you like about the current format? The docs at the URLs I've posted are incomplete but the plan is to have a page of Appendix style where you have all the info placed concisely in one place. e.g. Apache style doc doesn't give you this:
http://perl.apache.org/release/docs/2.0/user/config/config.html#mod_perl_Directives_Argument_Types_and_Allowed_Location
Doc will be provided in some format that is easy to maintain. The XML doc is very nice, but as long as we don't have a means to convert, it is a little silly. So I'll do the initial convert, and then we'll go from there.
Convert where?
How's that? How do we proceed?
DocSet, the framework that is currently used for building the docs/site accepts pod and html as the source format and can be extended to other formats, like xml. The problem with xml is that it has lots of prerequisites which sometimes are hard to get. Though I agree that xml is a superior data format to pod when it comes to tabulated data.
But before we do anything in that direction I don't think there is a need for it. Do you think that there is such a need?
__________________________________________________________________ Stas Bekman JAm_pH ------> Just Another mod_perl Hacker http://stason.org/ mod_perl Guide ---> http://perl.apache.org mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com http://modperlbook.org http://apache.org http://ticketmaster.com
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
