sigmodr/doc/basics.docbook


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

<chapter id="basics">
 <chapterinfo>
  <authorgroup>
   <author>
    &Ben.Boeckel;
    &Ben.Boeckel.mail;
   </author>
   <!-- TRANS:ROLES_OF_TRANSLATORS -->
  </authorgroup>
  <date>2009-08-03</date>
 </chapterinfo>
 <title>&sigmodr; Basics</title>
 
 <sect1 id="starting-sigmodr">
  <title>Starting &sigmodr;</title>
  <para>Since &sigmodr; is the official editor for &sigmod; files, it is
  the default application for opening &sigmod; files with if installed.
  Precedence with other applications can be changed using the <guilabel>File
  Associations</guilabel> settings (found in <application>System
  Settings</application>). By default, &sigmodr; can be started in any of the
  following ways:
   <itemizedlist spacing="compact">
    <listitem>
     <para>Opening a &sigmod; file</para>
    </listitem>
    <listitem>
     <para>Choosing &sigmodr; from the menus</para>
    </listitem>
    <listitem>
     <para>From a launcher (i.e., <application>KRunner</application> or
     <application>Katapault</application>)</para>
    </listitem>
   </itemizedlist>
  </para>
 </sect1>
 
 <sect1 id="user-interface">
  <title>User interface</title>
  <para>This section describes the user interface of &sigmodr; and how to
  open and edit the data structures within &sigmodr;.</para>
  
  <sect2 id="main-window">
   <title>The Main Window</title>
   <para>When &sigmodr; is started, the main window is displayed:
    <screenshot id="screen-main-window">
     <screeninfo>&sigmodr; main window</screeninfo>
     <mediaobject>
      <imageobject>
       <imagedata fileref="main-window.png" format="PNG" />
      </imageobject>
      <textobject>
       <phrase>&sigmodr; main window</phrase>
      </textobject>
     </mediaobject>
    </screenshot>
   The main window works best when tall and narrow since the tree and the
   editing widgets are both oriented this way.</para>
   
   <para>The window consists of the <link linkend="sigmod-tree">&sigmod;</link>
   tree and the <link linkend="editor-panel">editor panel</link>.</para>
  </sect2>
  
  <sect2 id="sigmod-tree">
   <title>The &sigmod; Tree</title>
   <para>The &sigmod; tree is a tree structure with all of the data
   elements represented within it. It is on the left of the main window.
   It has descriptions as the main part of the tree items. If an item is
   surrounded by &lsquo;&laquo;&rsquo; and &lsquo;&raquo;&rsquo;, it
   means that the data used to describe the item is not set. On the right
   side, there are three icons. The first icon is shown if the item can
   be edited, the second icon is shown if the item can be deleted, and
   finally the third icon is shown if an item can be added to it (as a
   child). Here is a screenshot of the tree with a few &sigmod;s open and
   some items expanded:
    <screenshot id="screen-sigmod-tree">
     <screeninfo>&sigmod; tree image</screeninfo>
     <mediaobject>
      <imageobject>
       <imagedata fileref="sigmod-tree.png" format="PNG" />
      </imageobject>
      <textobject>
       <phrase>&sigmod; tree with a few open &sigmod;s</phrase>
      </textobject>
     </mediaobject>
    </screenshot>
   </para>
  </sect2>
  
  <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 <guibutton>Apply</guibutton> button will save the information
   to the &sigmod; in memory. In order to save the &sigmod; to disk,  use the
   <guimenuitem>Save</guimenuitem> or <guimenuitem>Save As...</guimenuitem>
   entries in the <guimenu>File</guimenu> menu. The
   <guibutton>Discard</guibutton> button will undo changes since the last
   <guibutton>Apply</guibutton>. The <guibutton>Validate</guibutton> 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>