You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by hu...@apache.org on 2001/06/16 14:44:12 UTC
cvs commit: jakarta-struts/doc/userGuide resources.xml project.xml index.xml
husted 01/06/16 05:44:12
Modified: doc/userGuide resources.xml project.xml index.xml
Log:
Second try to update indices and resource page.
Revision Changes Path
1.2 +66 -29 jakarta-struts/doc/userGuide/resources.xml
Index: resources.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/resources.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- resources.xml 2001/03/18 17:48:59 1.1
+++ resources.xml 2001/06/16 12:44:12 1.2
@@ -7,33 +7,70 @@
</properties>
<body>
<chapter name="Struts Resources" href="resources">
-<section name="Struts Tutorials" href="tutorials">
-<h3>Articles</h3>
-<p><b>Introduction to MVC and the Jakarta Struts Framework</b> (online presentation),
- <a href="mailto:craiger@tataryn.net">Craig Tataryn</a> -- <a href="http://www.us-eh.com/craiger/articles/struts/">http://www.us-eh.com/craiger/articles/struts/</a>
-</p>
-<p><b>Struts, an open-source MVC implementation</b>, <a href="mailto:malcolm@nuearth.com">Malcom
- Davis</a> -- <a href="http://www-106.ibm.com/developerworks/library/j-struts/?n-j-2151">http://www-106.ibm.com/developerworks/library/j-struts/?n-j-2151</a>
-</p>
-<p><b>Strut Your Stuff With JSP Tags</b>, <a href="mailto:Thor.Kristmundsson@javaworld.com">Thor
- Kristmundsson</a> -- <a href="http://www.javaworld.com/javaworld/jw-12-2000/jw-1201-struts.html">http://www.javaworld.com/javaworld/jw-12-2000/jw-1201-struts.html</a>
-</p>
-<p><b>Using the Struts Framework to Develop a Message Board</b>, Maneesh Sahu
- -- <a href="http://informit.com/books/authors/author_template/index.asp?authorid={A08A00B0-71BB-42DB-9B29-08879A9A7ABE}&t={94AE5B48-1D7D-462A-A4A6-83CE19EC0705}&n={4641FAF9-E21F-4902-8F6E-0C8FAF114C62}">Author's
- Page</a> (article requires registration with informit.com) </p>
-<p><b>JSP templates</b>, <a href="mailto:david.geary@javaworld.com">David Geary</a>
- -- <a href="http://www.javaworld.com/javaworld/jw-09-2000/jw-0915-jspweb_p.html">http://www.javaworld.com/javaworld/jw-09-2000/jw-0915-jspweb_p.html</a></p>
-<h3>Tutorials</h3>
-<p><b>Welcome to the Struts Framework</b>, <a href="http://www.bluestone.com">Bluestone
- Software</a> -- <a href="http://developer.bluestone.com/scripts/SaISAPI.dll/Gallery.class/demos/trailMaps/index.jsp">http://developer.bluestone.com/scripts/SaISAPI.dll/Gallery.class/demos/trailMaps/index.jsp</a>
-</p>
-<h3>Mailing List Archives</h3>
-<p><a href="http://archive.covalent.net/"><b>covalent.net</b></a><br />
- <a href="http://mail-archive.com/"><b>mail-archive.com</b></a> </p>
-<h3>Other Resource Pages</h3>
-<p><b>About Struts</b>, <a href="mailto:support@husted.com">Husted dot Com</a>
- -- <a href="http://www.husted.com/about/struts/">http://www.husted.com/about/struts/</a>
-</p>
+
+<section name="Contributor Extensions" href="extensions">
+
+<p>Here are some popular extensions to Struts that have not been made part of
+the official distribution (yet).</p>
+
+<p><a href="http://www.lifl.fr/~dumoulin/components/"><b>Components Library for building JSP views</b></a> by
+Cedric Dumoulin - A component is a JSP page that can be inserted in another JSP page,
+like templates, but can take "parameters" (URLs or 'direct' string intemplates). </p>
+
+<p><a href="http://home.earthlink.net/~dwinterfeldt/"><b>Struts Validator by David Winderfeldt</b></a> - Perform basic validations to check if a field
+is required, matches a regular expression, and some basic type checking. Different validation rules can be
+defined for different locales. The framework has basic support for user defined constants which can be used
+in some field attributes. The validation routines are modifiable in the validation.xml file so custom validation
+routines can be created and added to the framework.</p>
+
+<p><a href="http://www.sura.ru/~gonza/bean-factory/"><b>Bean factory by Oleg V Alexeev</b></a> -
+Adds the ability to easily link data bean creation to any Struts Action. All information
+about databeans and actions mappings stored in the standard Struts configuraton file.</p>
+
</section>
-</chapter>
-</body></document>
+
+<section name="Tutorials" href="tutorials">
+
+<p><a href="http://developer.bluestone.com/scripts/SaISAPI.dll/Gallery.class/demos/trailMaps/index.jsp"><b>Welcome to the Struts Framework</b></a> by <a href="http://www.bluestone.com">Bluestone Software</a>.</p>
+
+<p><a href="http://www.jspinsider.com/tutorials/jsp/struts/strutsintro.html"><b>An Introduction to Struts</b></a> by Casey Kochmer.</p>
+
+<p><a href="http://www.oakgrovesoftware.com/~rbackhouse/"><b>Write hdml based jsps using Struts</b></a> by Richard Backhouse.</p>
+
+<p><a href="http://quark.newparticles.com/struts/"><b>Information about the Struts Framework by Steve Wilkinson</b></a> - Excerpt from Wrox book.</p>
+
+</section>
+
+<section name="Articles" href="articles">
+
+<p><a href="http://www.sys-con.com/java/archives/0603/mcclanahan/"><b>Support your application development with Struts</b></a> by McClanahan, McCay, and Bergenholtz.</p>
+
+<p><a href="http://www.computer-programmer.org/articles/struts/"><b>Introduction to MVC and the Jakarta Struts Framework</b></a> -- <a href="mailto:craiger@tataryn.net">Craig Tataryn</a>.</p>
+
+<p><a href="http://www-106.ibm.com/developerworks/library/j-struts/?n-j-2151"><b>Struts, an open-source MVC implementation</b></a> -- <a href="mailto:malcolm@nuearth.com">Malcom Davis</a>.</p>
+
+<p><a href="http://www.javaworld.com/javaworld/jw-12-2000/jw-1201-struts.html"><b>Strut Your Stuff With JSP Tags</b></a>, <a href="mailto:Thor.Kristmundsson@javaworld.com">Thor Kristmundsson</a>.</p>
+
+<p><a href="http://informit.com/books/authors/author_template/index.asp?authorid={A08A00B0-71BB-42DB-9B29-08879A9A7ABE}&t={94AE5B48-1D7D-462A-A4A6-83CE19EC0705}&n={4641FAF9-E21F-4902-8F6E-0C8FAF114C62}"><b>Using the Struts Framework to Develop a Message Board</b></a> by Maneesh Sahu (article requires registration with informit.com).</p>
+
+<p><a href="http://www.javaworld.com/javaworld/jw-09-2000/jw-0915-jspweb_p.html"><b>JSP templates</b></a> by <a href="mailto:david.geary@javaworld.com">David Geary</a>.</p>
+
+</section>
+
+<section name="Other Resource Pages" href="other">
+
+<p><a href="http://www.husted.com/about/struts/"><b>About Struts</b></a> by <a href="mailto:support@husted.com">Husted dot Com</a>.</p>
+
+<p><a href="http://habweb.de/struts/"><b>German Translation of Users Guide</b></a> by Hartmut Bernecker.</p>
+
+</section>
+
+<section name="Mailing List Archives" href="archives">
+
+<p><a href="http://archive.covalent.net/"><b>covalent.net</b></a>.</p>
+
+<p><a href="http://mail-archive.com/"><b>mail-archive.com</b></a>.</p>
+
+</section>
+
+</chapter></body></document>
1.2 +1 -0 jakarta-struts/doc/userGuide/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/project.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- project.xml 2001/03/18 17:48:59 1.1
+++ project.xml 2001/06/16 12:44:12 1.2
@@ -13,6 +13,7 @@
<item name="View Components" href="building_view.html"/>
<item name="Controller Components" href="building_controller.html"/>
<item name="Resources" href="resources.html"/>
+ <item name="Who We Are" href="volunteers.html"/>
</menu>
</project>
1.2 +1 -0 jakarta-struts/doc/userGuide/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2001/03/18 17:48:59 1.1
+++ index.xml 2001/06/16 12:44:12 1.2
@@ -67,6 +67,7 @@
</ul></li>
</ul></li>
<li><a href="resources.html">5. Resources</a></li>
+ <li><a href="volunteers.html">6. Who We Are</a></li>
</ul>
</section>
Re: I would like to offer myself to help with documentation
Posted by Robert Leland <Ro...@freetocreate.org>.
Jonathan wrote:
> thus more feedback and thus better development. I also think we you all
> need to package a war file in which System.outs can be generated in a clear
> way to demonstrate the steps Struts goes through from request to response.
> That helps users understand visually as well as with the documentation.
In the CVS repository doc/uml/sequence-diagram-action.gif
This was generated by Gerry Chike. This does a good job
showing the sequence of steps struts goes through for login.
Maybe this could be used in the documentation ?
--
Robert Leland Robert@free2create.org
804 N. Kenmore Street +01-703-525-3580
Arlington VA 22201
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
Also, truthfully, you could provide this System.out version with the Struts
Documentation war. That way you could read, use and watch the framework
simultaneously
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 12:38 PM
Subject: Re: I would like to offer myself to help with documentation
> Jonathan wrote:
> > I also think that the easier it is for first timers to understand
> > Struts and how it works, the more likely you will have committed users
and
> > thus more feedback and thus better development.
>
> I have been meaning to try refactoring the installation page so that it
> starts with the binary distribution, and encourages trying the Struts
> sample WARs first. Starting out with the prerequisites for buildling
> Struts seems daunting.
>
> Jonathan wrote:
> > Also, I think most of the explanations in available tutorials on the net
are
> > not clear.
>
> Then go for it. Scratch what itches * you * the most.
>
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
ok. So I will send you my first piece in that format.
Thanks Ted.(disconnecting)
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 1:24 PM
Subject: Re: I would like to offer myself to help with documentation
> I often start with plain text since its easiest to retrofit with the XML
> tags later.
>
> Everything we use to build the Struts documentation is in the source
> download (\doc).
>
> Jonathan wrote:
> >
> > Ok. You tell me what you would like. I would like to send html for
> > formatting purposes, but if you use stylesheets (which I hate but am
willing
> > to work with) I can send xml with a stylesheet
>
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
I often start with plain text since its easiest to retrofit with the XML
tags later.
Everything we use to build the Struts documentation is in the source
download (\doc).
Jonathan wrote:
>
> Ok. You tell me what you would like. I would like to send html for
> formatting purposes, but if you use stylesheets (which I hate but am willing
> to work with) I can send xml with a stylesheet
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
Ok. You tell me what you would like. I would like to send html for
formatting purposes, but if you use stylesheets (which I hate but am willing
to work with) I can send xml with a stylesheet
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 12:46 PM
Subject: Re: I would like to offer myself to help with documentation
> Depending on the length you should send them inline, or post them
> someplace for others to download. Or, if you want to send them to me,
> I'll post them on my Struts page.
>
> I'd be a little nervous about distributing MS Word documents myself,
> given the critters they can hide.
>
> The final drafts that we have to post to the Struts Web site need to be
> in the XML format you would find in the source distribution. (Which is
> admittedly a serious pain.)
>
> Jonathan wrote:
> >
> > ok. Should I send MS word drafts to the dev list for review?
>
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
I know....but Ive been corrupted ;^>
----- Original Message -----
From: "Martin Cooper" <ma...@tumbleweed.com>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 10:23 PM
Subject: Re: I would like to offer myself to help with documentation
> I did, and it is, but it's not free. XML Cooktop is. :-)
>
> --
> Martin Cooper
>
>
> ----- Original Message -----
> From: "Jonathan" <ja...@i-2000.com>
> To: <st...@jakarta.apache.org>
> Sent: Saturday, June 16, 2001 7:04 PM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > Try xml spy. Thats a real good one
> > ----- Original Message -----
> > From: "Martin Cooper" <ma...@tumbleweed.com>
> > To: <st...@jakarta.apache.org>
> > Sent: Saturday, June 16, 2001 5:17 PM
> > Subject: Re: I would like to offer myself to help with documentation
> >
> >
> > > I've just started playing around with a free XML tool called XML
> Cooktop.
> > > It's pretty cool. You can load up the XML file in one tab of a window,
> the
> > > XSL in another, and switch to a third tab to see the result of
applying
> > the
> > > XSL to the XML. It works just fine with the Struts docs and
stylesheets,
> > > including the tld stylesheet. However, it is Windows only.
> > >
> > > I got it from http://www.xmleverywhere.com/cooktop/.
> > >
> > > --
> > > Martin Cooper
> > >
> > >
> > > ----- Original Message -----
> > > From: "Ted Husted" <hu...@apache.org>
> > > To: <st...@jakarta.apache.org>
> > > Sent: Saturday, June 16, 2001 9:46 AM
> > > Subject: Re: I would like to offer myself to help with documentation
> > >
> > >
> > > > Depending on the length you should send them inline, or post them
> > > > someplace for others to download. Or, if you want to send them to
me,
> > > > I'll post them on my Struts page.
> > > >
> > > > I'd be a little nervous about distributing MS Word documents myself,
> > > > given the critters they can hide.
> > > >
> > > > The final drafts that we have to post to the Struts Web site need to
> be
> > > > in the XML format you would find in the source distribution. (Which
is
> > > > admittedly a serious pain.)
> > > >
> > > > Jonathan wrote:
> > > > >
> > > > > ok. Should I send MS word drafts to the dev list for review?
> > >
> > >
> >
>
>
Re: I would like to offer myself to help with documentation
Posted by Martin Cooper <ma...@tumbleweed.com>.
I did, and it is, but it's not free. XML Cooktop is. :-)
--
Martin Cooper
----- Original Message -----
From: "Jonathan" <ja...@i-2000.com>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 7:04 PM
Subject: Re: I would like to offer myself to help with documentation
> Try xml spy. Thats a real good one
> ----- Original Message -----
> From: "Martin Cooper" <ma...@tumbleweed.com>
> To: <st...@jakarta.apache.org>
> Sent: Saturday, June 16, 2001 5:17 PM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > I've just started playing around with a free XML tool called XML
Cooktop.
> > It's pretty cool. You can load up the XML file in one tab of a window,
the
> > XSL in another, and switch to a third tab to see the result of applying
> the
> > XSL to the XML. It works just fine with the Struts docs and stylesheets,
> > including the tld stylesheet. However, it is Windows only.
> >
> > I got it from http://www.xmleverywhere.com/cooktop/.
> >
> > --
> > Martin Cooper
> >
> >
> > ----- Original Message -----
> > From: "Ted Husted" <hu...@apache.org>
> > To: <st...@jakarta.apache.org>
> > Sent: Saturday, June 16, 2001 9:46 AM
> > Subject: Re: I would like to offer myself to help with documentation
> >
> >
> > > Depending on the length you should send them inline, or post them
> > > someplace for others to download. Or, if you want to send them to me,
> > > I'll post them on my Struts page.
> > >
> > > I'd be a little nervous about distributing MS Word documents myself,
> > > given the critters they can hide.
> > >
> > > The final drafts that we have to post to the Struts Web site need to
be
> > > in the XML format you would find in the source distribution. (Which is
> > > admittedly a serious pain.)
> > >
> > > Jonathan wrote:
> > > >
> > > > ok. Should I send MS word drafts to the dev list for review?
> >
> >
>
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
Try xml spy. Thats a real good one
----- Original Message -----
From: "Martin Cooper" <ma...@tumbleweed.com>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 5:17 PM
Subject: Re: I would like to offer myself to help with documentation
> I've just started playing around with a free XML tool called XML Cooktop.
> It's pretty cool. You can load up the XML file in one tab of a window, the
> XSL in another, and switch to a third tab to see the result of applying
the
> XSL to the XML. It works just fine with the Struts docs and stylesheets,
> including the tld stylesheet. However, it is Windows only.
>
> I got it from http://www.xmleverywhere.com/cooktop/.
>
> --
> Martin Cooper
>
>
> ----- Original Message -----
> From: "Ted Husted" <hu...@apache.org>
> To: <st...@jakarta.apache.org>
> Sent: Saturday, June 16, 2001 9:46 AM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > Depending on the length you should send them inline, or post them
> > someplace for others to download. Or, if you want to send them to me,
> > I'll post them on my Struts page.
> >
> > I'd be a little nervous about distributing MS Word documents myself,
> > given the critters they can hide.
> >
> > The final drafts that we have to post to the Struts Web site need to be
> > in the XML format you would find in the source distribution. (Which is
> > admittedly a serious pain.)
> >
> > Jonathan wrote:
> > >
> > > ok. Should I send MS word drafts to the dev list for review?
>
>
Re: I would like to offer myself to help with documentation
Posted by Martin Cooper <ma...@tumbleweed.com>.
I've just started playing around with a free XML tool called XML Cooktop.
It's pretty cool. You can load up the XML file in one tab of a window, the
XSL in another, and switch to a third tab to see the result of applying the
XSL to the XML. It works just fine with the Struts docs and stylesheets,
including the tld stylesheet. However, it is Windows only.
I got it from http://www.xmleverywhere.com/cooktop/.
--
Martin Cooper
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 9:46 AM
Subject: Re: I would like to offer myself to help with documentation
> Depending on the length you should send them inline, or post them
> someplace for others to download. Or, if you want to send them to me,
> I'll post them on my Struts page.
>
> I'd be a little nervous about distributing MS Word documents myself,
> given the critters they can hide.
>
> The final drafts that we have to post to the Struts Web site need to be
> in the XML format you would find in the source distribution. (Which is
> admittedly a serious pain.)
>
> Jonathan wrote:
> >
> > ok. Should I send MS word drafts to the dev list for review?
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
Depending on the length you should send them inline, or post them
someplace for others to download. Or, if you want to send them to me,
I'll post them on my Struts page.
I'd be a little nervous about distributing MS Word documents myself,
given the critters they can hide.
The final drafts that we have to post to the Struts Web site need to be
in the XML format you would find in the source distribution. (Which is
admittedly a serious pain.)
Jonathan wrote:
>
> ok. Should I send MS word drafts to the dev list for review?
Re: I would like to offer myself to help with documentation
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sat, 16 Jun 2001, Jonathan wrote:
> ok. Should I send MS word drafts to the dev list for review?
The ideal (IMHO at least) would be XML docs using the same stylesheets
that we're already using to create documentation. That way, we can
immediately create web-readable versions of the new docs. And, if someone
later comes up with a new look-and-feel, these docs will be updated as
well.
Welcome!
Craig
> ----- Original Message -----
> From: "Ted Husted" <hu...@apache.org>
> To: <st...@jakarta.apache.org>
> Sent: Saturday, June 16, 2001 12:38 PM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > Jonathan wrote:
> > > I also think that the easier it is for first timers to understand
> > > Struts and how it works, the more likely you will have committed users
> and
> > > thus more feedback and thus better development.
> >
> > I have been meaning to try refactoring the installation page so that it
> > starts with the binary distribution, and encourages trying the Struts
> > sample WARs first. Starting out with the prerequisites for buildling
> > Struts seems daunting.
> >
> > Jonathan wrote:
> > > Also, I think most of the explanations in available tutorials on the net
> are
> > > not clear.
> >
> > Then go for it. Scratch what itches * you * the most.
> >
>
>
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
ok. Should I send MS word drafts to the dev list for review?
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 12:38 PM
Subject: Re: I would like to offer myself to help with documentation
> Jonathan wrote:
> > I also think that the easier it is for first timers to understand
> > Struts and how it works, the more likely you will have committed users
and
> > thus more feedback and thus better development.
>
> I have been meaning to try refactoring the installation page so that it
> starts with the binary distribution, and encourages trying the Struts
> sample WARs first. Starting out with the prerequisites for buildling
> Struts seems daunting.
>
> Jonathan wrote:
> > Also, I think most of the explanations in available tutorials on the net
are
> > not clear.
>
> Then go for it. Scratch what itches * you * the most.
>
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
Jonathan wrote:
> I also think that the easier it is for first timers to understand
> Struts and how it works, the more likely you will have committed users and
> thus more feedback and thus better development.
I have been meaning to try refactoring the installation page so that it
starts with the binary distribution, and encourages trying the Struts
sample WARs first. Starting out with the prerequisites for buildling
Struts seems daunting.
Jonathan wrote:
> Also, I think most of the explanations in available tutorials on the net are
> not clear.
Then go for it. Scratch what itches * you * the most.
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
Really what ever is appropriate is fine. As long as you know in advance
that I will be posting these questions through the process. I think the
best place to start is where you feel documentation is needed most right
now. I also think that the easier it is for first timers to understand
Struts and how it works, the more likely you will have committed users and
thus more feedback and thus better development. I also think we you all
need to package a war file in which System.outs can be generated in a clear
way to demonstrate the steps Struts goes through from request to response.
That helps users understand visually as well as with the documentation. I
know you have debug level output but they dont go method to method for EACH
AND EVERY METHOD. Obviously this is not the war file to be developing with,
but would be excellent to study Struts.
Aside from that I think that Documentation can be done on a piece by
piece basis.
What do you think?
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 11:40 AM
Subject: Re: I would like to offer myself to help with documentation
> Personally, I don't think that your questions would "clutter up" the
> list. If you don't understand it, then it's (very) likely that many
> others do not either. Moreover, the developer's list is intended for
> discussions about developing and packaging struts, and it * is * the
> appropriate place to post questions about drafting documentation.
>
> Are you talking about refactoring the current Users Guide, adding
> additional chapters, like maybe a tutorial, or starting with a clean
> slate?
>
> Any known documentation issues should be logged in bugzilla, which would
> include enhancement requests.
>
> < http://nagoya.apache.org/bugzilla/ >
>
> I've been working on some additional material, like Strut by Strut and
> the kickstart FAQ (see husted.com/about/struts). The first part of the
> FAQ is really done, and I put in under the Jakarta FAQ-o-Matic (but I
> see that it's down again (sigh) -- anyone what to propose an alternative
> here? It's an embarrasment.)
>
> I'm also about ready to release a major update to Strut by Strut, but
> I'm not sure whether to propose that for the package or leave it as a
> Resource.
>
> There was also an update to the Resource page, which includes a number
> of recent 3rd party tutorials and articles, but was inadvertently left
> out of yesterday's 1.0. See
>
> < http://husted.com/about/struts/resources.html >
>
> for a copy of what I just added to 1.1.
>
> -- Ted Husted, Husted dot Com, Fairport NY USA.
> -- Custom Software ~ Technical Services.
> -- Tel 716 737-3463.
> -- http://www.husted.com/about/struts/
>
> Jonathan wrote:
> >
> > Hello all.
> > It seems that there is a back log of documentation to do and I would
like to
> > offer to help with it as I am very good at explaining things. It also
helps
> > me understand the framework in a deeper way. However, because I am
still
> > relatively green with Struts (3 months) I will need to correspond with
some
> > of you outside of the list to get questions answered (I dont want to
clutter
> > up the list with these questions). I can complete sections according to
> > when you want them, or I can do it in the order I want.
> >
> > If this is ok with you all and you are interested, please send me an
email
> > at mailto:jasbell@i-2000.com
> >
> > Let us all salute the Sixers on their valiant effort last night
>
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
Also, I think most of the explanations in available tutorials on the net are
not clear.
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 11:40 AM
Subject: Re: I would like to offer myself to help with documentation
> Personally, I don't think that your questions would "clutter up" the
> list. If you don't understand it, then it's (very) likely that many
> others do not either. Moreover, the developer's list is intended for
> discussions about developing and packaging struts, and it * is * the
> appropriate place to post questions about drafting documentation.
>
> Are you talking about refactoring the current Users Guide, adding
> additional chapters, like maybe a tutorial, or starting with a clean
> slate?
>
> Any known documentation issues should be logged in bugzilla, which would
> include enhancement requests.
>
> < http://nagoya.apache.org/bugzilla/ >
>
> I've been working on some additional material, like Strut by Strut and
> the kickstart FAQ (see husted.com/about/struts). The first part of the
> FAQ is really done, and I put in under the Jakarta FAQ-o-Matic (but I
> see that it's down again (sigh) -- anyone what to propose an alternative
> here? It's an embarrasment.)
>
> I'm also about ready to release a major update to Strut by Strut, but
> I'm not sure whether to propose that for the package or leave it as a
> Resource.
>
> There was also an update to the Resource page, which includes a number
> of recent 3rd party tutorials and articles, but was inadvertently left
> out of yesterday's 1.0. See
>
> < http://husted.com/about/struts/resources.html >
>
> for a copy of what I just added to 1.1.
>
> -- Ted Husted, Husted dot Com, Fairport NY USA.
> -- Custom Software ~ Technical Services.
> -- Tel 716 737-3463.
> -- http://www.husted.com/about/struts/
>
> Jonathan wrote:
> >
> > Hello all.
> > It seems that there is a back log of documentation to do and I would
like to
> > offer to help with it as I am very good at explaining things. It also
helps
> > me understand the framework in a deeper way. However, because I am
still
> > relatively green with Struts (3 months) I will need to correspond with
some
> > of you outside of the list to get questions answered (I dont want to
clutter
> > up the list with these questions). I can complete sections according to
> > when you want them, or I can do it in the order I want.
> >
> > If this is ok with you all and you are interested, please send me an
email
> > at mailto:jasbell@i-2000.com
> >
> > Let us all salute the Sixers on their valiant effort last night
>
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
Personally, I don't think that your questions would "clutter up" the
list. If you don't understand it, then it's (very) likely that many
others do not either. Moreover, the developer's list is intended for
discussions about developing and packaging struts, and it * is * the
appropriate place to post questions about drafting documentation.
Are you talking about refactoring the current Users Guide, adding
additional chapters, like maybe a tutorial, or starting with a clean
slate?
Any known documentation issues should be logged in bugzilla, which would
include enhancement requests.
< http://nagoya.apache.org/bugzilla/ >
I've been working on some additional material, like Strut by Strut and
the kickstart FAQ (see husted.com/about/struts). The first part of the
FAQ is really done, and I put in under the Jakarta FAQ-o-Matic (but I
see that it's down again (sigh) -- anyone what to propose an alternative
here? It's an embarrasment.)
I'm also about ready to release a major update to Strut by Strut, but
I'm not sure whether to propose that for the package or leave it as a
Resource.
There was also an update to the Resource page, which includes a number
of recent 3rd party tutorials and articles, but was inadvertently left
out of yesterday's 1.0. See
< http://husted.com/about/struts/resources.html >
for a copy of what I just added to 1.1.
-- Ted Husted, Husted dot Com, Fairport NY USA.
-- Custom Software ~ Technical Services.
-- Tel 716 737-3463.
-- http://www.husted.com/about/struts/
Jonathan wrote:
>
> Hello all.
> It seems that there is a back log of documentation to do and I would like to
> offer to help with it as I am very good at explaining things. It also helps
> me understand the framework in a deeper way. However, because I am still
> relatively green with Struts (3 months) I will need to correspond with some
> of you outside of the list to get questions answered (I dont want to clutter
> up the list with these questions). I can complete sections according to
> when you want them, or I can do it in the order I want.
>
> If this is ok with you all and you are interested, please send me an email
> at mailto:jasbell@i-2000.com
>
> Let us all salute the Sixers on their valiant effort last night
Re: I would like to offer myself to help with documentation
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sat, 16 Jun 2001, Alan C. Yackel wrote:
>
> Along with the same for setting up the ActionServlet in the web.xml.
>
See the Javadocs for org.apache.struts.action.ActionServlet. They are all
described in the class documentation.
> Alan Yackel
> Creatrixs INC.
>
Craig
Re: The documentation, xml, and stylesheets
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Mon, 18 Jun 2001, Barry Glasco wrote:
> You are a Jack Ass! That is the most technical way
> I could think of putting it.
>
Disagreements over technologies need not devolve into personal
attacks. One of the refreshing things about the Struts community has been
the relative absence of stuff like this. Let's keep it that way, and
avoid this kind of comment on the mailing lists.
Craig
Re: The documentation, xml, and stylesheets
Posted by Barry Glasco <bg...@silverhosting.com>.
You are a Jack Ass! That is the most technical way
I could think of putting it.
Later
----- Original Message -----
From: "Michael Westbay" <we...@seaple.icc.ne.jp>
To: <st...@jakarta.apache.org>
Sent: Monday, June 18, 2001 8:27 PM
Subject: Re: The documentation, xml, and stylesheets
> Asbell-san wrote:
>
> > Mike, I am forced to work with xslt every day, [...]
>
> It sounds to me like you're one of those many people who majored in
something
> that had nothing to do with computers, then found yourself in the IT
field.
> I was a Computer Science major. I taught myself HTML, XML, SGML, XSL, and
> the rest of the alphabet soup in my own time after work simply because I
> found them fascinating.
>
> > [...] and each day I find a new
> > reason to say "what in the WORLD do people see in this?!". It has its
> > place in changing from schema to schema, but who want to get so deep
into a
> > technology which is very hard to control, and in complex schemas
consumes
> > more effort than it is worth to get what you want out of it.
>
> Let me venture another guess. You're working primarily with poorly
> documented and or thought out DTDs that are ever changing as more
> functionality is desired, leaving you to constantly update the style sheet
> transforms to satisfy the whims of your boss.
>
> First of all, getting in deep with the technology gives one a better
> understanding of it. I started learning HTML in 1995 armed with Mosaic
and
> my trusty vi editor. GUIs are nice, but IMHO, they separate the creator
from
> the underlying technologies too much. I'd rather know what's going on
under
> the hood. Why does a page render the way it does. Getting a good
> fundamental knowledge of the low level technologies allows me to spot and
fix
> problems quickly. It also allows for better efficiency when using the
> technologies.
>
> With a better understanding, the technologies are not hard to control. A
> well written schema, even a very complex one (like DocBook) is well worth
the
> effort of getting a good understanding of the underlying technologies.
>
> As Winterfeldt-san pointed out, the whole XML/XSL bit it may be overkill
for
> a few scattered unrelated documents. But when the documentation starts
> increasing, a well thought out schema for allowing flexible access to what
> would be a mountian load of dead trees saves a great deal in the long run.
>
> I don't know if my evengilism of a technology can change your mind. We
> obviously have very different backgrounds (I was the only one in my
English
> classes to turn in papers written in LaTeX [edited in vi, of course] -
> everyone else used WordPerfect or [gasp!] a typewriter). And our jobs
seem
> to give different levels of satisfaction: I'd study this stuff on my own
if
> I didn't get to work with it anyway, whereas you're "forced to work with
xslt
> every day."
>
> I think it's great that you're volunteering to help with the
documentation.
> But I also think it's strange that you hadn't gone through what is there
and
> seen how it is generated from XML via XSLT. I would have expected some
sort
> of professional curiosity as to how others deal with documentation issues,
> since that seems to be your line of work. But then, maybe it's me
applying
> my own drive to learn more ways of doing things to improve my own skills
and
> the way I do my job. (Sorry, I forget sometimes that not everyone takes a
> job in the tech field by choice.)
>
> --
> Michael Westbay
> Work: Beacon-IT http://www.beacon-it.co.jp/
> Home: http://www.seaple.icc.ne.jp/~westbay
> Commentary: http://www.japanesebaseball.com/
>
>
Re: The documentation, xml, and stylesheets
Posted by Jonathan Asbell <ja...@i-2000.com>.
I am at a loss as to how to respond to this.....
You obviously work alone
----- Original Message -----
From: "Michael Westbay" <we...@seaple.icc.ne.jp>
To: <st...@jakarta.apache.org>
Sent: Monday, June 18, 2001 8:27 PM
Subject: Re: The documentation, xml, and stylesheets
> Asbell-san wrote:
>
> > Mike, I am forced to work with xslt every day, [...]
>
> It sounds to me like you're one of those many people who majored in
something
> that had nothing to do with computers, then found yourself in the IT
field.
> I was a Computer Science major. I taught myself HTML, XML, SGML, XSL, and
> the rest of the alphabet soup in my own time after work simply because I
> found them fascinating.
>
> > [...] and each day I find a new
> > reason to say "what in the WORLD do people see in this?!". It has its
> > place in changing from schema to schema, but who want to get so deep
into a
> > technology which is very hard to control, and in complex schemas
consumes
> > more effort than it is worth to get what you want out of it.
>
> Let me venture another guess. You're working primarily with poorly
> documented and or thought out DTDs that are ever changing as more
> functionality is desired, leaving you to constantly update the style sheet
> transforms to satisfy the whims of your boss.
>
> First of all, getting in deep with the technology gives one a better
> understanding of it. I started learning HTML in 1995 armed with Mosaic
and
> my trusty vi editor. GUIs are nice, but IMHO, they separate the creator
from
> the underlying technologies too much. I'd rather know what's going on
under
> the hood. Why does a page render the way it does. Getting a good
> fundamental knowledge of the low level technologies allows me to spot and
fix
> problems quickly. It also allows for better efficiency when using the
> technologies.
>
> With a better understanding, the technologies are not hard to control. A
> well written schema, even a very complex one (like DocBook) is well worth
the
> effort of getting a good understanding of the underlying technologies.
>
> As Winterfeldt-san pointed out, the whole XML/XSL bit it may be overkill
for
> a few scattered unrelated documents. But when the documentation starts
> increasing, a well thought out schema for allowing flexible access to what
> would be a mountian load of dead trees saves a great deal in the long run.
>
> I don't know if my evengilism of a technology can change your mind. We
> obviously have very different backgrounds (I was the only one in my
English
> classes to turn in papers written in LaTeX [edited in vi, of course] -
> everyone else used WordPerfect or [gasp!] a typewriter). And our jobs
seem
> to give different levels of satisfaction: I'd study this stuff on my own
if
> I didn't get to work with it anyway, whereas you're "forced to work with
xslt
> every day."
>
> I think it's great that you're volunteering to help with the
documentation.
> But I also think it's strange that you hadn't gone through what is there
and
> seen how it is generated from XML via XSLT. I would have expected some
sort
> of professional curiosity as to how others deal with documentation issues,
> since that seems to be your line of work. But then, maybe it's me
applying
> my own drive to learn more ways of doing things to improve my own skills
and
> the way I do my job. (Sorry, I forget sometimes that not everyone takes a
> job in the tech field by choice.)
>
> --
> Michael Westbay
> Work: Beacon-IT http://www.beacon-it.co.jp/
> Home: http://www.seaple.icc.ne.jp/~westbay
> Commentary: http://www.japanesebaseball.com/
>
Re: The documentation, xml, and stylesheets
Posted by Michael Westbay <we...@seaple.icc.ne.jp>.
Asbell-san wrote:
> Mike, I am forced to work with xslt every day, [...]
It sounds to me like you're one of those many people who majored in something
that had nothing to do with computers, then found yourself in the IT field.
I was a Computer Science major. I taught myself HTML, XML, SGML, XSL, and
the rest of the alphabet soup in my own time after work simply because I
found them fascinating.
> [...] and each day I find a new
> reason to say "what in the WORLD do people see in this?!". It has its
> place in changing from schema to schema, but who want to get so deep into a
> technology which is very hard to control, and in complex schemas consumes
> more effort than it is worth to get what you want out of it.
Let me venture another guess. You're working primarily with poorly
documented and or thought out DTDs that are ever changing as more
functionality is desired, leaving you to constantly update the style sheet
transforms to satisfy the whims of your boss.
First of all, getting in deep with the technology gives one a better
understanding of it. I started learning HTML in 1995 armed with Mosaic and
my trusty vi editor. GUIs are nice, but IMHO, they separate the creator from
the underlying technologies too much. I'd rather know what's going on under
the hood. Why does a page render the way it does. Getting a good
fundamental knowledge of the low level technologies allows me to spot and fix
problems quickly. It also allows for better efficiency when using the
technologies.
With a better understanding, the technologies are not hard to control. A
well written schema, even a very complex one (like DocBook) is well worth the
effort of getting a good understanding of the underlying technologies.
As Winterfeldt-san pointed out, the whole XML/XSL bit it may be overkill for
a few scattered unrelated documents. But when the documentation starts
increasing, a well thought out schema for allowing flexible access to what
would be a mountian load of dead trees saves a great deal in the long run.
I don't know if my evengilism of a technology can change your mind. We
obviously have very different backgrounds (I was the only one in my English
classes to turn in papers written in LaTeX [edited in vi, of course] -
everyone else used WordPerfect or [gasp!] a typewriter). And our jobs seem
to give different levels of satisfaction: I'd study this stuff on my own if
I didn't get to work with it anyway, whereas you're "forced to work with xslt
every day."
I think it's great that you're volunteering to help with the documentation.
But I also think it's strange that you hadn't gone through what is there and
seen how it is generated from XML via XSLT. I would have expected some sort
of professional curiosity as to how others deal with documentation issues,
since that seems to be your line of work. But then, maybe it's me applying
my own drive to learn more ways of doing things to improve my own skills and
the way I do my job. (Sorry, I forget sometimes that not everyone takes a
job in the tech field by choice.)
--
Michael Westbay
Work: Beacon-IT http://www.beacon-it.co.jp/
Home: http://www.seaple.icc.ne.jp/~westbay
Commentary: http://www.japanesebaseball.com/
Re: The documentation, xml, and stylesheets
Posted by David Winterfeldt <dw...@yahoo.com>.
I think it is a matter of planning for the future.
Changing 10 pages of HTML may not be a big deal or
even a hundred, but as the site's documentation keeps
expanding it's easier to keep the documentation in XML
so Struts and other Jakarta projects can easily be
reformatted and released with a new look and feel with
minimal effort. Maybe there will be a version of the
site for hand held devices one day. With everything
in XML it would be feasible to do something like this.
I would just work on it in plain text as Ted
suggested so you can get something together without
being distracted and then worry about adding the tags.
David
--- Jonathan Asbell <ja...@i-2000.com> wrote:
> Mike, I am forced to work with xslt every day, and
> each day I find a new
> reason to say "what in the WORLD do people see in
> this?!". It has its place
> in changing from schema to scema, but who want to
> get so deep into a
> technology which is very hard to control, and in
> complex schemas consumes
> more effort than it is worth to get what you want
> out of it.
>
> ----- Original Message -----
> From: "Michael Westbay" <we...@seaple.icc.ne.jp>
> To: <st...@jakarta.apache.org>
> Sent: Sunday, June 17, 2001 7:45 PM
> Subject: Re: The documentation, xml, and stylesheets
>
>
> > Jonathan-san wrote:
> >
> > > Yea, but now I will have to learn the dtd and
> create complex
> stylesheets.
> > > Gentlemen. if I may be frank, this is an
> excercise in technical
> > > masturbation. If I ever want to redo it
> all.....than I will.
> Stylesheets
> > > do not help, and those that have had to use them
> know exactly what I am
> > > talking about.
> >
> > I use them. And the more I use them, the more I
> like them. Just look at
> the
> > power behind the current Struts' documentation
> xml, namely DTD and the
> user
> > manuals for the tags get generated from a single
> XML file. The next
> logical
> > step is to have that XML file generated from
> JavaDoc, so that if the
> > specification of a tag changes, the change can
> easily be reflected in the
> DTD
> > and manual without having to edit external
> documents.
> >
> > I'm currently looking at the idea of creating
> pages in XML that generate
> JSP
> > pages (with Struts tags among others) and help
> HTML files. The help files
> > can also be processed with FOP for a PDF manual.
> One source, multiple
> > integrated, cross referenced outputs.
> >
> > No, it isn't easy. But for building a complex
> system where source and
> > documentation may be managed together, it's a very
> powerful tool.
> >
> > MS Word attachments and mail in HTML format (70%
> of the spam I recieve)
> get
> > filtered to /dev/null. I won't touch them. (Why
> does Outlook's HTML
> > messages take up to 32 times the plain text size?)
> In fact, lot of
> messages
> > got filtered the past couple of weeks since. Even
> though most of you have
> > HTML mail turned off, Outlook assumes that when
> replying to an HTML
> message,
> > you want to send in HTML format, too. Judging
> form the headers in my spam
> > log, I belive that Mozilla is equally guilty, so
> I'm not just picking on
> MS.
> >
> > Should proper mail netiquitte be included on the
> mail subscription page?
> The
> > FAQ that comes periodically in the DocBook mailing
> list spells out proper
> > quoting technique (snip-quote-reply) rather
> nicely, and establishes
> policies
> > for attachments and cross posting.
> >
> > --
> > Michael Westbay
> > Work: Beacon-IT http://www.beacon-it.co.jp/
> > Home:
> http://www.seaple.icc.ne.jp/~westbay
> > Commentary: http://www.japanesebaseball.com/
> >
>
__________________________________________________
Do You Yahoo!?
Spot the hottest trends in music, movies, and more.
http://buzz.yahoo.com/
Re: The documentation, xml, and stylesheets
Posted by Jonathan Asbell <ja...@i-2000.com>.
Mike, I am forced to work with xslt every day, and each day I find a new
reason to say "what in the WORLD do people see in this?!". It has its place
in changing from schema to scema, but who want to get so deep into a
technology which is very hard to control, and in complex schemas consumes
more effort than it is worth to get what you want out of it.
----- Original Message -----
From: "Michael Westbay" <we...@seaple.icc.ne.jp>
To: <st...@jakarta.apache.org>
Sent: Sunday, June 17, 2001 7:45 PM
Subject: Re: The documentation, xml, and stylesheets
> Jonathan-san wrote:
>
> > Yea, but now I will have to learn the dtd and create complex
stylesheets.
> > Gentlemen. if I may be frank, this is an excercise in technical
> > masturbation. If I ever want to redo it all.....than I will.
Stylesheets
> > do not help, and those that have had to use them know exactly what I am
> > talking about.
>
> I use them. And the more I use them, the more I like them. Just look at
the
> power behind the current Struts' documentation xml, namely DTD and the
user
> manuals for the tags get generated from a single XML file. The next
logical
> step is to have that XML file generated from JavaDoc, so that if the
> specification of a tag changes, the change can easily be reflected in the
DTD
> and manual without having to edit external documents.
>
> I'm currently looking at the idea of creating pages in XML that generate
JSP
> pages (with Struts tags among others) and help HTML files. The help files
> can also be processed with FOP for a PDF manual. One source, multiple
> integrated, cross referenced outputs.
>
> No, it isn't easy. But for building a complex system where source and
> documentation may be managed together, it's a very powerful tool.
>
> MS Word attachments and mail in HTML format (70% of the spam I recieve)
get
> filtered to /dev/null. I won't touch them. (Why does Outlook's HTML
> messages take up to 32 times the plain text size?) In fact, lot of
messages
> got filtered the past couple of weeks since. Even though most of you have
> HTML mail turned off, Outlook assumes that when replying to an HTML
message,
> you want to send in HTML format, too. Judging form the headers in my spam
> log, I belive that Mozilla is equally guilty, so I'm not just picking on
MS.
>
> Should proper mail netiquitte be included on the mail subscription page?
The
> FAQ that comes periodically in the DocBook mailing list spells out proper
> quoting technique (snip-quote-reply) rather nicely, and establishes
policies
> for attachments and cross posting.
>
> --
> Michael Westbay
> Work: Beacon-IT http://www.beacon-it.co.jp/
> Home: http://www.seaple.icc.ne.jp/~westbay
> Commentary: http://www.japanesebaseball.com/
>
Re: The documentation, xml, and stylesheets
Posted by Michael Westbay <we...@seaple.icc.ne.jp>.
Jonathan-san wrote:
> Yea, but now I will have to learn the dtd and create complex stylesheets.
> Gentlemen. if I may be frank, this is an excercise in technical
> masturbation. If I ever want to redo it all.....than I will. Stylesheets
> do not help, and those that have had to use them know exactly what I am
> talking about.
I use them. And the more I use them, the more I like them. Just look at the
power behind the current Struts' documentation xml, namely DTD and the user
manuals for the tags get generated from a single XML file. The next logical
step is to have that XML file generated from JavaDoc, so that if the
specification of a tag changes, the change can easily be reflected in the DTD
and manual without having to edit external documents.
I'm currently looking at the idea of creating pages in XML that generate JSP
pages (with Struts tags among others) and help HTML files. The help files
can also be processed with FOP for a PDF manual. One source, multiple
integrated, cross referenced outputs.
No, it isn't easy. But for building a complex system where source and
documentation may be managed together, it's a very powerful tool.
MS Word attachments and mail in HTML format (70% of the spam I recieve) get
filtered to /dev/null. I won't touch them. (Why does Outlook's HTML
messages take up to 32 times the plain text size?) In fact, lot of messages
got filtered the past couple of weeks since. Even though most of you have
HTML mail turned off, Outlook assumes that when replying to an HTML message,
you want to send in HTML format, too. Judging form the headers in my spam
log, I belive that Mozilla is equally guilty, so I'm not just picking on MS.
Should proper mail netiquitte be included on the mail subscription page? The
FAQ that comes periodically in the DocBook mailing list spells out proper
quoting technique (snip-quote-reply) rather nicely, and establishes policies
for attachments and cross posting.
--
Michael Westbay
Work: Beacon-IT http://www.beacon-it.co.jp/
Home: http://www.seaple.icc.ne.jp/~westbay
Commentary: http://www.japanesebaseball.com/
Re[2]: I would like to offer myself to help with documentation
Posted by Oleg V Alexeev <go...@penza.net>.
Hello Ted,
+1
Good idea.
Thursday, June 21, 2001, 2:52:08 PM, you wrote:
TH> I like the idea of a "brochure-size" introduction to Struts, and a
TH> "quick-start" installation guide. I think this might make a useful
TH> preamble to the User Guide.
TH> My favorite part is where you say:
TH> "Your company has decided"
TH> I think this would make a nice focal point for an introduction. After
TH> all, the framework (like all applications) is really suppose to be
TH> solving a given set of problems. But right now we seems to assume that
TH> everyone knows what problems MVC is trying to solve, and go off from
TH> there.
TH> So, I'm thinking starting out with something like
TH> "Your Web team wants add a new section to the site" ...
TH> "Your team leader decides that Scriplets are a Bad Thing" ...
TH> "Your Web Application must be internationlized" ...
TH> "Your application must be accessible to everyone using anything from
TH> anywhere" ...
TH> "Your application must be J2EE compliant and make good use of Enterprise
TH> Beans" ...
TH> I could try refactoring the draft, if you agree.
TH> -Ted.
--
Best regards,
Oleg mailto:gonza@penza.net
Re: I would like to offer myself to help with documentation
Posted by Jonathan Asbell <ja...@i-2000.com>.
Sure Ted. Thanx. My perspective always comes from assuming that the reader
doesnt know much. People get confused and sidetracked with jargon, and
struts can be used by less experienced people if explained correctly. I
mean, dont we want the user base to grow so it can be developed better and
faster =)
We ant users to "get it".
We dont have to explain MVC as much as we have to explain them about
Struts. The sell is the framework and its capabilities. Lets talk to
people in street English so when their superiors want to know about it its
not too hard. After all, its the superiors who actually say yes or no to a
technology, and many are afraid (it took 2 months for the senior engineer at
my place to even LOOK at Struts, and he is no dummy)
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Thursday, June 21, 2001 6:52 AM
Subject: Re: I would like to offer myself to help with documentation
> I like the idea of a "brochure-size" introduction to Struts, and a
> "quick-start" installation guide. I think this might make a useful
> preamble to the User Guide.
>
> My favorite part is where you say:
>
> "Your company has decided"
>
> I think this would make a nice focal point for an introduction. After
> all, the framework (like all applications) is really suppose to be
> solving a given set of problems. But right now we seems to assume that
> everyone knows what problems MVC is trying to solve, and go off from
> there.
>
> So, I'm thinking starting out with something like
>
> "Your Web team wants add a new section to the site" ...
>
> "Your team leader decides that Scriplets are a Bad Thing" ...
>
> "Your Web Application must be internationlized" ...
>
> "Your application must be accessible to everyone using anything from
> anywhere" ...
>
> "Your application must be J2EE compliant and make good use of Enterprise
> Beans" ...
>
> I could try refactoring the draft, if you agree.
>
> -Ted.
>
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
I like the idea of a "brochure-size" introduction to Struts, and a
"quick-start" installation guide. I think this might make a useful
preamble to the User Guide.
My favorite part is where you say:
"Your company has decided"
I think this would make a nice focal point for an introduction. After
all, the framework (like all applications) is really suppose to be
solving a given set of problems. But right now we seems to assume that
everyone knows what problems MVC is trying to solve, and go off from
there.
So, I'm thinking starting out with something like
"Your Web team wants add a new section to the site" ...
"Your team leader decides that Scriplets are a Bad Thing" ...
"Your Web Application must be internationlized" ...
"Your application must be accessible to everyone using anything from
anywhere" ...
"Your application must be J2EE compliant and make good use of Enterprise
Beans" ...
I could try refactoring the draft, if you agree.
-Ted.
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
Absolutely everything is in the source download, under /doc
Jonathan Asbell wrote:
>
> does someone have an example they can shoot to me of the xml and xsl used in
> documentation.
Can someone resend the file I sent this morning
Posted by Jonathan <ja...@i-2000.com>.
For some reason I did not receive at work the file I sent this morning
called struts_doc.html.
Can someone repost it to the list or resend it to me.
jasbell@i-2000.com
Re: I would like to offer myself to help with documentation
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Mon, 18 Jun 2001, Jonathan Asbell wrote:
> does someone have an example they can shoot to me of the xml and xsl used in
> documentation.
>
All of the docs in the Struts Documentation application (which is also the
contents of the Struts web site) are generated this way. In addition, the
build process creates all of the Struts TLD files from the same XML input
that the tag library reference docs are created from (so you only have to
make one change when new tags or attributes are added).
If you download the source distribution, and run the "dist" target, the
docs will be built. The particular commands are in the
"build-webapps.xml" script -- look for places where Ant's <style> tag is
used.
Craig
> ----- Original Message -----
> From: "Ted Husted" <hu...@apache.org>
> To: <st...@jakarta.apache.org>
> Sent: Sunday, June 17, 2001 6:05 AM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > Jonathan wrote:
> > > It would be nice if it was just simple. Stylesheets are not. Why dont
> we
> > > just use html
> >
> > Half the time, I think just to make my life more difficult ;-)
> >
> > The other half, I think so that we can
> >
> > * Ensure formatting consistency,
> > * Change the look without editing the content,
> > * Generate navigational constructs (though we could use more of this),
> > * and, practice what we preach.
> >
> > Most, if not all, of the Jakarta sub-project Web sites are based on XML.
> >
> > Personally, I believe there's a desperate need for more XML editing
> > tools. Everyone please keep posting any XML links you find here, and
> > I'll start a list.
> >
> >
> > -- Ted Husted, Husted dot Com, Fairport NY USA.
> > -- Custom Software ~ Technical Services.
> > -- Tel 716 737-3463.
> > -- http://www.husted.com/about/struts/
> >
>
>
Re: I would like to offer myself to help with documentation
Posted by Jonathan Asbell <ja...@i-2000.com>.
does someone have an example they can shoot to me of the xml and xsl used in
documentation.
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Sunday, June 17, 2001 6:05 AM
Subject: Re: I would like to offer myself to help with documentation
> Jonathan wrote:
> > It would be nice if it was just simple. Stylesheets are not. Why dont
we
> > just use html
>
> Half the time, I think just to make my life more difficult ;-)
>
> The other half, I think so that we can
>
> * Ensure formatting consistency,
> * Change the look without editing the content,
> * Generate navigational constructs (though we could use more of this),
> * and, practice what we preach.
>
> Most, if not all, of the Jakarta sub-project Web sites are based on XML.
>
> Personally, I believe there's a desperate need for more XML editing
> tools. Everyone please keep posting any XML links you find here, and
> I'll start a list.
>
>
> -- Ted Husted, Husted dot Com, Fairport NY USA.
> -- Custom Software ~ Technical Services.
> -- Tel 716 737-3463.
> -- http://www.husted.com/about/struts/
>
Re: The documentation, xml, and stylesheets
Posted by Ted Husted <hu...@apache.org>.
This is true. The styles we are using now are minimalistic, and you
probably won't need to refer to the stylesheet at all. Just monkey
what's already there ;-). The only real pain is that the XML needs to
compile properly, and if I try it by hand it usualy takes a few tries.
Tools that check the XML syntax beforehand are very helpful. I've tried
XML Writer, which was very good, but would like to try some others as
well (like XML cookbook).
Personally, I start things as plain text (in my editor) until I get near
the final draft, and then add the mark up at the end.
Martin Cooper wrote:
>
> You probably won't have to do much, if anything, with stylesheets unless you
> need to break away from the documentation style currently used by Struts.
> The stylesheets for that, obviously, are already in place, and you don't
> have to look at them if you don't want to. :-)
>
> --
> Martin Cooper
Re: The documentation, xml, and stylesheets
Posted by Martin Cooper <ma...@tumbleweed.com>.
You probably won't have to do much, if anything, with stylesheets unless you
need to break away from the documentation style currently used by Struts.
The stylesheets for that, obviously, are already in place, and you don't
have to look at them if you don't want to. :-)
--
Martin Cooper
----- Original Message -----
From: "Jonathan" <ja...@i-2000.com>
To: <st...@jakarta.apache.org>
Sent: Sunday, June 17, 2001 2:57 PM
Subject: The documentation, xml, and stylesheets
> Yea, but now I will have to learn the dtd and create complex stylesheets.
> Gentlemen. if I may be frank, this is an excercise in technical
> masturbation. If I ever want to redo it all.....than I will. Stylesheets
do
> not help, and those that have had to use them know exactly what I am
talking
> about.
>
> ----- Original Message -----
> From: "Ted Husted" <hu...@apache.org>
> To: <st...@jakarta.apache.org>
> Sent: Sunday, June 17, 2001 6:05 AM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > Jonathan wrote:
> > > It would be nice if it was just simple. Stylesheets are not. Why
dont
> we
> > > just use html
> >
> > Half the time, I think just to make my life more difficult ;-)
> >
> > The other half, I think so that we can
> >
> > * Ensure formatting consistency,
> > * Change the look without editing the content,
> > * Generate navigational constructs (though we could use more of this),
> > * and, practice what we preach.
> >
> > Most, if not all, of the Jakarta sub-project Web sites are based on XML.
> >
> > Personally, I believe there's a desperate need for more XML editing
> > tools. Everyone please keep posting any XML links you find here, and
> > I'll start a list.
> >
> >
> > -- Ted Husted, Husted dot Com, Fairport NY USA.
> > -- Custom Software ~ Technical Services.
> > -- Tel 716 737-3463.
> > -- http://www.husted.com/about/struts/
> >
>
Re: The documentation, xml, and stylesheets
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sun, 17 Jun 2001, Jonathan wrote:
> Yea, but now I will have to learn the dtd and create complex stylesheets.
> Gentlemen. if I may be frank, this is an excercise in technical
> masturbation. If I ever want to redo it all.....than I will. Stylesheets do
> not help, and those that have had to use them know exactly what I am talking
> about.
>
Nevertheless, XML that is converted to HTML is the standard for Struts
documentation that is included with Struts. I'm not personally at all
interested in alternatives at the moment.
Craig
> ----- Original Message -----
> From: "Ted Husted" <hu...@apache.org>
> To: <st...@jakarta.apache.org>
> Sent: Sunday, June 17, 2001 6:05 AM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> > Jonathan wrote:
> > > It would be nice if it was just simple. Stylesheets are not. Why dont
> we
> > > just use html
> >
> > Half the time, I think just to make my life more difficult ;-)
> >
> > The other half, I think so that we can
> >
> > * Ensure formatting consistency,
> > * Change the look without editing the content,
> > * Generate navigational constructs (though we could use more of this),
> > * and, practice what we preach.
> >
> > Most, if not all, of the Jakarta sub-project Web sites are based on XML.
> >
> > Personally, I believe there's a desperate need for more XML editing
> > tools. Everyone please keep posting any XML links you find here, and
> > I'll start a list.
> >
> >
> > -- Ted Husted, Husted dot Com, Fairport NY USA.
> > -- Custom Software ~ Technical Services.
> > -- Tel 716 737-3463.
> > -- http://www.husted.com/about/struts/
> >
>
>
The documentation, xml, and stylesheets
Posted by Jonathan <ja...@i-2000.com>.
Yea, but now I will have to learn the dtd and create complex stylesheets.
Gentlemen. if I may be frank, this is an excercise in technical
masturbation. If I ever want to redo it all.....than I will. Stylesheets do
not help, and those that have had to use them know exactly what I am talking
about.
----- Original Message -----
From: "Ted Husted" <hu...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Sunday, June 17, 2001 6:05 AM
Subject: Re: I would like to offer myself to help with documentation
> Jonathan wrote:
> > It would be nice if it was just simple. Stylesheets are not. Why dont
we
> > just use html
>
> Half the time, I think just to make my life more difficult ;-)
>
> The other half, I think so that we can
>
> * Ensure formatting consistency,
> * Change the look without editing the content,
> * Generate navigational constructs (though we could use more of this),
> * and, practice what we preach.
>
> Most, if not all, of the Jakarta sub-project Web sites are based on XML.
>
> Personally, I believe there's a desperate need for more XML editing
> tools. Everyone please keep posting any XML links you find here, and
> I'll start a list.
>
>
> -- Ted Husted, Husted dot Com, Fairport NY USA.
> -- Custom Software ~ Technical Services.
> -- Tel 716 737-3463.
> -- http://www.husted.com/about/struts/
>
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
Jonathan wrote:
> It would be nice if it was just simple. Stylesheets are not. Why dont we
> just use html
Half the time, I think just to make my life more difficult ;-)
The other half, I think so that we can
* Ensure formatting consistency,
* Change the look without editing the content,
* Generate navigational constructs (though we could use more of this),
* and, practice what we preach.
Most, if not all, of the Jakarta sub-project Web sites are based on XML.
Personally, I believe there's a desperate need for more XML editing
tools. Everyone please keep posting any XML links you find here, and
I'll start a list.
-- Ted Husted, Husted dot Com, Fairport NY USA.
-- Custom Software ~ Technical Services.
-- Tel 716 737-3463.
-- http://www.husted.com/about/struts/
Re: I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
It would be nice if it was just simple. Stylesheets are not. Why dont we
just use html
----- Original Message -----
From: "Alan C. Yackel" <al...@creatrixs.com>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 7:31 PM
Subject: Re: I would like to offer myself to help with documentation
> "Craig R. McClanahan" wrote:
>
> > On Sat, 16 Jun 2001, Alan C. Yackel wrote:
> >
> > >
> > > Another nice item would be more info on the XMLs. I've had to go
> > > through the DTD files before to figure out what some attributes do.
> > > A detailed description of all tags and attributes for the
> > > struts-config.xml would be great. Along with the same for setting up
> > > the ActionServlet in the web.xml.
> > >
> >
> > Are these not documented in struts-config_1_0.dtd itself? There are
> > pretty copious comments there about what is allowed.
> >
> > > Alan Yackel
> > > Creatrixs INC.
> > >
> >
> > Craig
>
> They are. That's where I looked to figure out what attributes to use. My
point is
> that in the User's Guide these tags are discussed, but only about half of
the
> attributes are defined for what they do. It would be nice if they were
all defined
> and explained why you'd use them in one easy to read document. The DTD is
self
> documenting, but I was thinking more along the lines of the User's Guide.
>
> Alan
>
Re: I would like to offer myself to help with documentation
Posted by "Alan C. Yackel" <al...@creatrixs.com>.
"Craig R. McClanahan" wrote:
> On Sat, 16 Jun 2001, Alan C. Yackel wrote:
>
> >
> > Another nice item would be more info on the XMLs. I've had to go
> > through the DTD files before to figure out what some attributes do.
> > A detailed description of all tags and attributes for the
> > struts-config.xml would be great. Along with the same for setting up
> > the ActionServlet in the web.xml.
> >
>
> Are these not documented in struts-config_1_0.dtd itself? There are
> pretty copious comments there about what is allowed.
>
> > Alan Yackel
> > Creatrixs INC.
> >
>
> Craig
They are. That's where I looked to figure out what attributes to use. My point is
that in the User's Guide these tags are discussed, but only about half of the
attributes are defined for what they do. It would be nice if they were all defined
and explained why you'd use them in one easy to read document. The DTD is self
documenting, but I was thinking more along the lines of the User's Guide.
Alan
Re: STRUTS Example with DAO
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sun, 17 Jun 2001, Michael Mok wrote:
> Hi Craig
>
> I have built 2 web applications with STRUTS and CASTOR JDO (one is a pilot,
> the other is now available on the web). CASTOR JDO provides intelligient DAO
> access to backend database.
>
> How can I help in your request for example?
>
> Regards
>
> Michael Mok
> www.webappcabaret.com/normad
>
>
Hi Michael,
The best characteristics for an example like this would be:
* Uses Struts :-).
* Demonstrates good design patterns for database-based
applications.
* Self-contained app big enough to be useful, small enough
to be understood after some study.
* Reasonably easy to set up on a developer's own environment
(among other things, that means we'd need to be as agnositic
about the actual database as possible, include a Java spp
to create all the tables and such, and things like that).
* Can be licensed under the Apache license and included
with Struts.
If you've got something like that, I'd be very interested in including it
in the Struts distribution.
Craig
STRUTS Example with DAO
Posted by Michael Mok <mo...@hotmail.com>.
Hi Craig
I have built 2 web applications with STRUTS and CASTOR JDO (one is a pilot,
the other is now available on the web). CASTOR JDO provides intelligient DAO
access to backend database.
How can I help in your request for example?
Regards
Michael Mok
www.webappcabaret.com/normad
Re: I would like to offer myself to help with documentation
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sat, 16 Jun 2001, Alan C. Yackel wrote:
> "Craig R. McClanahan" wrote:
>
> > On Sat, 16 Jun 2001, Jonathan wrote:
> >
> > > Hello all.
> > > It seems that there is a back log of documentation to do and I would like to
> > > offer to help with it as I am very good at explaining things. It also helps
> > > me understand the framework in a deeper way. However, because I am still
> > > relatively green with Struts (3 months) I will need to correspond with some
> > > of you outside of the list to get questions answered (I dont want to clutter
> > > up the list with these questions). I can complete sections according to
> > > when you want them, or I can do it in the order I want.
> > >
> >
> > Sounds great! This is a good place to talk about what the docs should
> > include.
> >
> > On my personal wish list:
> >
>
> Another nice item would be more info on the XMLs. I've had to go
> through the DTD files before to figure out what some attributes do.
> A detailed description of all tags and attributes for the
> struts-config.xml would be great. Along with the same for setting up
> the ActionServlet in the web.xml.
>
Are these not documented in struts-config_1_0.dtd itself? There are
pretty copious comments there about what is allowed.
> Alan Yackel
> Creatrixs INC.
>
Craig
Re: I would like to offer myself to help with documentation
Posted by "Alan C. Yackel" <al...@creatrixs.com>.
"Craig R. McClanahan" wrote:
> On Sat, 16 Jun 2001, Jonathan wrote:
>
> > Hello all.
> > It seems that there is a back log of documentation to do and I would like to
> > offer to help with it as I am very good at explaining things. It also helps
> > me understand the framework in a deeper way. However, because I am still
> > relatively green with Struts (3 months) I will need to correspond with some
> > of you outside of the list to get questions answered (I dont want to clutter
> > up the list with these questions). I can complete sections according to
> > when you want them, or I can do it in the order I want.
> >
>
> Sounds great! This is a good place to talk about what the docs should
> include.
>
> On my personal wish list:
>
Another nice item would be more info on the XMLs. I've had to go through the DTD
files before to figure out what some attributes do. A detailed description of
all tags and attributes for the struts-config.xml would be great. Along with the
same for setting up the ActionServlet in the web.xml.
Alan Yackel
Creatrixs INC.
>
> * High-quality UML diagrams covering all aspects of the architecture
> of Struts (especially sequence diagrams of how requests are handled).
> Anybody know some good+cheap tools for this purpose?
>
> * Tutorials (and example webapps) for a few common design idioms, such as
> a wizard-type multipage dialog. Although, maybe we ought to wait on
> this particular one if we're going to add pager-type tags.
>
> * Examples of extending the controller servlet to initialize your own
> application resources.
>
> * Examples that integrate some other commonly available tag libraries
> (such as those in jakarta-taglibs). However, I'm not personally a
> huge fan of using the DB tags, because it can encourage you to stray
> away from MVC :-).
>
> * Step-by-step how to construct a web app. Yes, this covers a lot of
> ground that is not Struts-specific, but this would clear up a lot of the
> complexity faced by new developers. A good starting point might be the
> "Application Developer's Guide" that ships with Tomcat (disclaimer: I
> wrote it, so don't be too hard on me :-).
>
> * Completed "package.html" files for the remaining packages (used as
> Developer's Guide links in the documentation).
>
> * A comprehensive example that uses Data Acess Objects to talk to a
> relational database. Ted's got some good starts here, but I'm thinking
> more about a "real" application -- perhaps something like the
> FAQ-O-MATIC idea, but written based on Struts?
>
> * A comprehensive example that uses EJBs to delegate business logic to
> session beans, and persistence logic to entity beans. Obviously not
> everyone will be able to run this, but you can at least look and see
> how such an app could be constructed.
>
> A couple of things to think about before we start writing docs that will
> be out of date quickly:
>
> * I'm planning to migrate to jakarta-commons versions of the shareable
> pieces of Struts that have migrated there, including: Bean Utils,
> Digester, DBCP (connection pool), Collections classes, and Message
> Resources. Docs are still welcome in all of these areas, but they
> should probably be done in jakarta-commons instead of here.
>
> * The JSP Standard Tag Library will have an early access version of their
> tags available in the near future. There will be some significant
> overlap with our tags in the struts-bean and struts-logic libraries,
> and an expression language for nested property access that will be
> similar to (but not identical) to ours. We'll want to think in the
> long run about making sure that Struts interoperates nicely with
> these tags. Because they will be standard, JSP page compilers will
> be able to generate optimized code for them.
>
> * A little further down the pike, the result of the JavaServer Faces
> (JSR-127) effort to create a standard GUI Component Model for web apps
> will be in early access. At that time, I'll want to build some app
> examples that use JSF as the user interface, but interact with the
> rest of the Struts framework. NOTE: I am on the expert group for
> JSR-127, so you can rest assured that the two technologies will play
> together nicely!
>
> > If this is ok with you all and you are interested, please send me an email
> > at mailto:jasbell@i-2000.com
> >
> > Let us all salute the Sixers on their valiant effort last night
> >
> >
> I was rooting for them (being from Portland and a Trail Blazers fan, you
> can imagine how I feel about the Lakers :-). Alas, it was a tremendous
> effort, but for naught ;-(.
>
> Craig
Re: I would like to offer myself to help with documentation
Posted by Ted Husted <hu...@apache.org>.
Broadening on the FAQ-o-MATIC idea, how about an extensible
documentation system? Something like a Wiki, but with editing
permissions. My favorite idea would be to take something like <
http://dmoz.org/ >, complete with the heirarchies of permissions for
editing, but be able to add pages at the end instead of just links. If
we could also add attachments to the pages, we'd also have a user
contributions area.
Ooops, back to Stargate ,,,
"Craig R. McClanahan" wrote:
> * A comprehensive example that uses Data Acess Objects to talk to a
> relational database. Ted's got some good starts here, but I'm thinking
> more about a "real" application -- perhaps something like the
> FAQ-O-MATIC idea, but written based on Struts?
Re: Documentation wish list repository
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Mon, 18 Jun 2001, Jonathan Asbell wrote:
> Hi Craig. Could we put together a repository of the documentation wish list
> items. It would be unreasonable for me to be searching through e-mails to
> do this
>
Definitely.
Adding a docs section to the TODO list for 1.1 seems like an appropriate
means to accumulate these. If people want to fire away the ideas they've
got so far, I'll add them to what Jonathan has already suggested and
commit it.
Craig
> ----- Original Message -----
> From: "Craig R. McClanahan" <cr...@apache.org>
> To: <st...@jakarta.apache.org>
> Sent: Saturday, June 16, 2001 5:12 PM
> Subject: Re: I would like to offer myself to help with documentation
>
>
> >
> >
> > On Sat, 16 Jun 2001, Jonathan wrote:
> >
> > > Hello all.
> > > It seems that there is a back log of documentation to do and I would
> like to
> > > offer to help with it as I am very good at explaining things. It also
> helps
> > > me understand the framework in a deeper way. However, because I am
> still
> > > relatively green with Struts (3 months) I will need to correspond with
> some
> > > of you outside of the list to get questions answered (I dont want to
> clutter
> > > up the list with these questions). I can complete sections according to
> > > when you want them, or I can do it in the order I want.
> > >
> >
> > Sounds great! This is a good place to talk about what the docs should
> > include.
> >
> > On my personal wish list:
> >
> > * High-quality UML diagrams covering all aspects of the architecture
> > of Struts (especially sequence diagrams of how requests are handled).
> > Anybody know some good+cheap tools for this purpose?
> >
> > * Tutorials (and example webapps) for a few common design idioms, such as
> > a wizard-type multipage dialog. Although, maybe we ought to wait on
> > this particular one if we're going to add pager-type tags.
> >
> > * Examples of extending the controller servlet to initialize your own
> > application resources.
> >
> > * Examples that integrate some other commonly available tag libraries
> > (such as those in jakarta-taglibs). However, I'm not personally a
> > huge fan of using the DB tags, because it can encourage you to stray
> > away from MVC :-).
> >
> > * Step-by-step how to construct a web app. Yes, this covers a lot of
> > ground that is not Struts-specific, but this would clear up a lot of the
> > complexity faced by new developers. A good starting point might be the
> > "Application Developer's Guide" that ships with Tomcat (disclaimer: I
> > wrote it, so don't be too hard on me :-).
> >
> > * Completed "package.html" files for the remaining packages (used as
> > Developer's Guide links in the documentation).
> >
> > * A comprehensive example that uses Data Acess Objects to talk to a
> > relational database. Ted's got some good starts here, but I'm thinking
> > more about a "real" application -- perhaps something like the
> > FAQ-O-MATIC idea, but written based on Struts?
> >
> > * A comprehensive example that uses EJBs to delegate business logic to
> > session beans, and persistence logic to entity beans. Obviously not
> > everyone will be able to run this, but you can at least look and see
> > how such an app could be constructed.
> >
> > A couple of things to think about before we start writing docs that will
> > be out of date quickly:
> >
> > * I'm planning to migrate to jakarta-commons versions of the shareable
> > pieces of Struts that have migrated there, including: Bean Utils,
> > Digester, DBCP (connection pool), Collections classes, and Message
> > Resources. Docs are still welcome in all of these areas, but they
> > should probably be done in jakarta-commons instead of here.
> >
> > * The JSP Standard Tag Library will have an early access version of their
> > tags available in the near future. There will be some significant
> > overlap with our tags in the struts-bean and struts-logic libraries,
> > and an expression language for nested property access that will be
> > similar to (but not identical) to ours. We'll want to think in the
> > long run about making sure that Struts interoperates nicely with
> > these tags. Because they will be standard, JSP page compilers will
> > be able to generate optimized code for them.
> >
> > * A little further down the pike, the result of the JavaServer Faces
> > (JSR-127) effort to create a standard GUI Component Model for web apps
> > will be in early access. At that time, I'll want to build some app
> > examples that use JSF as the user interface, but interact with the
> > rest of the Struts framework. NOTE: I am on the expert group for
> > JSR-127, so you can rest assured that the two technologies will play
> > together nicely!
> >
> > > If this is ok with you all and you are interested, please send me an
> email
> > > at mailto:jasbell@i-2000.com
> > >
> > > Let us all salute the Sixers on their valiant effort last night
> > >
> > >
> > I was rooting for them (being from Portland and a Trail Blazers fan, you
> > can imagine how I feel about the Lakers :-). Alas, it was a tremendous
> > effort, but for naught ;-(.
> >
> > Craig
> >
> >
>
>
Documentation wish list repository
Posted by Jonathan Asbell <ja...@i-2000.com>.
Hi Craig. Could we put together a repository of the documentation wish list
items. It would be unreasonable for me to be searching through e-mails to
do this
----- Original Message -----
From: "Craig R. McClanahan" <cr...@apache.org>
To: <st...@jakarta.apache.org>
Sent: Saturday, June 16, 2001 5:12 PM
Subject: Re: I would like to offer myself to help with documentation
>
>
> On Sat, 16 Jun 2001, Jonathan wrote:
>
> > Hello all.
> > It seems that there is a back log of documentation to do and I would
like to
> > offer to help with it as I am very good at explaining things. It also
helps
> > me understand the framework in a deeper way. However, because I am
still
> > relatively green with Struts (3 months) I will need to correspond with
some
> > of you outside of the list to get questions answered (I dont want to
clutter
> > up the list with these questions). I can complete sections according to
> > when you want them, or I can do it in the order I want.
> >
>
> Sounds great! This is a good place to talk about what the docs should
> include.
>
> On my personal wish list:
>
> * High-quality UML diagrams covering all aspects of the architecture
> of Struts (especially sequence diagrams of how requests are handled).
> Anybody know some good+cheap tools for this purpose?
>
> * Tutorials (and example webapps) for a few common design idioms, such as
> a wizard-type multipage dialog. Although, maybe we ought to wait on
> this particular one if we're going to add pager-type tags.
>
> * Examples of extending the controller servlet to initialize your own
> application resources.
>
> * Examples that integrate some other commonly available tag libraries
> (such as those in jakarta-taglibs). However, I'm not personally a
> huge fan of using the DB tags, because it can encourage you to stray
> away from MVC :-).
>
> * Step-by-step how to construct a web app. Yes, this covers a lot of
> ground that is not Struts-specific, but this would clear up a lot of the
> complexity faced by new developers. A good starting point might be the
> "Application Developer's Guide" that ships with Tomcat (disclaimer: I
> wrote it, so don't be too hard on me :-).
>
> * Completed "package.html" files for the remaining packages (used as
> Developer's Guide links in the documentation).
>
> * A comprehensive example that uses Data Acess Objects to talk to a
> relational database. Ted's got some good starts here, but I'm thinking
> more about a "real" application -- perhaps something like the
> FAQ-O-MATIC idea, but written based on Struts?
>
> * A comprehensive example that uses EJBs to delegate business logic to
> session beans, and persistence logic to entity beans. Obviously not
> everyone will be able to run this, but you can at least look and see
> how such an app could be constructed.
>
> A couple of things to think about before we start writing docs that will
> be out of date quickly:
>
> * I'm planning to migrate to jakarta-commons versions of the shareable
> pieces of Struts that have migrated there, including: Bean Utils,
> Digester, DBCP (connection pool), Collections classes, and Message
> Resources. Docs are still welcome in all of these areas, but they
> should probably be done in jakarta-commons instead of here.
>
> * The JSP Standard Tag Library will have an early access version of their
> tags available in the near future. There will be some significant
> overlap with our tags in the struts-bean and struts-logic libraries,
> and an expression language for nested property access that will be
> similar to (but not identical) to ours. We'll want to think in the
> long run about making sure that Struts interoperates nicely with
> these tags. Because they will be standard, JSP page compilers will
> be able to generate optimized code for them.
>
> * A little further down the pike, the result of the JavaServer Faces
> (JSR-127) effort to create a standard GUI Component Model for web apps
> will be in early access. At that time, I'll want to build some app
> examples that use JSF as the user interface, but interact with the
> rest of the Struts framework. NOTE: I am on the expert group for
> JSR-127, so you can rest assured that the two technologies will play
> together nicely!
>
> > If this is ok with you all and you are interested, please send me an
email
> > at mailto:jasbell@i-2000.com
> >
> > Let us all salute the Sixers on their valiant effort last night
> >
> >
> I was rooting for them (being from Portland and a Trail Blazers fan, you
> can imagine how I feel about the Lakers :-). Alas, it was a tremendous
> effort, but for naught ;-(.
>
> Craig
>
>
Re: I would like to offer myself to help with documentation
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sat, 16 Jun 2001, Jonathan wrote:
> Hello all.
> It seems that there is a back log of documentation to do and I would like to
> offer to help with it as I am very good at explaining things. It also helps
> me understand the framework in a deeper way. However, because I am still
> relatively green with Struts (3 months) I will need to correspond with some
> of you outside of the list to get questions answered (I dont want to clutter
> up the list with these questions). I can complete sections according to
> when you want them, or I can do it in the order I want.
>
Sounds great! This is a good place to talk about what the docs should
include.
On my personal wish list:
* High-quality UML diagrams covering all aspects of the architecture
of Struts (especially sequence diagrams of how requests are handled).
Anybody know some good+cheap tools for this purpose?
* Tutorials (and example webapps) for a few common design idioms, such as
a wizard-type multipage dialog. Although, maybe we ought to wait on
this particular one if we're going to add pager-type tags.
* Examples of extending the controller servlet to initialize your own
application resources.
* Examples that integrate some other commonly available tag libraries
(such as those in jakarta-taglibs). However, I'm not personally a
huge fan of using the DB tags, because it can encourage you to stray
away from MVC :-).
* Step-by-step how to construct a web app. Yes, this covers a lot of
ground that is not Struts-specific, but this would clear up a lot of the
complexity faced by new developers. A good starting point might be the
"Application Developer's Guide" that ships with Tomcat (disclaimer: I
wrote it, so don't be too hard on me :-).
* Completed "package.html" files for the remaining packages (used as
Developer's Guide links in the documentation).
* A comprehensive example that uses Data Acess Objects to talk to a
relational database. Ted's got some good starts here, but I'm thinking
more about a "real" application -- perhaps something like the
FAQ-O-MATIC idea, but written based on Struts?
* A comprehensive example that uses EJBs to delegate business logic to
session beans, and persistence logic to entity beans. Obviously not
everyone will be able to run this, but you can at least look and see
how such an app could be constructed.
A couple of things to think about before we start writing docs that will
be out of date quickly:
* I'm planning to migrate to jakarta-commons versions of the shareable
pieces of Struts that have migrated there, including: Bean Utils,
Digester, DBCP (connection pool), Collections classes, and Message
Resources. Docs are still welcome in all of these areas, but they
should probably be done in jakarta-commons instead of here.
* The JSP Standard Tag Library will have an early access version of their
tags available in the near future. There will be some significant
overlap with our tags in the struts-bean and struts-logic libraries,
and an expression language for nested property access that will be
similar to (but not identical) to ours. We'll want to think in the
long run about making sure that Struts interoperates nicely with
these tags. Because they will be standard, JSP page compilers will
be able to generate optimized code for them.
* A little further down the pike, the result of the JavaServer Faces
(JSR-127) effort to create a standard GUI Component Model for web apps
will be in early access. At that time, I'll want to build some app
examples that use JSF as the user interface, but interact with the
rest of the Struts framework. NOTE: I am on the expert group for
JSR-127, so you can rest assured that the two technologies will play
together nicely!
> If this is ok with you all and you are interested, please send me an email
> at mailto:jasbell@i-2000.com
>
> Let us all salute the Sixers on their valiant effort last night
>
>
I was rooting for them (being from Portland and a Trail Blazers fan, you
can imagine how I feel about the Lakers :-). Alas, it was a tremendous
effort, but for naught ;-(.
Craig
I would like to offer myself to help with documentation
Posted by Jonathan <ja...@i-2000.com>.
Hello all.
It seems that there is a back log of documentation to do and I would like to
offer to help with it as I am very good at explaining things. It also helps
me understand the framework in a deeper way. However, because I am still
relatively green with Struts (3 months) I will need to correspond with some
of you outside of the list to get questions answered (I dont want to clutter
up the list with these questions). I can complete sections according to
when you want them, or I can do it in the order I want.
If this is ok with you all and you are interested, please send me an email
at mailto:jasbell@i-2000.com
Let us all salute the Sixers on their valiant effort last night
Re: cvs commit: jakarta-struts/doc/userGuide resources.xml project.xml
index.xml
Posted by "Craig R. McClanahan" <cr...@apache.org>.
On Sat, 16 Jun 2001, Ted Husted wrote:
> So I screwed this up the other night and didn't commit a significant
> update to the Resource page that I meant for both 1.1 and 1.0.
>
> I sent it up again for 1.1 but don't know if we should update the
> documentation for 1.0 or not.
>
> Personally, I would think that we'd have to make some updates, just to
> document known issues, so we might want to consider allowing other
> cautious changes as well.
>
If we have any bug fixes that we feel are important enough, we can create
a 1.0.1 release for them. So, I'd go ahead and commit your docs changes
on the 1.0 branch as well.
Craig
> -- Ted Husted, Husted dot Com, Fairport NY USA.
> -- Custom Software ~ Technical Services.
> -- Tel 716 737-3463.
> -- http://www.husted.com/about/struts/
>
Re: cvs commit: jakarta-struts/doc/userGuide resources.xml project.xml
index.xml
Posted by Ted Husted <hu...@apache.org>.
So I screwed this up the other night and didn't commit a significant
update to the Resource page that I meant for both 1.1 and 1.0.
I sent it up again for 1.1 but don't know if we should update the
documentation for 1.0 or not.
Personally, I would think that we'd have to make some updates, just to
document known issues, so we might want to consider allowing other
cautious changes as well.
-- Ted Husted, Husted dot Com, Fairport NY USA.
-- Custom Software ~ Technical Services.
-- Tel 716 737-3463.
-- http://www.husted.com/about/struts/