You are viewing a plain text version of this content. The canonical link for it is here.
Posted to adffaces-user@incubator.apache.org by Adam Winer <aw...@gmail.com> on 2006/06/16 21:03:06 UTC
Tag renaming proposal
All,
Shortly before we got the source out, a proposal started circulating
internally to rename some of our tags to make them more intuitively
named and more obvious, especially to first time users. We have
been using a pretty rigorous pattern:
<component-family><Renderer-type>
... which is good for JSF experts, but not necessarily great for
first time users.
Some of the ideas to simplify this:
- Omit component-family in some cases (esp. "object")
- Use supertype for component families in others (esp.
"input" instead of "selectInput" and "panel" instead of
"showOne" or "decorate")
- Improve renderer-type names (esp. add "Layout" to
panels that perform layout)
- Occasionally, just pick names that are one-offs that are clearer.
That said, here's the list of proposed name changes. I want
to emphasize that *ALL* of these are first-draft suggestions,
and I'd like as much input as possible on these names (and
others). If you're a user and have found one of our component
names particularly baffling, let us know; if you've found one
of the existing names perfect, but find the new name confusion,
let us know that too!
Old Name New Name
------------------ ---------------
decorateCollection panelCollection
navigationLevel navigationPane
navigationPath breadCrumbs
navigationTrain train
objectIcon icon
objectImage image
objectMedia media
objectSeparator separator
objectSpacer spacer
panelBorder panelBorderLayout
panelForm panelFormLayout
panelGroup panelGroupLayout
panelHorizontal panelHorizontalLayout
selectInputColor inputColor
selectInputDate inputDate
selectInputText inputLOV
showOneAccordion panelAccordion
showManyAccordion panelAccordion (merge with showOneXyz)
showOneChoice panelChoice
showOneRadio panelRadio
showOneTabs panelTabbed
There's no deadline for feedback, but sooner would be better. :)
Thanks in advance,
Adam
Re: Tag renaming proposal
Posted by Martin Marinschek <ma...@gmail.com>.
Breadcrumbs is an english expression - you find your way with breadcrumbs,
like in the fairy tale of "Hänsel and Gretel" ;)
LOV - I don't understand that either. Me not being a native english speaker
might be the reason.
regards,
Martin
On 6/17/06, Ernst Fastl <er...@gmail.com> wrote:
>
> Great Idea!
>
> I also think that simpler names would make it much easier to get started.
> although I don't really understand "breadCrumbs" (maybe stick to
> navigationPath
> or just path) I think that the other suggestions are really great.
>
> Ernst
>
> On 6/16/06, Matthias Wessendorf <ma...@apache.org> wrote:
> > Hey-
> >
> > some comments inline.
> >
> > > been using a pretty rigorous pattern:
> > >
> > > <component-family><Renderer-type>
> > >
> > > ... which is good for JSF experts, but not necessarily great for
> > > first time users.
> >
> > :)
> > I think the simpler the better is a good approach. The goal of
> > Trinidad is not to address only JSF experts. Since JSF tries to
> > simplify the "Java Web development" our components should have also
> > simple names, however.
> >
> > > Some of the ideas to simplify this:
> > >
> > > - Omit component-family in some cases (esp. "object")
> > > - Use supertype for component families in others (esp.
> > > "input" instead of "selectInput" and "panel" instead of
> > > "showOne" or "decorate")
> > > - Improve renderer-type names (esp. add "Layout" to
> > > panels that perform layout)
> > > - Occasionally, just pick names that are one-offs that are clearer.
> >
> > removing "object" from "objectImage" (for instance) is definitly a good
> thing.
> > Since some components perform layout, a "Layout" should be added!
> > What to me was totally confusing is the "selectInputDate".
> >
> > +1 on having these guys named "inputDate". In a component palett I was
> > always looking for inputDate and then I figured out, that guy is
> > called selectInputDate.
> >
> >
> > > Old Name New Name
> > > ------------------ ---------------
> > > decorateCollection panelCollection
> > > navigationLevel navigationPane
> > > navigationPath breadCrumbs
> > > navigationTrain train
> > > objectIcon icon
> > > objectImage image
> > > objectMedia media
> > > objectSeparator separator
> > > objectSpacer spacer
> > > panelBorder panelBorderLayout
> > > panelForm panelFormLayout
> > > panelGroup panelGroupLayout
> > > panelHorizontal panelHorizontalLayout
> > > selectInputColor inputColor
> > > selectInputDate inputDate
> > > selectInputText inputLOV
> > > showOneAccordion panelAccordion
> > > showManyAccordion panelAccordion (merge with showOneXyz)
> > > showOneChoice panelChoice
> > > showOneRadio panelRadio
> > > showOneTabs panelTabbed
> >
> > what does the "LOV" by inputLOV mean?
> >
> > The proposed names sounds reasonable.
> > "breadCrumbs" is interesting.
> >
> > I guess Martin, Thomas and Ernst will like their "Brösel".
> >
> > <German>
> > Or that guy who invented the comic Werner :)
> > </German>
> >
> > -Matthias
> >
> > > There's no deadline for feedback, but sooner would be better. :)
> > >
> > > Thanks in advance,
> > > Adam
> > >
> > >
> >
> >
> > --
> > Matthias Wessendorf
> > Aechterhoek 18
> > 48282 Emsdetten
> > blog: http://jroller.com/page/mwessendorf
> > mail: mwessendorf-at-gmail-dot-com
> >
>
--
http://www.irian.at
Your JSF powerhouse -
JSF Consulting, Development and
Courses in English and German
Professional Support for Apache MyFaces
Re: Tag renaming proposal
Posted by Ernst Fastl <er...@gmail.com>.
Great Idea!
I also think that simpler names would make it much easier to get started.
although I don't really understand "breadCrumbs" (maybe stick to navigationPath
or just path) I think that the other suggestions are really great.
Ernst
On 6/16/06, Matthias Wessendorf <ma...@apache.org> wrote:
> Hey-
>
> some comments inline.
>
> > been using a pretty rigorous pattern:
> >
> > <component-family><Renderer-type>
> >
> > ... which is good for JSF experts, but not necessarily great for
> > first time users.
>
> :)
> I think the simpler the better is a good approach. The goal of
> Trinidad is not to address only JSF experts. Since JSF tries to
> simplify the "Java Web development" our components should have also
> simple names, however.
>
> > Some of the ideas to simplify this:
> >
> > - Omit component-family in some cases (esp. "object")
> > - Use supertype for component families in others (esp.
> > "input" instead of "selectInput" and "panel" instead of
> > "showOne" or "decorate")
> > - Improve renderer-type names (esp. add "Layout" to
> > panels that perform layout)
> > - Occasionally, just pick names that are one-offs that are clearer.
>
> removing "object" from "objectImage" (for instance) is definitly a good thing.
> Since some components perform layout, a "Layout" should be added!
> What to me was totally confusing is the "selectInputDate".
>
> +1 on having these guys named "inputDate". In a component palett I was
> always looking for inputDate and then I figured out, that guy is
> called selectInputDate.
>
>
> > Old Name New Name
> > ------------------ ---------------
> > decorateCollection panelCollection
> > navigationLevel navigationPane
> > navigationPath breadCrumbs
> > navigationTrain train
> > objectIcon icon
> > objectImage image
> > objectMedia media
> > objectSeparator separator
> > objectSpacer spacer
> > panelBorder panelBorderLayout
> > panelForm panelFormLayout
> > panelGroup panelGroupLayout
> > panelHorizontal panelHorizontalLayout
> > selectInputColor inputColor
> > selectInputDate inputDate
> > selectInputText inputLOV
> > showOneAccordion panelAccordion
> > showManyAccordion panelAccordion (merge with showOneXyz)
> > showOneChoice panelChoice
> > showOneRadio panelRadio
> > showOneTabs panelTabbed
>
> what does the "LOV" by inputLOV mean?
>
> The proposed names sounds reasonable.
> "breadCrumbs" is interesting.
>
> I guess Martin, Thomas and Ernst will like their "Brösel".
>
> <German>
> Or that guy who invented the comic Werner :)
> </German>
>
> -Matthias
>
> > There's no deadline for feedback, but sooner would be better. :)
> >
> > Thanks in advance,
> > Adam
> >
> >
>
>
> --
> Matthias Wessendorf
> Aechterhoek 18
> 48282 Emsdetten
> blog: http://jroller.com/page/mwessendorf
> mail: mwessendorf-at-gmail-dot-com
>
Re: Tag renaming proposal
Posted by Matthias Wessendorf <ma...@apache.org>.
Hey-
some comments inline.
> been using a pretty rigorous pattern:
>
> <component-family><Renderer-type>
>
> ... which is good for JSF experts, but not necessarily great for
> first time users.
:)
I think the simpler the better is a good approach. The goal of
Trinidad is not to address only JSF experts. Since JSF tries to
simplify the "Java Web development" our components should have also
simple names, however.
> Some of the ideas to simplify this:
>
> - Omit component-family in some cases (esp. "object")
> - Use supertype for component families in others (esp.
> "input" instead of "selectInput" and "panel" instead of
> "showOne" or "decorate")
> - Improve renderer-type names (esp. add "Layout" to
> panels that perform layout)
> - Occasionally, just pick names that are one-offs that are clearer.
removing "object" from "objectImage" (for instance) is definitly a good thing.
Since some components perform layout, a "Layout" should be added!
What to me was totally confusing is the "selectInputDate".
+1 on having these guys named "inputDate". In a component palett I was
always looking for inputDate and then I figured out, that guy is
called selectInputDate.
> Old Name New Name
> ------------------ ---------------
> decorateCollection panelCollection
> navigationLevel navigationPane
> navigationPath breadCrumbs
> navigationTrain train
> objectIcon icon
> objectImage image
> objectMedia media
> objectSeparator separator
> objectSpacer spacer
> panelBorder panelBorderLayout
> panelForm panelFormLayout
> panelGroup panelGroupLayout
> panelHorizontal panelHorizontalLayout
> selectInputColor inputColor
> selectInputDate inputDate
> selectInputText inputLOV
> showOneAccordion panelAccordion
> showManyAccordion panelAccordion (merge with showOneXyz)
> showOneChoice panelChoice
> showOneRadio panelRadio
> showOneTabs panelTabbed
what does the "LOV" by inputLOV mean?
The proposed names sounds reasonable.
"breadCrumbs" is interesting.
I guess Martin, Thomas and Ernst will like their "Brösel".
<German>
Or that guy who invented the comic Werner :)
</German>
-Matthias
> There's no deadline for feedback, but sooner would be better. :)
>
> Thanks in advance,
> Adam
>
>
--
Matthias Wessendorf
Aechterhoek 18
48282 Emsdetten
blog: http://jroller.com/page/mwessendorf
mail: mwessendorf-at-gmail-dot-com