[VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

6 messages Options
Embed this post
Permalink
tmortagne

[VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

Reply Threaded More More options
Print post
Permalink
Hi devs,

We want to display macros parameters pretty names in the WYSIWYG.

For that we need to provide it in the WYSIWYG. The current
ParameterDescriptor#getName actually return the parameter
identifier/technical name.

So I see two solutions:
1) the general rule in new XWiki architecture is to use id/name
instead of name/prettyname so i propose to break ParameterDescriptor
and PropertyDescriptor to follow this rule.
2) add a getDisplayName method and let getName for the identifier

WDYT ?

+1 for 1). I never like to break an API but doubt this API is used a
lots yet except by us internally and it would like we use the same
rule everywhere as much as possible.

--
Thomas Mortagne
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
vmassol

Re: [VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

Reply Threaded More More options
Print post
Permalink

On Oct 26, 2009, at 5:18 PM, Thomas Mortagne wrote:

> Hi devs,
>
> We want to display macros parameters pretty names in the WYSIWYG.
>
> For that we need to provide it in the WYSIWYG. The current
> ParameterDescriptor#getName actually return the parameter
> identifier/technical name.
>
> So I see two solutions:
> 1) the general rule in new XWiki architecture is to use id/name
> instead of name/prettyname so i propose to break ParameterDescriptor
> and PropertyDescriptor to follow this rule.
> 2) add a getDisplayName method and let getName for the identifier
>
> WDYT ?
>
> +1 for 1). I never like to break an API but doubt this API is used a
> lots yet except by us internally and it would like we use the same
> rule everywhere as much as possible.

+1 for 1).

Thanks
-Vincent

_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Asiri Rathnayake

Re: [VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

Reply Threaded More More options
Print post
Permalink
In reply to this post by tmortagne
Hi,

On Mon, Oct 26, 2009 at 9:48 PM, Thomas Mortagne
<[hidden email]>wrote:

> Hi devs,
>
> We want to display macros parameters pretty names in the WYSIWYG.
>
> For that we need to provide it in the WYSIWYG. The current
> ParameterDescriptor#getName actually return the parameter
> identifier/technical name.
>
> So I see two solutions:
> 1) the general rule in new XWiki architecture is to use id/name
> instead of name/prettyname so i propose to break ParameterDescriptor
> and PropertyDescriptor to follow this rule.
> 2) add a getDisplayName method and let getName for the identifier
>
> WDYT ?
>
> +1 for 1). I never like to break an API but doubt this API is used a
> lots yet except by us internally and it would like we use the same
> rule everywhere as much as possible.
>

+1 for 1)

If you can create a JIRA for updating wiki macros to support this, I will
work on it as soon as you are done.

Thanks.

- Asiri


>
> --
> Thomas Mortagne
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Marius Dumitru Florea

Re: [VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

Reply Threaded More More options
Print post
Permalink
In reply to this post by tmortagne
Thomas Mortagne wrote:

> Hi devs,
>
> We want to display macros parameters pretty names in the WYSIWYG.
>
> For that we need to provide it in the WYSIWYG. The current
> ParameterDescriptor#getName actually return the parameter
> identifier/technical name.
>
> So I see two solutions:
> 1) the general rule in new XWiki architecture is to use id/name
> instead of name/prettyname so i propose to break ParameterDescriptor
> and PropertyDescriptor to follow this rule.
> 2) add a getDisplayName method and let getName for the identifier
>
> WDYT ?

+1 for 1)

Thanks,
Marius

>
> +1 for 1). I never like to break an API but doubt this API is used a
> lots yet except by us internally and it would like we use the same
> rule everywhere as much as possible.
>
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
Sergiu Dumitriu-2

Re: [VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

Reply Threaded More More options
Print post
Permalink
In reply to this post by tmortagne
On 10/26/2009 05:18 PM, Thomas Mortagne wrote:

> Hi devs,
>
> We want to display macros parameters pretty names in the WYSIWYG.
>
> For that we need to provide it in the WYSIWYG. The current
> ParameterDescriptor#getName actually return the parameter
> identifier/technical name.
>
> So I see two solutions:
> 1) the general rule in new XWiki architecture is to use id/name
> instead of name/prettyname so i propose to break ParameterDescriptor
> and PropertyDescriptor to follow this rule.
> 2) add a getDisplayName method and let getName for the identifier
>
> WDYT ?
>
> +1 for 1). I never like to break an API but doubt this API is used a
> lots yet except by us internally and it would like we use the same
> rule everywhere as much as possible.

+1 for 1)

--
Sergiu Dumitriu
http://purl.org/net/sergiu/
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs
tmortagne

Re: [VOTE] Modify ParameterDescriptor/PropertyDescriptor to support id/name

Reply Threaded More More options
Print post
Permalink
In reply to this post by Asiri Rathnayake
On Mon, Oct 26, 2009 at 17:34, Asiri Rathnayake
<[hidden email]> wrote:

> Hi,
>
> On Mon, Oct 26, 2009 at 9:48 PM, Thomas Mortagne
> <[hidden email]>wrote:
>
>> Hi devs,
>>
>> We want to display macros parameters pretty names in the WYSIWYG.
>>
>> For that we need to provide it in the WYSIWYG. The current
>> ParameterDescriptor#getName actually return the parameter
>> identifier/technical name.
>>
>> So I see two solutions:
>> 1) the general rule in new XWiki architecture is to use id/name
>> instead of name/prettyname so i propose to break ParameterDescriptor
>> and PropertyDescriptor to follow this rule.
>> 2) add a getDisplayName method and let getName for the identifier
>>
>> WDYT ?
>>
>> +1 for 1). I never like to break an API but doubt this API is used a
>> lots yet except by us internally and it would like we use the same
>> rule everywhere as much as possible.
>>
>
> +1 for 1)
>
> If you can create a JIRA for updating wiki macros to support this, I will
> work on it as soon as you are done.

Sure. Of course I will handle the breaking part on wiki macro and
WYSIWYG myself in the same commit (I well let you and Marius take care
of the new pretty name feature part ;)).

>
> Thanks.
>
> - Asiri
>
>
>>
>> --
>> Thomas Mortagne
>> _______________________________________________
>> devs mailing list
>> [hidden email]
>> http://lists.xwiki.org/mailman/listinfo/devs
>>
> _______________________________________________
> devs mailing list
> [hidden email]
> http://lists.xwiki.org/mailman/listinfo/devs
>



--
Thomas Mortagne
_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs