> From: Aslak Hellesoy [mailto:[EMAIL PROTECTED]] > Sent: Sunday, December 15, 2002 10:08 AM > Subject: RE: [Xdoclet-user] target-relation ? > > That's a very nice explanation Brian. Could you wrap it up as > an xdoc and > link to it form navigation.xml?
Yes, I was just asking Colin where he thought I should put the explanation. It seems like there are a lot more of these that are necessary, and I guess my initial question of "where to put it?" was based on this. It seems like it ought to be linked off of or form the basis of the (currently nonexistent) docs for @ejb.target-relation, but it's a little long in the tooth to fit there well. Colin suggested the FAQ, but I'm kinda queasy about putting more information into an outside source that requires a paid subscription in order to search completely. My suggestion then would be that this information should go into the "Using XDoclet" document, possibly with an index for the information as it grows. There needs to be an all-encompassing guide that accompanies the reference material, and ideally they would be cross-linked. http://www.mysql.com/doc/en/index.html is one of the best manuals for a complex product that I know of, but they really don't have the great reference format that Mathias pulled together so elegantly. So my survey is what people think about the layout of the documentation. I personally think it's hard for developers with experience to use a product to document it, but it's hard for users that need the documentation (and know where it ought to go) to write it by the very nature that they don't know what to write! Take a look at http://xdoclet.sourceforge.net/1.2beta/ and make some suggestions, please! What are your thoughts on this issue? Help us help you help yourselves! :-) -b ------------------------------------------------------- This sf.net email is sponsored by: With Great Power, Comes Great Responsibility Learn to use your power at OSDN's High Performance Computing Channel http://hpc.devchannel.org/ _______________________________________________ Xdoclet-user mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/xdoclet-user
