Clamps Packages
Reading the Documentation
The Clamps Packages Documentation aims to explain the concepts of the different parts of Clamps with some examples. For that reason, the table of contents is ordered systematically.
Although each of the chapters can be considered an introduction to exemplify how to use the part it describes, it is not a thorough presentation of all components of the API of the package. It should nevertheless provide enough information to get a rough understanding of the concepts to be able to start using it.
The Clamps Dictionary is the place to go to get a more complete picture of the API. The sections of the Clamps Package Documentation provide links to the dictionary in many places.
The reader is encouraged to go back and forth between these documentation sources, use the cross-references in the dictionary, or even consult the source code.
Due to this open concept there is no preferred sequence to read the Clamps Packages Documentation. Nevertheless, some parts depend on the knowledge of other parts of the documentation. As an example, the cm-sfz part can only be understood, when the concept of the cl-sfz package is known.
Below is a graph of dependencies of the clamps packages. External packages are colored with a light red background. Although not strictly required, it might be advisable or sometimes even necessary to follow the arrows when reading through the documentation. The reader may construct her or his individual reading path from this graph according to personal preferences and interests.
