RE: [xliff] Uppercasing conformance keywords in OASIS specs

["Rodolfo M. Raya" <rmraya@maxprograms.com>]

Hi Chet,

 

Thanks for the links.

 

The sample specification uses capitalized terms in the conformance clause but terms appear mostly in lower case in the rest of the document. We will use a similar style: capitalization in the conformance clause and lower case in the rest.

The latest template you and Ken uploaded to Kavi says:

 

The key words must, must not, required, shall, shall not, should, should not, recommended, may, and
optional are to be interpreted as described in [RFC 2119]. Note that for reasons of style, these words
are not capitalized in this document.

 

We have the same wording in our current draft.

 

We may need to update the stylesheets, I'll take care of that.

 

Regards,

Rodolfo

--
Rodolfo M. Raya <RMRAYA@MAXPROGRAMS.COM>
Maxprograms http://www.maxprograms.com

 

 

-------- Original Message --------
Subject: Re: [xliff] Uppercasing conformance keywords in OASIS specs
From: Chet Ensign <chet.ensign@oasis-open.org>
Date: Fri, June 15, 2012 5:13 pm
To: "Rodolfo M. Raya" <rmraya@maxprograms.com>
Cc: xliff@lists.oasis-open.org, Bryan Schnabel
<bschnabel@bschnabel.com>, OASIS TAB <tab@lists.oasis-open.org>, Ken
Holman <gkholman@cranesoftwrights.com>

Ah - ok, that explains why I haven't seen a template request.

Have a look at this recent Committee Specification -
http://docs.oasis-open.org/tgf/TGF-PL-Core/v1.0/cs01/TGF-PL-Core-v1.0-cs01.html#_Toc308643678

The language around keywords at that link is the language we have used
in .doc and .odt templates since before I began. To keep in alignment
with the current practice, I recommend including and using this
language.

Also, I worked with Ken Holman to update the Docbook template and
style sheet to produce specs that match our current format. I don't
have the new environment posted on the OASIS site yet but I believe
that http://www.oasis-open.org/committees/document.php?document_id=46254
contains the complete set.

Let me know if you have any questions,

/chet

On Fri, Jun 15, 2012 at 3:39 PM, Rodolfo M. Raya <rmraya@maxprograms.com> wrote:
> Hi Chet,
>
> We are currently working on a new specification draft, using the latest
> DocBook template and XSL stylesheets.
>
> The current draft is consistent. Keywords are in lower case and the text
> clearly says they are not capitalized for style reason, as originally
> written in the template.
>
> Regards,
> Rodolfo
> --
> Rodolfo M. Raya       rmraya@maxprograms.com
> Maxprograms       http://www.maxprograms.com
>
>
>> -----Original Message-----
>> From: xliff@lists.oasis-open.org [mailto:xliff@lists.oasis-open.org] On
> Behalf
>> Of Chet Ensign
>> Sent: Friday, June 15, 2012 4:34 PM
>> To: Schnabel, Bryan S
>> Cc: Rodolfo M. Raya; xliff@lists.oasis-open.org; OASIS TAB
>> Subject: Re: [xliff] Uppercasing conformance keywords in OASIS specs
>>
>> Hi Bryan, hi Rudolfo,
>>
>> Are you asking about a working draft that is in process or the published
> OS? I
>> assume you mean the OS or other completed document because as far as I
>> can tell the TC has not requested a document template in a few years.
>>
>> I am not concerned about correcting a completed and published document.
>> You can of course if you want to but the language changed sometime before
>> I joined OASIS last year and I don't see a reason to apply such a change
>> retrospectively.
>>
>> Frankly, the most important thing from my point of view is internal
>> consistency. Uppercase or lower, if you used them the same way then I
> don't
>> see a problem.
>>
>> Does this cover it for you?
>>
>> Best,
>>
>> /chet
>>
>> On Thu, Jun 14, 2012 at 3:11 PM, Schnabel, Bryan S
>> <bryan.s.schnabel@tektronix.com> wrote:
>> > Hi Chet,
>> >
>> >
>> >
>> > It seems we have a conflict between what the requirement in David’s
>> > link below states, vs. what we are seeing in the more recent template
>> > provided by OASIS.
>> >
>> >
>> >
>> > Can you please provide us guidance on this?
>> >
>> >
>> >
>> > Thanks Chet,
>> >
>> >
>> >
>> > Bryan
>> >
>> >
>> >
>> > From: xliff@lists.oasis-open.org [mailto:xliff@lists.oasis-open.org]
>> > On Behalf Of Rodolfo M. Raya
>> > Sent: Thursday, June 14, 2012 4:44 AM
>> > To: xliff@lists.oasis-open.org
>> >
>> >
>> > Subject: RE: [xliff] Uppercasing conformance keywords in OASIS specs
>> >
>> >
>> >
>> > The template we use in the specification was provided by OASIS and it
>> > uses lowercase for those special terms. The template is newer than the
>> > requirement you mention.
>> >
>> >
>> >
>> > Notice that we explicitly say that special word meanings are defined
>> > in RFC
>> > 2119 and it does not require key words to be capitalized.
>> >
>> >
>> >
>> > Capitalization would be important in the conformance clause but we
>> > have not defined it yet.
>> >
>> >
>> >
>> > BTW, the official OASIS template explicitly says key words are not
>> > capitalized as a matter of writing style.
>> >
>> >
>> >
>> > Regards,
>> >
>> > Rodolfo
>> >
>> > --
>> > Rodolfo M. Raya       rmraya@maxprograms.com Maxprograms
>> > http://www.maxprograms.com
>> >
>> >
>> >
>> > From: xliff@lists.oasis-open.org [mailto:xliff@lists.oasis-open.org]
>> > On Behalf Of Dr. David Filip
>> > Sent: Thursday, June 14, 2012 7:45 AM
>> > To: xliff@lists.oasis-open.org
>> > Subject: [xliff] Uppercasing conformance keywords in OASIS specs
>> >
>> >
>> >
>> > Hi all, Rodolfo, I was recently rereading some OASIS policies and it
>> > came up today in the SC f-2-f.
>> >
>> > There is an OASIS policy that explicitly states this:
>> >
>> > RFC2119 allows both uppercase and lowercase to be used for a keyword,
>> > however to enable easy identification of the keywords and consistency
>> > across specifications uppercase MUST be used for keywords at all times.
>> >
>> >
>> >
>> > See
>> > http://docs.oasis-
>> open.org/templates/TCHandbook/ConformanceGuidelines.
>> > html#_Toc170119662
>> >
>> >
>> >
>> > Unfortunately our current draft is in conflict with this regulation. I
>> > suppose that we should comply..
>> >
>> >
>> >
>> > Thanks
>> >
>> > dF
>> >
>> >
>> > Dr. David Filip
>> >
>> > =======================
>> >
>> > LRC | CNGL | LT-Web | CSIS
>> >
>> > University of Limerick, Ireland
>> >
>> > telephone: +353-6120-2781
>> >
>> > cellphone: +353-86-0222-158
>> >
>> > facsimile: +353-6120-2734
>> >
>> > mailto: david.filip@ul.ie
>> >
>> >
>>
>>
>>
>> --
>>
>> /chet
>> ----------------
>> Chet Ensign
>> Director of Standards Development and TC Administration
>> OASIS: Advancing open standards for the information society
>> http://www.oasis-open.org
>>
>> Primary: +1 973-996-2298
>> Mobile: +1 201-341-1393
>>
>> TC Administration information and support is available at
> http://www.oasis-
>> open.org/resources/tcadmin
>>
>> Follow OASIS on:
>> LinkedIn:    http://linkd.in/OASISopen
>> Twitter:        http://twitter.com/OASISopen
>> Facebook:  http://facebook.com/oasis.open
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: xliff-unsubscribe@lists.oasis-open.org
>> For additional commands, e-mail: xliff-help@lists.oasis-open.org
>
>



--

/chet
----------------
Chet Ensign
Director of Standards Development and TC Administration
OASIS: Advancing open standards for the information society
http://www.oasis-open.org

Primary: +1 973-996-2298
Mobile: +1 201-341-1393

TC Administration information and support is available at
http://www.oasis-open.org/resources/tcadmin

Follow OASIS on:
LinkedIn:    http://linkd.in/OASISopen
Twitter:        http://twitter.com/OASISopen
Facebook:  http://facebook.com/oasis.open

---------------------------------------------------------------------
To unsubscribe, e-mail: xliff-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: xliff-help@lists.oasis-open.org