Annotations in the Manual

There will be many examples in the manual to demonstrate the functionalities of GIVE. These examples will be shown in quotes, like below:

This will be an example with its code:

example.code = true

Code will be written in a monospace font. It is intended to be called from the console (such as bash or MySQL), included in actual files (like JavaScript or HTML), or used to indicate names of variables or types. Please replace code that is written in bold and italics, and enclosed in angle brackets (<>), with its corresponding value(s) according to the situation. Code in italics only corresponds to default values and can be replaced by proper values if needed. All other code is not supposed to be changed unless you know exactly what you are doing.

For example, the following code is supposed to be used in a MySQL-compatible console.

CREATE TABLE `<dbname>`.`<linear_track_table_name>` ( `fileName` varchar(255) NOT NULL );

While <dbname> and <linear_track_table_name> need to be replaced with their corresponding values, and 255 can be changed, everything else, including fileName and varchar, is not supposed to change.

Special notes will be shown in blocks separated by horizontal lines and written in italics and will typically appear with NOTE::

NOTE: This is a note. ***