On Tue, May 29, 2012 at 4:38 PM, Sergiu Dumitriu <sergiu(a)xwiki.com> wrote:
On 05/29/2012 09:20 AM, Eduard Moraru wrote:
Hi devs,
For the new messageSender macro [1][2], I chose the name using the
"attachmentSelector" macro as a
template:"<object><personified-action>"
Vincent did not really like the "messageSender" name and proposed
"message", "sendMessage" or "userMessage".
Since AFAIK we don`t currently have a naming convention for wiki macro
names, I`d like to propose that we stick to the patterns:
1) "<object><personified-action>" (attachmentSelector,
messageSender) for
action-oriented macros and
2) "<object(s)>" (documents, spaces, activity) for display-oriented
macros
For 2), it's pretty clear, but for 1), I personally prefer
"<object><personified-action>" since overall it is a noun and, in
english,
the phrase "messageSender macro" sounds better to me than "sendMessage
macro". Also, I think that the main action of the action-oriented macro
should be reflected in its name.
I`d like your opinion on the matter and also new proposals if you have
any.
Here's my +1 for 1) and 2).
+1 as well.
I don't agree that the message sender macro should be called "message" or
"userMessage", since without knowing what it does, I'd assume that it
displays a message to the user, and seeing a textarea coming out of it I'd
be surprised and wouldn't know what to do.
"sendMessage" is also wrong IMO, since the
present form of the verb suggests
that it instantly sends a message, not that it allows me to send a message
if and when I want to.
Good point. +1 for messageSender
Thanks,
Marius
--
Sergiu Dumitriu
http://purl.org/net/sergiu/
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs