diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2009-08-03 20:49:27 -0400 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2009-08-03 20:49:27 -0400 |
| commit | 30958ed18c89eb3a888ed518cab271385f1d8075 (patch) | |
| tree | 4923610ca25a4d6d0d21256bd20079ff6fe12f8a /sigmodr/doc/validation.docbook | |
| parent | c2cee774d0f4e36960bb60cd8dd3188fa17e1051 (diff) | |
| download | sigen-30958ed18c89eb3a888ed518cab271385f1d8075.tar.gz sigen-30958ed18c89eb3a888ed518cab271385f1d8075.tar.xz sigen-30958ed18c89eb3a888ed518cab271385f1d8075.zip | |
Write some validation documentation
Diffstat (limited to 'sigmodr/doc/validation.docbook')
| -rw-r--r-- | sigmodr/doc/validation.docbook | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/sigmodr/doc/validation.docbook b/sigmodr/doc/validation.docbook index d8be4d15..17eaa077 100644 --- a/sigmodr/doc/validation.docbook +++ b/sigmodr/doc/validation.docbook @@ -11,6 +11,20 @@ </chapterinfo> <title>Validation</title> - <para> - </para> + <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 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 <link linkend="building-sigmods">building &sigmod;s</link> for + tips and tricks.</para> </chapter> |