On Wed, 19 Jun 2002, Stas Bekman wrote: > 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
OK, those ones I had missed. I thought I had been pretty thoroughally through the rest of the site, but these must post-date my reading. > 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. You're right. They are currently rather hard to find. > 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 No, it is not at all that I don't like the current format. The current format is good. People used to the Apache documentation frequently ask, in my hearing, for a similar document for mod_perl. I have heard this in numerous seminars I have taught and attended. I have seen it on mailing lists and on IRC. This is not saying that one format is bad, but that another is familiar. > > 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? I actually created the doc in my httpd-docs-2.0 cvs checkout, and used the tools there to convert it. That way I can write it in simple XML and not have to write HTML. > > 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? I will defer to you on this. I don't want, at any level, to imply that what has been done to date is lacking. This is merely a familiar format that people have asked for, and I was trying to fill a need. I'll back off now on this issue, if there is not general consensus that it is desired. You are right in saying that the new docs fill many of the needs that I am addressing, and the only real different is actual page layout. When can we expect to have these new docs readily accessible from the front page of perl.apache.org? I am very interested in being involved in mod_perl documentation in some capacity, but I will lurk for a month or son and see where the need is. -- Rich Bowen Apache Administrators Handbook ApacheAdmin.com --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
