diff options
| -rw-r--r-- | sigmodr/doc/editing-beginning.docbook | 45 | ||||
| -rw-r--r-- | sigmodr/doc/invalid-input-dialog.png | bin | 0 -> 21425 bytes |
2 files changed, 44 insertions, 1 deletions
diff --git a/sigmodr/doc/editing-beginning.docbook b/sigmodr/doc/editing-beginning.docbook index 7ee4fd0f..fc524759 100644 --- a/sigmodr/doc/editing-beginning.docbook +++ b/sigmodr/doc/editing-beginning.docbook @@ -22,5 +22,48 @@ reduce errors made from such automatic assignments.</para> </caution> - <para></para> + <para>Editing in &sigmodr; is done in the <link linkend="editor-panel">editor + panel</link>. In order to edit an object, click the <guibutton>Edit</guibutton> + button in the <link linkend="sigmod-tree">tree</link>.</para> + + <sect1 id="editing-basics"> + <title>Editing Basics</title> + + <sect2 id="boundary-dialogs"> + <title>Boundary Dialogs</title> + <para>The fields in the widget control the values for the object. Boundaries + are set so that invalid values may not be entered or selected. If the + boundaries are violated, a small dialog box will pop up describing the error. + These should not happen and indicate that the boundaries are incorrectly set. + Please <link linkend="submit-bug">submit a bug</link> if this occurs. Here + is an example of such a dialog box: + <screenshot id="screen-boundary"> + <screeninfo>Invalid input dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="invalid-input-dialog.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Invalid input dialog</phrase> + </textobject> + </mediaobject> + </screenshot> + This dialog shows that the expected range of values of + <guilabel>sellPrice</guilabel> is from −1 to 0, but &sigmodr; attempted + to set the value to 1. &sigmodr; will catch the error and the value + will be reverted to the last valid value.</para> + </sect2> + + <sect2 id="data-integrity"> + <title>Data Integrity</title> + <para>&sigmodr; does not currently feature <guibutton>Undo</guibutton> and + <guibutton>Redo</guibutton> support. It currently can only save the current + edited state (data that is shown in the <link linkend="editor-panel">editing + panel</link>), the last applied state of the object (restored with + <guibutton>Discard</guibutton>), and the on-disk file (restored when + reloading the file and written when saving). As such, data can easily be lost + with an <guibutton>Apply</guibutton> or a + <guibutton>Discard</guibutton>.</para> + </sect2> + </sect1> </chapter> diff --git a/sigmodr/doc/invalid-input-dialog.png b/sigmodr/doc/invalid-input-dialog.png Binary files differnew file mode 100644 index 00000000..6ed1565d --- /dev/null +++ b/sigmodr/doc/invalid-input-dialog.png |
