Return-Path: Mailing-List: contact cocoon-dev-help@xml.apache.org; run by ezmlm Delivered-To: mailing list cocoon-dev@xml.apache.org Received: (qmail 64207 invoked from network); 26 Jul 2000 08:28:47 -0000 Received: from mailgate.sergeant.org (HELO mail.sergeant.org) (@194.70.26.133) by locus.apache.org with SMTP; 26 Jul 2000 08:28:47 -0000 Received: (qmail 32218 invoked by uid 501); 26 Jul 2000 08:34:02 -0000 Received: from localhost (sendmail-bs@127.0.0.1) by localhost with SMTP; 26 Jul 2000 08:34:02 -0000 Date: Wed, 26 Jul 2000 09:34:02 +0100 (BST) From: Matt Sergeant To: Donald Ball cc: cocoon-dev@xml.apache.org Subject: Re: idea for documenting xsp logicsheets In-Reply-To: Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-Spam-Rating: locus.apache.org 1.6.2 0/1000/N On Wed, 26 Jul 2000, Donald Ball wrote: > while talking with jeremy about the fp logicsheet, an idea occured to > me. good logicsheets have what amounts to a nice strict API to expose to > the outer world, but there isn't a nice easy way to document said API, > which means we have all sorts of confusion about how to use, say, the > cookie logicsheet, what parameters the sql logicsheet _really_ takes, what > the fp taglib has to offer, etc. seems like we could fix this pretty > easily with judicious use of namespaces. suppose i marked up sql > logicsheet like so: > > > executes a sql query and returns any results > > the name of the connection pool to use > > name="content" select="sql:use-connection"/> > > > > the class name of the database driver > > name="content" select="sql:driver"/> > > > > the url of the database source > > name="content" select="sql:dburl"/> > > > > assuming we could configure the xsp processor to ignore the xspdoc > elements (either by stripping them when doing the XSLT transform or adding > "strip xspdoc elements" rules to the xsp to java stylesheet), all we'd > need to generate concise docs is a simple stylesheet like this: > > > > >

> >: > > >
>
> >
>
> >
>
> >

> > > > > obviously we could elaborate a bit on the elements and attributes of the > xspdoc namespace, but that's the gist. any thoughts from other logicsheet > authors? worthwhile to pursue? This is pretty much the solution from the XSL-list regarding documenting stylesheets. Personally I write taglibs either in raw perl for speed, or in XPathScript, which means I can use POD to document them, but for XSLT based taglibs this seems like an excellent idea. -- Fastnet Software Ltd. High Performance Web Specialists Providing mod_perl, XML, Sybase and Oracle solutions Email for training and consultancy availability. http://sergeant.org | AxKit: http://axkit.org