Documentation:Tutorial Section 1.1 - Revision history

Jholsenback: consistency

2017-07-04T15:59:53Z

consistency

Jholsenback: corrections

2017-07-04T11:11:27Z

corrections

Jholsenback: clarity

2017-07-04T00:45:42Z

clarity

Jholsenback: typos

2017-07-04T00:15:51Z

typos

Jholsenback: updates

2017-07-04T00:01:07Z

updates

Jholsenback: saving work in progress

2017-07-03T12:29:04Z

saving work in progress

Clipka: /* Notation and Basic Assumptions */ update version number in file paths

2017-06-30T20:40:39Z

Notation and Basic Assumptions: update version number in file paths

Jholsenback: update

2016-07-16T17:03:59Z

update

Chrisc: /* Notation and Basic Assumptions */

2013-08-26T13:49:39Z

Notation and Basic Assumptions

Jholsenback: 1 revision: link repair after reference reorg

2012-07-01T11:59:57Z

1 revision: link repair after reference reorg

@@ Line 260: / Line 260: @@
    <li>{{Change}} followed by a version reference and designates a behavior change</li>
    <li>{{New}} followed by a version reference to designate feature addition</li>
-   <li>The generic form <code>vX.y.z</code> of the current version 3.8</li>
+   <li>The generic form <code>vX.y.z</code> of the version number and it's short form <code>vX.y</code> currently v3.8.0 and
 </ul>

@@ Line 224: / Line 224: @@
 ===Notation and Basic Assumptions===
-<p>Throughout the tutorial and reference books, a consistent notation is used to mark keywords of the scene description language, command line switches, INI file keywords and file names.</p>
+<p>Throughout the tutorial and reference sections, a consistent notation is used to mark keywords of the scene description language, command line switches, INI file keywords and file names.</p>
 <p><strong>For example:</strong></p>
 <p>Scene description language keywords and command-line switches:</p>
@@ Line 268: / Line 268: @@
 <p> Here are some additional assumptions to be found in the documentation:</p>
 <ol>
-<li>You installed POV-Ray in the default location (on Windows, binaries in <code>c:\Program Files\POV-Ray\vX.y.z</code> and include/scene files in <code>My Documents\POV-Ray\vX.y.z</code>).
+<li>You installed POV-Ray in the default location for Windows, with the binaries in <code>c:\Program Files\POV-Ray\vX.y</code> and include/scene files in <code>My Documents\POV-Ray\vX.y</code>.
-If we say 'include files are stored in the <code>include</code> directory', we mean the directory called 'include' located immediately within the folder which was used for documents (in the above case, it would be <code>My Documents\POV-Ray\vX.y.z\include</code>). We assume you can translate that to something like <code>/usr/local/share/povray-vX.y.z/include</code> (for Linux) or whatever is appropriate for your platform, operating system and personal installation.
+If we say 'include files are stored in the <code>include</code> directory', we mean the directory called 'include' located immediately within the folder which was used for documents, in the above case, it would be <code>My Documents\POV-Ray\vX.y\include</code>. We assume you can translate that to something like <code>/usr/local/share/povray/vX.y/include</code> for Linux or whatever is appropriate for your platform, operating system and personal installation.
 <li> POV-Ray uses INI files and/or command-line switches (if available) to choose options in all versions, but some platforms (e.g. Windows) 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, as it is consistent across all platforms (all GUI versions of POV-Ray also provide a means of accepting command-line options and reading INI files from within the GUI - generally speaking, the menus and dialogs just provide
 an easier means of doing the same thing).

@@ Line 256: / Line 256: @@
 </ul>
-<p>These additional annotations appear throughout the documentation:</p>
+<p>{{New}} in version 3.8 these additional annotations appear throughout the documentation:</p>
 <ul class="index">
-   <li>{{New}} generally followed by a version reference to designate feature addition</li>
+   <li>{{Change}} followed by a version reference and designates a behavior change</li>
-   <li>{{Change}} not always followed by a version reference and designates a behavior change</li>
+   <li>{{New}} followed by a version reference to designate feature addition</li>
-   <li>The generic form of the current version <code>vX.y.z</code></li>
+   <li>The generic form <code>vX.y.z</code> of the current version 3.8</li>
 </ul>

@@ Line 260: / Line 260: @@
    <li>{{New}} generally followed by a version reference to designate feature addition</li>
    <li>{{Change}} not always followed by a version reference and designates a behavior change</li>
-   <li>The generic form of the current version <code>vX.y</code></li>
+   <li>The generic form of the current version <code>vX.y.z</code></li>
 </ul>
@@ Line 268: / Line 268: @@
 <p> Here are some additional assumptions to be found in the documentation:</p>
 <ol>
-<li>You installed POV-Ray in the default location (on Windows, binaries in <code>c:\Program Files\POV-Ray\vX.y</code> and include/scene files in <code>My Documents\POV-Ray\vX.y</code>).
+<li>You installed POV-Ray in the default location (on Windows, binaries in <code>c:\Program Files\POV-Ray\vX.y.z</code> and include/scene files in <code>My Documents\POV-Ray\vX.y.z</code>).
-If we say 'include files are stored in the <code>include</code> directory', we mean the directory called 'include' located immediately within the folder which was used for documents (in the above case, it would be <code>My Documents\POV-Ray\vX.y\include</code>). We assume you can translate that to something like <code>/usr/local/share/povray-v.Xy/include</code> (for Linux) or whatever is appropriate for your platform, operating system and personal installation.
+If we say 'include files are stored in the <code>include</code> directory', we mean the directory called 'include' located immediately within the folder which was used for documents (in the above case, it would be <code>My Documents\POV-Ray\vX.y.z\include</code>). We assume you can translate that to something like <code>/usr/local/share/povray-vX.y.z/include</code> (for Linux) or whatever is appropriate for your platform, operating system and personal installation.
 <li> POV-Ray uses INI files and/or command-line switches (if available) to choose options in all versions, but some platforms (e.g. Windows) 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, as it is consistent across all platforms (all GUI versions of POV-Ray also provide a means of accepting command-line options and reading INI files from within the GUI - generally speaking, the menus and dialogs just provide
 an easier means of doing the same thing).

@@ Line 256: / Line 256: @@
 </ul>
-<p>These version specific annotations appear throughout the documentation:</p>
+<p>These additional annotations appear throughout the documentation:</p>
 <ul class="index">
    <li>{{New}} generally followed by a version reference to designate feature addition</li>
-   <li>{{Change}} not always followed by a version reference to designate a behavior change</li>
+   <li>{{Change}} not always followed by a version reference and designates a behavior change</li>
-   <li>A generic form of version information: <em>vX.Y</em></li>
+   <li>The generic form of the current version <code>vX.y</code></li>
 </ul>
@@ Line 268: / Line 268: @@
 <p> Here are some additional assumptions to be found in the documentation:</p>
 <ol>
-<li>You installed POV-Ray in the default location (on Windows, binaries in <code>c:\Program Files\POV-Ray\v3.8</code> and include/scene files in <code>My Documents\POV-Ray\v3.8</code>).
+<li>You installed POV-Ray in the default location (on Windows, binaries in <code>c:\Program Files\POV-Ray\vX.y</code> and include/scene files in <code>My Documents\POV-Ray\vX.y</code>).
-If we say 'include files are stored in the <code>include</code> directory', we mean the directory called 'include' located immediately within the folder which was used for documents (in the above case, it would be <code>My Documents\POV-Ray\v3.8\include</code>). We assume you can translate that to something like <code>/usr/local/share/povray-3.8/include</code> (for Linux) or whatever is appropriate for your platform, operating system and personal installation.
+If we say 'include files are stored in the <code>include</code> directory', we mean the directory called 'include' located immediately within the folder which was used for documents (in the above case, it would be <code>My Documents\POV-Ray\vX.y\include</code>). We assume you can translate that to something like <code>/usr/local/share/povray-v.Xy/include</code> (for Linux) or whatever is appropriate for your platform, operating system and personal installation.
 <li> POV-Ray uses INI files and/or command-line switches (if available) to choose options in all versions, but some platforms (e.g. Windows) 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, as it is consistent across all platforms (all GUI versions of POV-Ray also provide a means of accepting command-line options and reading INI files from within the GUI - generally speaking, the menus and dialogs just provide
 an easier means of doing the same thing).

@@ Line 255: / Line 255: @@
    <li><code>[ ITEM ]</code></li>
 </ul>
 <p class="Note"><strong>Note:</strong> POV-Ray is available as a command-line program on some platforms and as a GUI on others. Some of these platforms use folders to store files while others use directories. Some separate the folders and sub-folders with a slash character (<code>/</code>), back-slash character (<code>\</code>), 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 rather than try to represent all possible combinations
 we sometimes simplify the documentation by referring to a hypothetical 'standard installation' of POV-Ray upon a Microsoft Windows computer.
 </p>
-<p> Here are some assumptions to be found in the documentation:</p>
+<p> Here are some additional assumptions to be found in the documentation:</p>
 <ol>
 <li>You installed POV-Ray in the default location (on Windows, binaries in <code>c:\Program Files\POV-Ray\v3.7</code> and include/scene files in <code>My Documents\POV-Ray\v3.7</code>).

← Older revision	Revision as of 11:59, 1 July 2012
(No difference)