diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2009-08-08 09:57:21 -0400 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2009-08-08 09:57:21 -0400 |
| commit | 92a26a553c31f254cc4cd32884a8124d682aed00 (patch) | |
| tree | 866dac923582c4d2e3a17271bde8ed3c52fe0f43 /sigmodr/doc/validation.docbook | |
| parent | 78e1b0c4d23f6acdcd6a63a0f579b8af0c006c29 (diff) | |
| download | sigen-92a26a553c31f254cc4cd32884a8124d682aed00.tar.gz sigen-92a26a553c31f254cc4cd32884a8124d682aed00.tar.xz sigen-92a26a553c31f254cc4cd32884a8124d682aed00.zip | |
Fix indentation in docbook files
Diffstat (limited to 'sigmodr/doc/validation.docbook')
| -rw-r--r-- | sigmodr/doc/validation.docbook | 104 |
1 files changed, 56 insertions, 48 deletions
diff --git a/sigmodr/doc/validation.docbook b/sigmodr/doc/validation.docbook index 8f2b4a10..90c81376 100644 --- a/sigmodr/doc/validation.docbook +++ b/sigmodr/doc/validation.docbook @@ -1,52 +1,60 @@ <chapter id="validation"> - <chapterinfo> - <authorgroup> - <author> - &Ben.Boeckel; - &Ben.Boeckel.mail; - </author> - <!-- TRANS:ROLES_OF_TRANSLATORS --> - </authorgroup> - <date>2009-08-03</date> - </chapterinfo> - <title>Validation</title> - - <para>When editing &sigmod;s, errors and other possible sources of - complications can occur. Validation can help to catch these errors and - mistakes before they cause problems in the game engine.</para> - - <para>The validator will set the background color of the message - depending on whether it is a warning or an error. There will also be a - count of the number of warnings and errors on the validation dialog. Here - is a sample of validation output: - <screenshot id="screen-validation"> - <screeninfo>Validation dialog</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="validation-dialog.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Sample validation dialog</phrase> - </textobject> - </mediaobject> - </screenshot> - The errors will stop the &sigmod; from being run by the game engine while - warnings will not. However, warnings should be considered before being ignored; - they are there to warn when values or objects are not typical.</para> - - <para>The most common sources of errors are deleting objects that are - referenced leaving the reference open. However, if a new item is created - with the same id number after a reference is broken, the new object will - be picked up as the reference and no errors will be given.</para> - - <para>With this occurring, it is best to validate the entire &sigmod; after - deleting an object. This will help to catch any dangling references - created by deleting the object. It also means that in order to catch the errors - more easily, keeping errors low from the beginning is key. By building - &sigmod;s from the bottom up, these errors can be kept to a minimum. See + +<chapterinfo> + +<authorgroup> +<author> +&Ben.Boeckel; +&Ben.Boeckel.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2009-08-03</date> + +</chapterinfo> + +<title>Validation</title> + +<para>When editing &sigmod;s, errors and other possible sources of complications +can occur. Validation can help to catch these errors and mistakes before they +cause problems in the game engine.</para> + +<para>The validator will set the background color of the message depending on +whether it is a warning or an error. There will also be a count of the number of +warnings and errors on the validation dialog. Here is a sample of validation +output: + +<screenshot id="screen-validation"> +<screeninfo>Validation dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="validation-dialog.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>Sample validation dialog</phrase> +</textobject> +</mediaobject> +</screenshot> + +The errors will stop the &sigmod; from being run by the game engine while +warnings will not. However, warnings should be considered before being ignored; +they are there to warn when values or objects are not typical.</para> + +<para>The most common sources of errors are deleting objects that are referenced +leaving the reference open. However, if a new item is created with the same id +number after a reference is broken, the new object will be picked up as the +reference and no errors will be given.</para> + +<para>With this occurring, it is best to validate the entire &sigmod; after +deleting an object. This will help to catch any dangling references created by +deleting the object. It also means that in order to catch the errors more +easily, keeping errors low from the beginning is key. By building &sigmod;s from +the bottom up, these errors can be kept to a minimum. See the Chapter on <!-- TODO: Uncomment when link works - the Chapter on <link linkend="building-sigmods">building &sigmod;s</link> for +<link linkend="building-sigmods">building &sigmod;s</link> for tips and --> - the Chapter on building &sigmod;s for - tips and tricks.</para> +building &sigmod;s for tips and +tricks.</para> + </chapter> |
