10.1 Key Codes:
10.1.2.2 Key Code (required) <dd:km kc:kc>
example: rho (gas density)
10.1.2.2.1 Key Code Symbol <dd:km kc:kcsym>
example: ρ (rho)
10.1.2.2.2 Key Code Label <dd:km kc:kclabel>
example: Density
10.1.2.2.3 Key Code Mnemonic <dd:km kc:kcmn>
example: kcsym (see item in barckets at 10.1.2.2.1 above)
10.1.2.2.4 Key Code Title <dd:km kc:kctitle>
example: "Nominal Gas Density "
This should be a meaningful, but not exhaustive, title of the key code data item and while it may nor be unique within the Data Dictionary it should not be confusing with closely coupled data items which are likely to be used “nearby
10.1.2.2.4 Units (?)
10.1.2.3 Abstract <dd:km kc:kcabs>
This should be a terse, non-definitive summary of the nature and use of the data variable suitable for “pop-ups” and help screens. A full explanation should be reserved for the Description.
10.1.2.4 Key Code Description <dd:km kc:kcdesc>
This should be a reasonably complete explanation of the data item. There is no shame in to reusing other peoples work – however, citation and attribution must be made, as well as some assurance the reference can be found.
10.1.2.5 Key Code Function <dd:km kc:kcfunc>
This is the defining algebraic form of the key code symbol.
10.1.2.6 Key Code Derivation <dd:km kc:kcderiv>
For keycodes which have mathematical significance (i.e. are mathematical expressions and can be calculated directly, with numerical methods or simply can be expressed with mathematical principles) the reference to derivation of the keycode should be include. Simpler models may derived as part of the Data Dictionary reference page but this should only be done in the shortest of derivations.
Full attribution of the derivation is not only a courtesy – it is a ethical requirements and plagiarism is one of the few misdemeanors that will be cause for direct action by the HRI community.
10.1.2.7a Defining codes <dd:km kc:kcincodes>
10.1.2.7b Derived codes <dd:km kc:kcoutcodes>
10.1.2.8 XML configuration <dd:km kc:kcxmlfile>
10.1.2.9 Technical Authority <dd:km kc:kctechauth>
10.1.2.10 Signing Authority <dd:km kc:kcsig>
10.1.2.11 Citations <dd:km kc:kcrefs>
10.1.2.12 Tutorial <dd:km kc:kctutorial>
10.1.2.13 Procedures
10.1.2.14 Revision History <dd:km kc:kcrevrecord>
10.2.2.15 Security Classification <dd:sec kc:class>
-------- BLANK KC TEMPLATE ----------------------
10.1.2.2 Key Code: xxx
10.1.2.2a Key Code Symbol: X
10.1.2.2b Key Code Label: xxx
10.1.2.2c Key Code Mnemonic: ddkc
10.1.2.2d Key Code Title: xxxx
10.1.2.3 Abstract:
10.1.2.4 Key Code Units xxx
10.1.2.5 Key Code Function
10.1.2.6 Key Code Derivation
10.1.2.7 Related Codes
-10.1.2.7a Defining codes
10.1.2.7b Derived codes
10.1.2.8 XML configuration
10.1.2.9 Technical Authority: xxx sigmaster
10.1.2.10 Signing Authority: xxx sigmaster
10.1.2.11 Citations: none
10.1.2.12 Tutorial
10.1.2.13 Procedures
10.1.2.14 Revision History <dd:km kc:kcrevrecord>
10.1.2.15 Security Classification <dd:sec kc:class>