Being a WIKI there will be considerable differences in style between authors in making component reference pages. These are personal notes based on having been the first person to generate a large number of component reference pages. I based this style on following the examples given by the developers and extended it slightly based on my initial experience writing them. This in not intended to be a ‘rule book’ it’s just to show what I’ve tried to follow.
The following are the standard elements of a component reference:
The inputs are listed. If there are at least two, a list may be used where appropriate. If there is a list it should include the name in bold and the hint in italics as well as the data type and a description of what it does if it is not self evident from the name and hint. Here are three example list items:
Simlar to inputs excepting outputs have only hints and not names. Here are two examples:
A screenshot and OSM file demonstrating a common use or other means on demonstrating the functionality of the component. Links within the SynthMaker website that directly demonstrate via examples may be listed here also.
A text description of other features not captured by the ‘Inputs’ and ‘Outputs’ sections.
If said component is a module and not a primitive, a user-made version of the module may be posted here. A terse/short and helpful listing of the changes can go here, but there is a lengthy explanation/tutorial for it, then both the text & file should be hosted under User Creations, and a link to it placed here.
If said component is a key ingredient for an (optimized) module, then it may be linked under the See Also heading.
External links for components that require technical reference to technologies not limited to SynthMaker. Possible examples include: MIDI, assembly or C language, ASCII, HTML, ASIO, VST standards, etc..
External and internal links for indirectly related examples and tutorials for the components. Also a “grab bag” of miscellaneous links that don’t fit in any other categories.