OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

xdi message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [xdi] Deciding on XDI spec template variable formatting convention


unless there is an extremely good reason to change existing practice, i would advocate leaving things the way they are (and document that convention in the xdi-docbook-util notation.xml file).

=peterd

On Jun 11, 2014, at 08:47 AM, Markus Sabadello <markus.sabadello@xdi.org> wrote:

My vote is to leave it the way it is.
I feel % and/or upper case characters just make it less readable than the current pattern.

Markus



On Wed, Jun 11, 2014 at 8:36 AM, =Drummond Reed <drummond.reed@xdi.org> wrote:
On last Friday's XDI TC call, we had the discussion noted below (I took this from the Minutes doc that I don't think Markus has sent out yet):

**********

Joseph asked about the syntax we are using for variables in specification template code, i.e., for “spec variables” vs. “XDI variables”. For an example, see the XDI Message Patterns wiki page.

Joseph’s suggestion is to start using ALLCAPS in bold.

Phil suggested using a colon as the prefix character, however a colon is a legal XDI syntax character, so the worry is that it would cause confustion.

Drummond’s suggestion is that we do both except using % as the prefix character (since it is not a legal XDI syntax character except for escape encoding, which should not appear in spec templates), plus ALLCAPS in bold, e.g., %FROM. The reason for the prefix character is that it allows multiple variables to appear contiguously (as we do have in some spec templates).

Example of old approach:

<--from-peer-->/$set/<--from-->[$msg]<--msg-id-->

Example of new approach:

%FROM-PEER/$set/%FROM[$msg]%MSG-ID


**********
I'm posting this suggestion directly to the list to check for consensus because there are several wiki pages that we need to update this week to reflect current discussions about the "notation shift" and I'd like to start using the new spec template variable formatting convention.

If you are in favor of the proposal above please reply +1. If you have an alternate proposal, please post it.

Thanks,

=Drummond  


Peter Davis: Neustar, Inc.
Distinguished Engineer, Director, Neustar Foundry
45980 Center Oak Plaza Sterling, VA 20166

The information contained in this e-mail message is intended only for the use of the recipient(s) named above and may contain confidential and/or privileged information. If you are not the intended recipient you have received this e-mail message in error and any review, dissemination, distribution, or copying of this message is strictly prohibited. If you have received this communication in error, please notify us immediately and delete the original message.




[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]