Throughout the tutorial and reference section of this document, the following notation is used to mark keywords of the scene description language, command line switches, INI file keywords and file names.
|
mono-spaced bold |
POV-Ray keywords and punctuation |
+H480 |
mono-spaced bold |
command-line switches |
|
mono-spaced |
file names, directories, paths |
|
SYNTAX_ITEM |
italics, all caps |
required syntax item |
|
[SYNTAX_ITEM] |
italics, all caps, braces |
optional syntax item |
|
SYNTAX_ITEM... |
italics, all caps, ellipsis |
one or more syntax items |
|
[SYNTAX_ITEM...] |
italics, all caps, braces, ellipsis |
zero or more syntax items |
|
Value_1 |
italics, mixed case |
a float value or expression |
|
<Value_1> |
italics, mixed case, angle braces |
a vector value or expression |
] |
bold square braces |
ITEM enclosed in required braces |
|
ITEM1 | ITEM2 |
vertical bar |
choice of ITEM1 or ITEM2 |
In the plain ASCII version of the document there is no visible difference between the different notations.
Note that POV-Ray is a command-line program on MS-Dos, Unix and other text-based operating system and is menu-driven on Windows and Macintosh platforms. Some of these operating systems use folders to store files while others use directories. Some separate the folders and sub-folders with a slash character (/), back-slash character (\), or others. We have tried to make this documentation as generic as possible but sometimes we have to refer to folders, files, options etc. and there's no way to escape it. Here are some assumptions we make...
1) You installed POV-Ray in the "C:\POVRAY3" directory. For MS-Dos this is probably true but for Unix it might be "/usr/povray3", or for Windows it might be "C:\Program Files\POV-Ray for Windows", for Mac it might be "MyHD:Apps:POV-Ray 3:", or you may have used some other drive or directory. So if we tell you that "Include files are stored in the \povray3\include directory," we assume you can translate that to something like "::POVRAY3:INCLUDE" or "C:\Program Files\POV-Ray for Windows\include" or whatever is appropriate for your platform, operating system and installation.
2) POV-Ray uses command-line switches and INI files to choose options in all versions but Windows and Mac also use dialog boxes or menu choices to set options. We will describe options assuming you are using switches or INI files when describing what the options do. We have taken care to use the same terminology in designing menus and dialogs as we use in describing switches or INI keywords. See your version-specific documentation on menu and dialogs.
3) Some of you are reading this using a help-reader, built-in help, web-browser, formatted printout, or plain text file. We assume you know how to get around in which ever medium you're using. We'll say "See the chapter on "Setting POV-Ray Option" we assume you can click, scroll, browse, flip pages or whatever to get there.