[xwiki-devs] Convention for class property hints ?

Marius Dumitru Florea mariusdumitru.florea at xwiki.com
Wed Feb 15 07:43:50 UTC 2012


On Thu, Feb 9, 2012 at 7:21 PM, Jerome Velociter <jerome at winesquare.net> wrote:
> Hello,
>
> Right now class property hints are not supported right in the core of
> XWiki (though it's been mentioned as a possible future item of the
> roadmap for AWM, see http://markmail.org/message/ltuphlj7bnnso2yb ).
> Once this will be implemented, it will rely on i18n message keys so
> that hints are localizables (same strategy as for class property
> pretty names)
> I'd like to start the discussion and see if we can agree on a
> convention that would be used in the future when this module is
> implemented.
> The reason for this is I'm starting to work on a LDAP admin UI, and I
> find that their field pretty names are not self-explanatory. It's not
> a matter of expression, it's just the fact that what they describe
> needs more explanation than what the pretty name can offer). In this
> light, I'm planning on displaying such longer hints in this admin
> section.
>
> Right now the format for a pretty name is :
> Space.Class_property=Pretty name
>

> The format for a hint could be something like :
> Space.Class_property.xHint=Hint

+1

> This would need escaping rules I think, since I believe
> "property.xHint" is a valid property name

I don't think we need escaping because the translation key is never
parsed. We just compute it from the class and property name.
'Space.Class_property.xHint.xHint' is a valid key for
'property.xHint'.

> Note that I use "xHint" and not "hint" to be consistent with the form
> standards class names. This can be discussed though.

I prefer hint.

Thanks,
Marius

>
> WDYT ? Do you have other ideas ?
>
> Jerome.
>
>
> --
> Jérôme Velociter
> Winesquare
> http://www.winesquare.net/
> _______________________________________________
> devs mailing list
> devs at xwiki.org
> http://lists.xwiki.org/mailman/listinfo/devs


More information about the devs mailing list