1.4 How to read this document

In what follows, each description of a part of the system may be followed by a chunk of code like this one

<Example chunk of code. >= (U->)
class A_Class { ... };

Defines A_Class (links are to index).

In this example, the name of the chunk was ``Example chunk of code.'' The number on the right of the chunk name, also found on the left margin, identifies the chunk and will be used in cross-references. We will refer to such number as the ``chunk number''. Also, when an interesting entity has been defined by a chunk (A_Class in the example) it will be stated below the chunk using a small font.

The chunk number is made the page number (identifying in which page the chunk is defined) and, if necessary, a letter to distinguish between different chunks in the same page. Using this number one is able to quickly locate any chunk in the document.

Chunks of code can include other chunks, in this case, you can use the number enclosed with the chunk name between angles (i.e. ``'' and ``'') to locate quickly the code for the chunk being included. In this example, the chunk shown above will be included in chunk 3a. We then should use the chunk numbers found in the left margin to locate it.

<A chunk including another. >=
  // Some code...
  <Example chunk of code. >
  // And we also use A_Class
  A_Class an_object;

Finally, a chunk may be continued at a different part of the document. In this case it will be said explicitly below the chunk using a small font, as it can be seen below.

<Continuing chunk of code. >= [D->]
  //Mary had

<Continuing chunk of code. >+= [<-D]
  //a little lamb.

Note the use of the ``+'' to state that the chunk is a continuation.

Finally, we suggest reading this document as it is. Do not try to read it following the order understood by a C++ compiler. The references below each chunk will allow you to navigate through this program's web.