Manual Conventions

• Typographical Conventions
• Page Tags
• Hypertext Conventions

Typographical Conventions

The manual uses these typographical conventions:

Monospace font is used for

• program text (e.g., void main(void){}),
• command-line text (e.g., ls -l).

Bold font is used for

• GUI button names (e.g., OK).

Italic font is used for

• introduction of new terminology (e.g., file instance),
• placeholders (e.g., 'file-name '::function-name::identifier),
• emphasis (e.g., lists all uses).

Lime green highlighting

is used when a hyperlink's target is a section within a page (rather than the page itself), to indicate the beginning of the relevant section. (Not all browsers support this feature. To check whether your browser does, click here to see whether the words "lime green highlighting" become highlighted.)

Background coloring is used to mark certain blocks of text:

• Blocks of program code are displayed with pale yellow backgrounds:
  int square(int x){
  

  return x*x;
  

  }
  
• Entire command-line commands are displayed with pale green backgrounds:
  ls -l
  

Page Content Tags

Many pages contain one or more tags above the page title indicating the applicability of the page content. The tags are descibed in the following table.

Hypertext Conventions

The optional frame on the left side of the window contains either Contents, Index, or Search. The bar at the top of the frame contains two icons that, when clicked, navigate backward and forward through the text in reading order.

The manual is organized hierarchically, as shown in the Contents. You can navigate through the hierarchy by clicking on sections in the Contents. The current page is always indicated by the line selected in the Contents.

The tag on an image indicates that different areas of the image are hyperlinked to relevant information.

The icon indicates an external link: one to a location outside the CodeSonar installation.

In cases where a hyperlink's target is a section within a page rather than the page itself, the beginning of the relevant section will be displayed with lime green highlighting.