Use Non-Frames Version Previous Page Next Page
Using the Manual

How to use the HTML Edition of the Csound Manual


The Csound Manual

The Csound Manual is arranged as a reference manual (not a tutorial), since that is the form the user will eventually find most helpful when inventing instruments. Csound can be a demanding experience at first. Hence it is highly advisable to peruse the tutorials available from The Csound FrontPage. Once the basic concepts are grasped from the beginning tutorials, the reader might let himself into the remainder of the text by locating the information presented in the Reference entries that follow.

Navigating the HTML Edition

The HTML Edition is designed to resemble, in both style and substance, the Csound Manual available in Adobe Acrobat (.pdf) available from the editor's website.

The manual is started by loading "manual.htm". The Contents Pane to the left gives the user ready access to any page in the manual. This acts as a fully linked Table of Contents and Index. While the manual is designed primarily for browsers that support frames, users with non-frames browsers may load the file "manual2.htm" instead of "manual.htm".

The HTML Edition is divided into sections, following the pattern established by the Version 4.16 Acrobat Edition. As in the Acrobat Edition, each major category of opcodes has its own section of the manual. In the HTML Edition, however, each section consists of files placed in separate subdirectories.

The frames version of the HTML Edition is divided into two vertical frames. The frame on the left contains the Table of Contents and Index, while the frame on the right contains the manual page. The bar dividing the two frames can be dragged left or right, if desired, to provide more or less space in each frame.

The Table of Contents and Index

The Table of Contents contains a link to each section of the manual. When a section corresponds to a category of opcodes, the link will usually take you to the Quick Reference for that category. Some categories of opcodes have an introductory page of material, for example, the zak or spectral opcodes. In this case the Table of Contents link will take you to the introductory page. Then the Quick Reference can be accessed with the category link in the left-hand corners (see below).

Near the top of the Table of Contents is a link to the Index. The index lists each opcode, function, operator, and important Csound concepts alphabetically. Of course, each entry in the Index is also a link to the appropriate manual page.

Navigating Between Manual Pages

At the top and bottom of each page are three navigation buttons. If a particular button is not active for that page, it will be rendered in gray. The buttons are as follows:

Next Page Button Go the the next page. The manual is laid out in such a fashion, that using this button, it would be possible to begin at the Title Page, and scroll though the entire manual in the order the of the Acrobat Edition.
Previous Page Button Go to the previous page.
Use Non-Frames Version Go to the Main Page for the non-frames version of the manual. This may be of limited usefulness to those using the frames version, but is needed for the non-frames version. Clicking on this button from the frames version will remove the frames, and switch to the non-frames version. To return to the frames version, click on "Use Non-Frames Version" at the end of the Table of Contents.
Previous Page Button An example of an inactive button.

A new feature, beginning with Version 4.16, is the section heading in the left-hand top and bottom corners of each page. This indicates the section to which that page belongs, and corresponds to that section in the Acrobat Edition. This heading serves as a link to the corresponding section of the Quick Reference.

A Word About Browser Rendering

The HTML files have been designed relatively simply, in order to give the user the greatest latitude in determining how the manual should look. That said, the user may wish to turn off link underlining, for the sake of clarity and readability. There are many links in this document, and some pages, such as the Index and Table of Contents, have a them in high density. Underlining of all those links can become visually distracting.

Bug Reports

We have worked to make this manual as accurate as possible. Errors, however, will happen. If you find a bug, an error, or omission, please report it to the editor.

We hope you find this manual useful in your Csound adventures.

David M. Boothe
Dallas, Texas
Version 4.16
November, 1999
csound@lakewoodsound.com


Use Non-Frames Version Previous Page Next Page
Using the Manual