Re: [obix] oBIX Artifact Naming and Titling...Artifact Names

Thanks, Toby!

This use of lower-case for the file names is a good step forward, in my opinion.

In association with the file name changes, it would be wise to also make the same changes to the footer of each.  We would probably catch it during publication, but it's better to go ahead and make the footer change in your Working Drafts as well.

I just saw your other notes... thanks!  The TC will benefit by arriving at a firm decision on OBIX vs oBIX... I'll stay out of that decision...

Best regards,

Paul

On Fri, Apr 19, 2013 at 12:23 PM, Toby Considine <> wrote:

Artifact names, in OASIS, is the file names. As they are often used in urls, they should be case-insensitive for the widest standard applicability. Lower-case, as you suggested, seems fine:

 

Editors:

 

Starting with the next upload, can we have all file names be lower case as in

 

obix-rest-v1.0-csd01.doc

obix-soap-v1.0-csd01.doc

obix-encodings-v1.0-csd01.doc

obix--v2.0-csd01.doc

 

 

etc. The same rule should apply to the wsdl artifacts.

 

 

Thanks

 

tc

"If something is not worth doing, it`s not worth doing well "    -- Peter Drucker

Toby Considine
TC9, Inc

OASIS TC Chair: oBIX & WS-Calendar

OASIS TC Editor: EMIX, Energy Interoperation

SGIP Smart Grid Architecture Committee

  

Email: 

Phone: (919)619-2104

http://www.tcnine.com

blog: http://www.NewDaedalus.com 

 

From: Paul Knight [mailto:] 

Sent: Thursday, April 18, 2013 5:16 PM
To: Considine, Toby
Cc: ; 

Subject: Re: [obix] oBIX Artifact Naming and Titling...

 

Hi Toby and all,

 

Thanks for asking.  It's certainly best to think about these things before publication!

.

.

.

 

- for the document file names and URIs, the currently-planned names are:

http://docs.oasis-open.org/obix/OBIX-REST/v1.0/csd01/OBIX-REST-v1.0-csd01.doc

http://docs.oasis-open.org/obix/OBIX-SOAP/v1.0/csd01/OBIX-SOAP-v1.0-csd01.doc

http://docs.oasis-open.org/obix/OBIX-Encodings/v1.0/csd01/OBIX-Encodings-v1.0-csd01.doc

http://docs.oasis-open.org/obix/OBIX/v2.0/csd01/OBIX-v2.0-csd01.doc

 

 

These file names do not need to follow the capitalization pattern of the titles (OBIX or oBIX).  Since the handling of file names is case-sensitive, it's quite important to keep the naming regular.  I would highly recommend using all lower-case file names.  For those times when they are manually typed, it simplifies things considerably, and I think it has a neater appearance.  However, we can support whatever the TC agrees for file names.  Please make a specific choice for these file names, as well as for the titles.

 

Enough for now... please feel free to ask for clarification, support, etc.

 

Best regards,

Paul

 

On Thu, Apr 18, 2013 at 1:07 PM, Considine, Toby <> wrote:

Advice needed, requested after considerable discussion in oBIX TC.

 

(This might be a Paul Knight question)

 

oBIX 1.0 is an omnibus specification. In 1.1 we are breaking out two bindings, (SOAP and REST), and Encodings (XML, JSON, COAP, et al.) We anticipate that a Conforming 1.1 Server MUST specify which Bindings, Encodings it supports. We anticipate that at a future time, a new encodings document could be made, or a new binding, without creating a 1.2. Conversely, we can imagine oBIX 1.2 coming out and referencing the Binding/Encoding documents we are working on today.

 

As a matter of work process, the current WDs of each specification are essentially stripped out of the old 1.0. Each spec is currently being modified as needed. We anticipate releasing a package of 4 specifications (oBIX 1.1, SOAP Binding for oBIX, REST Binding for oBIX, Encodings for oBIX) in the same public review.

 

There was a spirited discussion today about avoiding confusion. Should they all be 1.1 of the Spec, because they all existed formerly as part of 1.0? Should they have longer titles, i.e., 

·         “SOAP Bindings for oBIX 1.1 and above, v1.0”

·         “SOAP Bindings for oBIX 1.1, v1.0”

Of course, the answer could also be

 

·         “SOAP Bindings for oBIX 1.1 and above, v1.1”

·         “SOAP Bindings for oBIX 1.1, v1.1”

With each document noting that the original material was all included in 1.0.

 

We are looking for advice on how to avoid as much confusion as possible while still allowing for flexibility going forward.

 

Thanks

 

tc

 

 

"You can cut all the flowers but you cannot keep spring from coming." 

-Pablo Neruda 

Toby Considine

Chair, OASIS oBIX TC

Editor, OASIS EMIX, Energy Interoperation
Campus Services Information Technology
University of North Carolina

Chapel Hill, NC

  

Email: Toby.Considine@ unc.edu

Phone: (919)962-9073 

http://www.oasis-open.org 
http://www.NewDaedalus.com

 

 

 

-- 
Paul Knight  - Tel: +1 781-861-1013

OASIS - Advancing open standards for the information society
Document Process Analyst

-- 
Paul Knight  - Tel: +1 781-861-1013

OASIS - Advancing open standards for the information society
Document Process Analyst