search

AICC / CMI-5_Spec_Current

cmi5
http://adlnet.gov
Apache License 2.0
181 stars 91 forks source link

Apply Section 1.2 Style Conventions from document start to Section 7.1.3 #778

Closed MartinKoob closed 1 year ago

MartinKoob commented 1 year ago

This is based on discussion from cmi5 Working Group on Mar 3, 2023

MartinKoob commented 1 year ago

Meeting Minutes from Mar 3, 2023 https://github.com/AICC/CMI-5_Spec_Current/wiki/CMI-5-Working-Group-Meeting-Minutes-–-March-3rd%2C-2023

MartinKoob commented 1 year ago

I am wondering whether we need quotes around the terms "cmi defined", "cmi5 allowed", "cmi5 not-allowed" where the terms are first defined.

In our discussion last week it was decided to remove the quotes and bold the terms for emphasis. 

* **cmi5 defined** - Statements using cmi5 defined verbs, category id as defined in section 9.6.2.1, and context template.
 * **cmi5 allowed** - Statements using any verb and cmi5 context template (but NOT including cmi5 category id as defined in section 9.6.2.1).
 * **cmi5 not-allowed** - Any statements not conforming with the cmi5 specification.

Should we have the quotes here too so it is consistent with the rest of the document.

* **"cmi5 defined"** - Statements using cmi5 defined verbs, category id as defined in section 9.6.2.1, and context template.
 * **"cmi5 allowed"** - Statements using any verb and cmi5 context template (but NOT including cmi5 category id as defined in section 9.6.2.1).
 * **"cmi5 not-allowed"** - Any statements not conforming with the cmi5 specification.