C

C++ keyword

The C++ keywords used in the CommonPoint application system are:.

      asm
    
      delete
    
      if
    
      reinterpret_cast
    
      true
    
      auto
    
      do
    
      inline
    
      return
    
      try
    
      bool
    
      double
    
      int
    
      short
    
      typedef
    
      break
    
      dynamic_cast
    
      long
    
      signed
    
      typeid
    
      case
    
      else
    
      mutable
    
      sizeof
    
      union
    
      catch
    
      enum
    
      namespace
    
      static
    
      unsigned
    
      char
    
      extern
    
      new
    
      static_cast
    
      using
    
      class
    
      false
    
      operator
    
      struct
    
      virtual
    
      const
    
      float
    
      private
    
      switch
    
      void
    
      const_cast
    
      for
    
      protected
    
      template
    
      volatile
    
      continue
    
      friend
    
      public
    
      this
    
      wchar_t
    
      default
    
      goto
    
      register
    
      throw
    
      while
    

When using non with a C++ keyword, always hyphenate.

    You must cast your this pointer to non-const to make changes to the internal object state.
See
"non" on page 52 for more information about using C++ keywords with the prefix non. See "computer voice" on page 16 for information about using C++ keywords in computer voice.

callout

For information about callouts, see the Taligent Publications Handbook.

cancel

Note one l.

cancelability

Do not use this term. Instead, use ability to cancel.

cannot

Use instead of can not.

capitalization

Too many capitalized words on a page can be difficult to read. Use these guidelines.

Capitalizing book titles

In book titles, capitalize all significant words.

Capitalize:

    See "hyphen" on page 31.
Do not capitalize:

Capitalizing chapter titles and heads

Capitalize chapter titles and heads in sentence style (also called downstyle).

Capitalize:

Capitalizing glossary terms

If the term is a proper noun,
capitalize the first letter.

If the term is an uppercase abbreviation, or a software term that is case sensitive, present it as it should appear in the text.

Capitalization of human interface elements

Capitalize human interface elements, such as names of buttons and labels as they appear onscreen. Capitalization of interface elements differs from capitalization of terms used to describe those elements. In other words, do not capitalize "Command Button" when you describe this type of button in text. But you do capitalize a button's label, such as Print Now.

See Taligent Human Interface Guidelines for more information about human interface elements.

Capitalization of part dividers

Capitalize part dividers in sentence style (also called downstyle).

Capitalize:

Capitalizing text

Use initial captial letters in text for:

Do not capitalize:

See individual entries for capitalization of specific acronyms, abbreviations, and technical terms.

Capitalizing index entries

Don't capitalize any words in an index entry unless the word is a proper noun, an acronym, or an abbreviation that is supposed to be capitalized.

Capitalizing CommonPoint terms

Capitalize proper names of CommonPoint application systems, subsystems, and frameworks. For example, use:

See The New Taxonomy for information about individual system, subsystem, framework, and category names.

caption

Use captions only when essential to identify figures, tables, or code samples you must refer to in text. Capitalize captions as you would a sentence (downstyle--the first word with an initial capital, and subsequent words lowercase). Captions should not be complete sentences--use punctuation only if needed.

Use caption numbers only for documentation sets where they are defined as the standard. Caption numbers are sequential throughout each book but are broken into individual categories of figures, tables, and code.

For more information about captions, see the Taligent Publications Handbook.

Cartesian

(modifier) Note capitalization.

catastrophic error

Do not use this term. Instead, use irrecoverable error.

caution

Use the caution symbol to indicate that data or equipment might
be damaged.

CAUTION Closing the file without saving could cause you to lose data.

CD

When the context is clear, use the abbreviation because it is more commonly recognized than compact disc. Do not use compact disk.

CD-ROM

When the context is clear, use the abbreviation because it is more commonly recognized than compact disc read-only memory. Use the abbreviation as a noun or modifier, hyphenated and capitalized.

centigrade (°C)

Abbreviate units of measure when using them with a number to indicate a specific measurement.

centimeter (cm)

Abbreviate units of measure when using them with a number to indicate a specific measurement.

CPU

When the context is clear, use the abbreviation because it is more commonly recognized than central processing unit.

checkbox

Do not hyphenate. Always write as one word.

check in

(verb)

check-in

(modifier)

checklist

Do not hyphenate. Always write as one word.

checkmark

Do not hyphenate. Always write as one word.

check out

(verb)

check-out

(modifier)

class

A class is a C++ vehicle for translating a data abstraction to a user-defined type. Do not use class when you mean object or instance. See "instance" on page 34 and also "object" on page 55.

clean up

(verb)

cleanup

(modifier, noun)

client-server

(modifier) Note hyphenation.

clockwise (cw)

Spell out on first occurrence.

COBOL

Use the acronym because it is more commonly recognized than common business-oriented language.

code font

See "computer voice" on page 16.

colon

The colon provides a break between information indicating that what follows is an elaboration, summation, example, or interpretation of what precedes. In technical documentation, that relationship is almost always limited to the introduction of a list, a phrase, or another sentence.

Introducing lists

Use a colon to introduce a list of items within a sentence when that list is relatively short.

    Software developers must weigh this minor limitation against three factors: faster development time, smaller code size, and greater ease of modification.
Use a colon with a sentence fragment introducing a list of items in a bulleted list or numbered list. See
"list" on page 41 for more information about bulleted and numbered lists.

Introducing quotations, questions, and statements

Use the colon to separate one clause from a second clause that illustrates or amplifies the first.

Do not capitalize the first word following a colon, even if the phrase following the colon is a complete sentence.

    Object orientation is to the 1990s what structured programming was to the 1970s: a new and important paradigm for improving software construction, maintenance, and use.

color/graphics adapter (CGA)

Spell out on first occurrence.

comma

A comma provides a pause in the flow of text and separates or sets off elements in a sentence. The comma is the most often used punctuation mark, however it is sometimes overused. When in doubt, check with an editor.

Separating items in a series

Insert a comma between three or more items in a series, and always include a comma before the last element in the series to avoid ambiguity. The conjunction does not replace the final comma in the series.

    Text elements in program interfaces include menu items, labels, editable fields in dialogs, spreadsheet cells, and documents.
If an item in a series contains two parts joined by and or or, move it to the front
to avoid confusion, and hyphenate the compound modifier joined by and.

    Locate the black-and-white, green, and red wires. (3 items in series)
    Locate the green, red, black, and white wires. (4 items in series)
If a series contains internal punctuation, use semicolons rather than commas to separate the items.

    They have offices in Portland, Oregon; Springfield, Illinois; Boulder, Colorado; and Kansas City, Missouri.

Separating dependent and independent clauses

Use a comma to separate:

    Enclose text in commas when it is not essential to the sentence, but just adds more information about the subject.
      These 2-D classes, part of the GrafEdit Framework, provide all the functionality needed for this application.
    Do not separate restrictive clauses with commas. Note the difference in meaning in these phrases:
      The employees who worked hard were rewarded.
      The employees, who worked hard, were rewarded.
  1. Appositives
    Appositives are words that follow a noun or pronoun and identify it. Set off nonrestrictive (nonessential) appositives with commas.
      The third candidate, a developer with ten years of experience, was hired.
      They looked it up in the user's guide, a well-written document full of useful information.
    Do not set off restrictive (essential) appositives.
      My sister Susan wrote the manual.
      Scott Meyer's book Effective C++ is highly recommended.
For more on restrictive and nonrestrictive clauses, see "that" on page 74. See also "dash" on page 19 and "parentheses" on page 57.

NOTE You can also use dashes or parentheses to set off parenthetical material, especially if it is not essential to the sentence.

    Any virtual function calls execute the base class virtual functions, not the overriding functions in the--as yet unconstructed--derived class.
    Occasionally some initialization associated with the base class must be done using derived class (overriding) virtual functions.

Separate items in addresses, dates, and numbers

Use a comma to separate items of equal value in:

Keep in mind that in other languages numbers are punctuated differently.

CommonPoint

Do not use Taligent when you mean CommonPoint.

    Rather than: The Taligent classes that comprise the File
    System interface...
    Write: The CommonPoint classes that comprise the File
    System interface...
See Legal Guidelines for information about how to properly trademark and use this term.

CommonPoint application system

The current name for Taligent's first product. Note capitalization. See Legal Guidelines for a list of Taligent trademarks.

computer-aided design (CAD)

Spell out on first occurrence.

computer-aided engineering (CAE)

Spell out on first occurrence.

computer-aided instruction (CAI)

Spell out on first occurrence.

computer-aided manufacturing (CAM)

Spell out on first occurrence.

computer voice

Computer voice is a separate font or style used to indicate a computer language or program. This type of information includes code samples, computer language elements, and program listings. Taligent uses monospace Taligent Mono to differentiate computer voice.

Using computer voice in heads

Avoid using computer voice in headings. If you cannot avoid them, apply the font change.

Using computer voice in running text

Use computer voice consistently for:

Do not use computer voice for:

See the Taligent Publications Handbook for more information about using computer voice. See "C++ keyword" on page 9 for more information about C++ keywords.

constructive area geometry (CAG)

Spell out on first occurrence.

constructive solid geometry (CSG)

Spell out on first occurrence.

contraction

Use a contraction when the rhythm and flow of a sentence would be disrupted by the noncontracted form. For more information about forming contractions, see "apostrophe" on page 4.

copyright

See Legal Guidelines for current copyright information.

cosecant (csc)

Spell out on first occurrence.

cosine (cos)

Spell out on first occurrence.

cotangent (cot)

Spell out on first occurrence.

counterclockwise (ccw)

Spell out on first occurrence.

crossbar

Do not hyphenate. Always write as one word.

crosshair

Do not hyphenate. Always write as one word.

cross-reference

(noun, verb) Always hyphenate the word cross-reference. A cross-reference can be internal, to another section of the document, or external, to other documentation.

Rather than using vague expressions, such as "the guidelines discussed earlier," tell the reader exactly which chapter or section to refer to by including the chapter number, the title, or the number and title.

Never use cross-references to convey vital information, such as safety precautions or important steps to follow. Restate the information where it is needed.

For detailed guidelines, see Taligent Publications Handbook.

cross section

(noun)


[Contents] [Previous] [Next]
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.

Generated with WebMaker