Abbreviations (used as a “see also” pointing at expanded term)
Only include the abbreviated term in the related terms of the expanded term. Do not include the abbreviated term in other terms.
For example, Newton Toolkit should list NTK as a related term because it is the actual abbreviation for Newton Toolkit.
However, project build should list Newton Toolkit, not NTK.
Abbreviations (more common than the expanded term)
For example, PCMCIA is an acronym that is more commonly used than its expanded variation — Personal Computer Memory Card International Association. In this case, the expanded term would be included as the first part of the abbreviation’s entry.
Whenever possible, use the longer version of a term for clarity.
- Use “telephone” not “phone”
- Use “operating system” not “system”
- Use “Newton device” not “Newton”
- Use “Newton OS” not “NOS”
Referring to other terms
- Also referred to as …
Use if the referenced term is as common or less common than the source term. In some cases, such as a nickname or alternate spelling, the more personal phrase “Also known as …” can be used.
- Commonly referred to as …
Use if the referenced term is more common than the source term.
- Mistakenly referred to as …
Use if the referenced term is an commonly misspelled or mangled version of the source term.
- Colloquially referred to as …
Use if the referenced term is a quirky or derogatory name for the source term.
Capitalization of terms
Indicating menu items, windows, slips, and other named user interface elements
Other than using their proper capitalized names, should these items be wrapped in quotes or styled in some other way?
- Ink words are created when the user has selected Ink Text in the “Recognition Preferences” slip.
Introducing descriptive elements of a term
Do not use generic nouns such as “kind” when introducing a descriptive element relating to a terms.
- A kind of flash memory.
Instead, use a more specific noun.
- A type of flash memory
- A method of handwriting recognition
- A style of font
Minimize the use of subjective hyphenated terms.
- Use “finite state” instead of “finite-state”
- Use “frontend” instead of “front-end”
Acceptable hyphenated terms include:
When describing the effects of an action, use the more enabling term “can” rather than “may”.
- A slip where preferences can be adjusted.
- Only one button can be selected at a time.
Links to additional information
When linking to the main page of a website, include both the website name and “Website” as part of the link text.
When linking to a specific article or resource on a website, use the full name or title of the article or resource — prefixed with the source website — as the link text.
- Apple: The NewtonScript Programming Language (PDF)
- UNNA: The NewtonScript Programming Language (PDF)
- Wikipedia: GeoPort
If the link points to an Internet Archive mirror of the original website, article, or resource, prefix the link text as such.