diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2009-08-03 21:37:04 -0400 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2009-08-03 21:37:04 -0400 |
| commit | 1f51901971dde99d0b3f8d4b7d9e5ff06070b81b (patch) | |
| tree | b38eaaf0676471127a9b6547815848642eb78f6e | |
| parent | 30958ed18c89eb3a888ed518cab271385f1d8075 (diff) | |
| download | sigen-1f51901971dde99d0b3f8d4b7d9e5ff06070b81b.tar.gz sigen-1f51901971dde99d0b3f8d4b7d9e5ff06070b81b.tar.xz sigen-1f51901971dde99d0b3f8d4b7d9e5ff06070b81b.zip | |
Add validation image and description
| -rw-r--r-- | sigmodr/doc/validation.docbook | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/sigmodr/doc/validation.docbook b/sigmodr/doc/validation.docbook index 17eaa077..b5dff45e 100644 --- a/sigmodr/doc/validation.docbook +++ b/sigmodr/doc/validation.docbook @@ -15,6 +15,25 @@ 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 |