Man, I really hate top-posting. My first reply was in top-posting style
because the first reply to this thread was top-posted. But now the
styles are mixed, and this thread is rather painful to follow. My reply
is somewhere in the middle here....
I really do think that consistently posting *under* the text that is
being replied to leads to threads that are *much* easier to read.
Leonardo Uribe schrieb:
On Fri, Jun 27, 2008 at 1:53 AM, [EMAIL PROTECTED]
<mailto:[EMAIL PROTECTED]> <[EMAIL PROTECTED]
<mailto:[EMAIL PROTECTED]>> wrote:
Do you mean pages like this?
http://myfaces.apache.org/tomahawk/popup.html
Yes. Each time we want to upgrade some component, we have to write
this part manually.
I'm not sure that the "syntax" section here is particularly
useful. That information is available in the taglib docs; no point
in repeating it. And the API section isn't terribly useful; maybe
for people who want to customise a component it makes it easier to
find the real component class, but that isn't often.
The "description" field could be copied I suppose; that would be
mildly useful.
But the rest is all hand-written.
Or did you mean something else?
Trinidad has an generated Tag library information (using
maven-tagdoc-plugin) here:
http://myfaces.apache.org/trinidad/trinidad-api/tagdoc.html
When you navigate through this, you can find a lot more info than on
its java taglibdoc.
One question is why have a extended doc on tomahawk (see
http://myfaces.apache.org/tomahawk/extendedDocs.html) link, if all
necessary info is on its tld (or could be added here).
We have 3 alternatives:
1. Remove extended doc pages and do and merge the info on the
description field of each component (so this is available on its
taglibdoc).
2. Remove extended doc pages and apply Trinidad solution: a custom
report goal that generate all the info.
3. Do nothing and live with the fact of maintain 70 or more pages that
say a little bit more than on the taglibdoc.
Suggestions?
It looks to me like the trinidad report is a complete replacement for
the standard taglib report, containing all the info of the existing
taglib reports plus more. And they look nicer too. So I'd be happy to
see us use the same maven report plugin that trinidad does, instead of
the current taglib plugin. And ditch the "extended doc" pages.
I'm not sure that (1) is possible. The existing "extended doc" pages
contain screenshots, html tables, etc. that just cannot be represented
as javadoc AFAIK. So there would be no way to enhance the javadoc on
components in a way that would generate anything like the existing
"extended doc" or the trinidad report. I presume the trinidad report
merges in hand-written html that can contain stuff like images and stuff?,
Regards,
Simon
Regards, Simon
Leonardo Uribe schrieb:
The idea could be use velocity templates like everything.
On Thu, Jun 26, 2008 at 10:38 PM, Leonardo Uribe
<[EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]>
<mailto:[EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]>>> wrote:
Hi
It could be good if we could generate the site files describing
each component using myfaces-builder-plugin (generate from
myfaces-metadata.xml instead from faces-config.xml).
It's a waste of effort have to maintain this files. If we
do this,
we make easier move components from sandbox to tomahawk.
I'll try it and see what happens.
Suggestions are welcome.
regards
Leonardo Uribe
