Re: [cti] Suggested formatting for normative text

>I would actually like to distinguish them more, to be honest, at least in the spec. As it is, it’s very hard to tell the difference between a field name and a type name. My preference would be to keep our current structure for naming but use a different >formatting rule for type names, field names, and string literals.

From: <cti@lists.oasis-open.org> on behalf of John Wunder <jwunder@mitre.org>
Date: Thursday, February 11, 2016 at 8:46 AM
To: "cti@lists.oasis-open.org" <cti@lists.oasis-open.org>
Subject: Re: [cti] Suggested formatting for normative text

If we pick one, we shouldn’t use dashes, which are not valid characters in many programming language variables (hence why field names are underscores).

I would actually like to distinguish them more, to be honest, at least in the spec. As it is, it’s very hard to tell the difference between a field name and a type name. My preference would be to keep our current structure for naming but use a different formatting rule for type names, field names, and string literals.

From: Mark Davidson <mdavidson@soltra.com>
Date: Thursday, February 11, 2016 at 7:53 AM
To: "Wunder, John A." <jwunder@mitre.org>, Rich Piazza <rpiazza@mitre.org>, "cti@lists.oasis-open.org" <cti@lists.oasis-open.org>
Subject: Re: [cti] Suggested formatting for normative text

Type names are all lowercase, using dashes, e.g. “attack-pattern”. These type names, when used in JSON, appear exactly the same.
Property names are all lowercase, using underscores, e.g. “created_by_ref”

Is there a reason why everything couldn’t just be the same? Remembering the names of all the things in STIX/TAXII is hard enough, I’d rather not add a thing to remember if we don’t have to. My vote would be for all lowercase, all dashes.

Thank you.

-Mark

From: <cti@lists.oasis-open.org> on behalf of "Wunder, John A." <jwunder@mitre.org>
Date: Wednesday, February 10, 2016 at 2:48 PM
To: "Piazza, Rich" <rpiazza@mitre.org>, "cti@lists.oasis-open.org" <cti@lists.oasis-open.org>
Subject: Re: [cti] Suggested formatting for normative text

Hm, I would not have said these same things. We had a short discussion in the doc comments earlier, my assumption was:

Type names are all lowercase, using dashes, e.g. “attack-pattern”. These type names, when used in JSON, appear exactly the same.
Property names are all lowercase, using underscores, e.g. “created_by_ref”
String enum values, e.g. relationship value/nature, are lowercase using dashes, e.g. “has-source"

From: <cti@lists.oasis-open.org> on behalf of Rich Piazza <rpiazza@mitre.org>
Date: Wednesday, February 10, 2016 at 2:41 PM
To: "cti@lists.oasis-open.org" <cti@lists.oasis-open.org>
Subject: [cti] Suggested formatting for normative text

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?

cti message