Creating Suite Definitions and Suite Terminology

Previous | Chapter contents | Next | Book PDF

The Structure of a Suite Terminology

The property list for a suite terminology also consists of a series of nested dictionaries. Many of the subdictionaries (class, command, argument, and so on) should have counterparts in the suite definition.

Terminology Dictionary

Key	Value Type or Reference	Description
"Name"	NSString or NSArray of NSStrings	Human-readable name of suite (required)
"Description"	NSString	Human-readable description of suite (optional)
"Classes"	See Class List Terminology Dictionary	Required only if there is a corresponding definition
"Commands"	See Command List Terminology Dictionary	Required only if there is a corresponding definition
"Synonyms"	See Class Synonym List Terminology Dictionary	Required only if there is a corresponding definition

Class List Terminology Dictionary

Key	Reference	Description
" className "	See Class Terminology Dictionary	One per each scriptable class. Must be the name of an Objective-C or Yellow Box Java class.

Class Terminology Dictionary

Key	Value Type or Reference	Description
"Name"	NSString or NSArray of NSStrings	Human-readable name of class (required)
"Description"	NSString	Human-readable description of class (optional)
"PluralName"	NSString	Human-readable name for plural form of class (required)
"Attributes"	See Property List Terminology Dictionary	Attributes (properties) of the class (required only if there is a corresponding definition)

Property List Terminology Dictionary

Key	Reference	Description
" propertyName "	See Property Terminology Dictionary	Description of attribute (property) or relationship (element) of the class

Property Terminology Dictionary

Key	Value Type or Reference	Description
"Name"	NSString or NSArray of NSStrings	Human-readable name of property (required).
"Description"	NSString	Human readable description of property (optional)
"Sex"	NSString or NSArray of NSStrings	"masculine", "feminine", or "none" (default).
"Number"	NSString or NSArray of NSStrings	"plural" or "singular" (default).

Command List Terminology Dictionary

Key	Reference	Description
" className "	See Command Terminology Dictionary	Description of command supported by class.

Command Terminology Dictionary

Key	Value Type or Reference	Description
"Name"	NSString or NSArray of NSStrings	Human-readable name of command (required)
"Description"	NSString	Human-readable description of command (optional)
"IsVerb"	NSString or NSArray of NSStrings	"No" or "Yes" (default)
"Arguments"	See Argument List Terminology Dictionary	Description of command arguments (required only if there is a definition)

Argument List Terminology Dictionary

Key	Reference	Description
" argumentName "	See Agument Terminology Dictionary	Descriptions of command arguments.

Agument Terminology Dictionary

Key	Value Type or Reference	Description
"Name"	NSString or NSArray of NSStrings	Human-readable name of argument (required)
"Description"	NSString	Human-readable description of argument (optional)
"Sex"	NSString or NSArray of NSStrings	"masculine", "feminine", "none" (default)
"Number"	NSString or NSArray of NSStrings	"plural" or "singular" (default)

Class Synonym List Terminology Dictionary

Key	Reference	Description
" Apple event code "	See Class Synonym Terminology Dictionary	Descriptions of Apple event code synonyms for class

Class Synonym Terminology Dictionary

Key	Value Type or Reference	Description
"Name"	NSString or NSArray of NSStrings	Human-readable name of class (required)
"Description"	NSString	Human-readable description of class (optional)
"PluralName"	NSString	Human-readable name of plural form of class (required)

Creating Suite Definitions and Suite Terminology

Previous | Chapter contents | Next | Book PDF