summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--sigmodr/doc/basics.docbook26
-rw-r--r--sigmodr/doc/editor-panel.pngbin0 -> 47998 bytes
2 files changed, 26 insertions, 0 deletions
diff --git a/sigmodr/doc/basics.docbook b/sigmodr/doc/basics.docbook
index bfc596a5..b2ab8f3d 100644
--- a/sigmodr/doc/basics.docbook
+++ b/sigmodr/doc/basics.docbook
@@ -82,6 +82,32 @@
</textobject>
</mediaobject>
</screenshot>
+
+ <sect2 id="editor-panel">
+ <title>The Editor Panel</title>
+ <para>The editing panel is where the widgets used to edit a data structure
+ are shown. The <menuchoice>Apply</menuchoice> button will save the
+ information to the &sigmod; in memory. In order to save the &sigmod; to disk,
+ use the <menuchoice>Save</menuchoice> or <menuchoice>Save As...</menuchoice>
+ menu entries. The <menuchoice>Discard</menuchoice> button will undo
+ changes since the last <menuchoice>Apply</menuchoice>. The
+ <menuchoice>Validate</menuchoice> button will check the data structure
+ (and all children) for errors and warnings. See the
+ <link linkend="validation">validation page</link> for more information. Here
+ is an example of a data structure being edited:
+ <screenshot id="sigmod-tree-screen">
+ <screeninfo>Editor panel image</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="editor-panel.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Editor panel editing a data structure</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ For more specific information on each data structure&apos;s editing, please
+ see the appropriate chapter.</para>
</sect2>
</sect1>
</chapter>
diff --git a/sigmodr/doc/editor-panel.png b/sigmodr/doc/editor-panel.png
new file mode 100644
index 00000000..9f3e3158
--- /dev/null
+++ b/sigmodr/doc/editor-panel.png
Binary files differ