RE: [cti] Suggested formatting for normative text

Right now we are using Google docs to collect normative text. I’m not sure all of the formatting options used in the OASIS spec docs are available – but I’m new to Google docs

From: Chet Ensign [mailto:chet.ensign@oasis-open.org]
Sent: Wednesday, February 10, 2016 2:48 PM
To: Piazza, Rich <rpiazza@mitre.org>
Cc: cti@lists.oasis-open.org
Subject: Re: [cti] Suggested formatting for normative text

HI Rich,

One thing to keep in mind is that we put new cover pages on your drafts when publishing TC work products. So I suggest you not modify existing styles as it is very likely we'll end up wiping out those changes when we publish. Also, you should stick to using the header styles that come with the spec templates. Doing examples and such as you describe shouldn't pose any problem.

/chet

On Wed, Feb 10, 2016 at 2:41 PM, Piazza, Rich <rpiazza@mitre.org> wrote:

As we start writing normative text in Google docs we should agree about some basic rules for formatting and naming, so we don’t have to fix it later (coming from someone who had to do that to 15 STIX documents and 94 CybOX documents….).

Here are is what we are currently doing for formatting:

·         Use Arial/11pt for basic text.

·         Use the provided header styles

·         Use Consolas/11pt for JSON examples (color: RGB(199, 37, 78)) with background (color: RGB(249, 242, 244))

·         Property names in bold

For naming, we haven’t been consistent… here is a list of proposed rules

·         Type names do not have the “Type” suffix

·         Type names are camel case

·         Property names are all lower case, using dashes, not underscores.

Should type names and property names be in a special font and/or color?   Currently it is the same as the JSON examples.

Comments?

/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

cti message