Ok, I'll proceed with writing those.

Will there be a straightforward (even if somewhat messy) way for me to
generate a link from these pages to the package descriptions for the base
library?  That is, in my "html-el" package description, I would like to see
a link that would go directly to the package description for the "html"
package.  If in the final documentation, the "html" directory is in the same
directory as the "html-el" directory, then that will probably work.

I believe that the nature of this library as a simple "integration" of two
complex pieces implies that the unique information in the package
descriptions should be relatively short, with several usage examples, but
with a link to the package description for the base library.  It would have
been nice to also have a link to an HTML page that directly shows
documentation for the JSTL, but I guess the best we can do is point them to
the PDF specification download.

> -----Original Message-----
> From: Ted Husted [mailto:husted@;apache.org]
> Sent: Friday, October 18, 2002 7:15 AM
> To: Struts Developers List
> Subject: Re: Suggestions for placement of Struts-EL information in the
> user gu ide?
> 
> 
> If you can put the high-level usuage documentation 
> ("narrative") in a package.html for each of the taglibs, 
> following the example of the other taglibs, I'll can sort out 
> the mechanics of getting the package description, 
> Javadoc, and API guide into the documentation/website (somehow).
> 
> I'm very glad you were able to put this library together, 
> David. I'm sure it will of great use to a great many 
> people =:o) 
> 
> -Ted.
> 
> 10/18/2002 10:02:39 AM, [EMAIL PROTECTED] (David M. Karr) wrote:
> >Yes, the API part is automatic, for the "struts-*.xml" files 
> in the main Struts
> >distribution, which also generates the TLD files.  The 
> "struts-*-el.xml" files
> >for Struts-EL are in "contrib/struts-el".  How do we 
> automatically generate the
> >API documentation for Struts-EL so it is inserted into the 
> user guide in the
> >main distribution?
> >
> >Similarly, we'll have to figure out what to do about the 
> javadoc for Struts-EL.
> >
> >    Ted> So, for the narrative you mentioned, follow the 
> example of the other package.html files 
> >    Ted> (taglib/bean/package.html), and it will be compiled 
> into the JavaDocs. 
> >
> >    Ted> Once that is done, I can setup the rest of the 
> Struts-EL Developer guide, if you like. 
> >
> >That would be fine.
> >
> >    Ted> Pzst 1.1, I'd like to try and do more of the 
> "Developer Guide" kid of thing, and link more into the 
> JavaDocs. 
> >    Ted> Right now, we're getting into a lot of dual 
> maintenance. But first things first.
> >
> >I'm not sure what you mean here.
> >
> >-- 
> >===================================================================
> >David M. Karr          ; Java/J2EE/XML/Unix/C++
> >[EMAIL PROTECTED]
> >
> >
> >--
> >To unsubscribe, e-mail:   
<mailto:struts-dev-unsubscribe@;jakarta.apache.org>
>For additional commands, e-mail:
<mailto:struts-dev-help@;jakarta.apache.org>
>
>




--
To unsubscribe, e-mail:   <mailto:struts-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:struts-dev-help@;jakarta.apache.org>

--
To unsubscribe, e-mail:   <mailto:struts-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:struts-dev-help@;jakarta.apache.org>

Reply via email to