Terminology and Style Guide

This page contains style and terminology for how to describe elements within the Wiki, Code, and Interface for a consistent approach.

This is a constant work in progress, and is not complete. Items added here were added for clarity where a universal consensus may not exist.

Use active voice for documentation.

Where not found here, use of Google's Style Guide is generally accepted; though some deviations from their guide have been made in favor of other methods where appropriate.

Action / Descriptor Terms

The following are either excerpted or differ from the above style guide. Use these methods first. If you don't find what you need here, go to the above guide(s).

Item	Term	When used
Checkbox State	On (☑) Within Code: True	Checkbox has a check in it. For user-facing content: Use On (TagTips, Form Text, Wiki Documentation, etc.). For code comments: You may use True, as you will be working with the boolean value directly. NOTE: This differs from the Action performed on the Checkbox.
	Off (☐) Within Code: False	Checkbox is cleared. For user-facing content: Use Off (TagTips, Form Text, Wiki Documentation, etc.). For code comments: You may use False, as you will be working with the boolean value directly. NOTE: This differs from the Action performed on the Checkbox.
	Null	In some cases, checkboxes may allow a TripleState of Null; this may also be referred to as Indeterminate. See also Tri-State Null. Example: In permission lists, if a parent permission includes children, and some of the children are set to allow, and some are off/cleared, the parent may appear in an indeterminate state. All cases use: Null. Appears as a square or gray interior inside the checkbox instead of a checkmark or cleared state.
UI Action	Select	Chose the (Option name), set (Option name) checkbox state to True. Example: Select Use Fast Save to enable a significant performance boost.
	Clear	Clear (Option name) checkbox (set state to False), remove text. Example: Clear Use Fast Save to export all elements in your file every time.
Keyboard Keystrokes	<kbd>	Enclose keystrokes with the <kbd> tag. To group simultaneous keystrokes, use the + charachter. Example: Press <kbd>[Shift]+[Q]</kbd> to do a fancy thing. will render like this: Press [Shift]+[Q] to do a fancy thing.
	[]	Use of Square Brackets ([ ]) is desirable, especially within code comments as the <kbd> tag is not rendered in the VBA IDE, and to disambiguate between combined keystrokes and the [+] key. Example in Code: ' To break the execution of this function, Press [Ctrl]+[Break] or [Esc] Example Wiki: To close Access immediately, press [Alt]+[F4]
Text entry in fields		Enclose text entered by users with ` charachter (code formatting). Example: Type Potato into the Desired Food box.
Referencing Field	Bold	To refer to a field, use Bold (Markdown= **[stuff]**)
Action		Generally, the action performed does not need to be highlighted. Instead, highlight the Field or the Menu Item. Example: Goto the Options > Export tab. Select desired Sanitize Level.