diff options
Diffstat (limited to 'sigmodr/doc/basics.docbook')
| -rw-r--r-- | sigmodr/doc/basics.docbook | 54 |
1 files changed, 26 insertions, 28 deletions
diff --git a/sigmodr/doc/basics.docbook b/sigmodr/doc/basics.docbook index 8d4225b8..19b65b57 100644 --- a/sigmodr/doc/basics.docbook +++ b/sigmodr/doc/basics.docbook @@ -22,9 +22,8 @@ <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 +with other applications can be changed using the <guilabel>File Associations +</guilabel> settings (found in &systemsettings;). By default, &sigmodr; can be started in any of the following ways: <itemizedlist spacing="compact"> @@ -38,8 +37,7 @@ started in any of the following ways: </listitem> <listitem> -<para>From a launcher (&ie;, <application>KRunner</application> or -<application>Katapault</application>)</para> +<para>From a launcher (&ie;, &krunner;)</para> </listitem> </itemizedlist> @@ -76,8 +74,8 @@ edit the data structures within &sigmodr;.</para> 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> +<para>The window consists of the <interface>&sigmod; tree</interface> and the +<interface>editor panel</interface>.</para> </sect2> @@ -85,15 +83,15 @@ tree and the <link linkend="editor-panel">editor panel</link>.</para> <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 -<quote>«</quote> and <quote>»</quote>, 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: +<para>The <interface>&sigmod; tree</interface> 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 <quote>«</quote> and <quote>»</quote>, 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> @@ -113,16 +111,16 @@ and some items expanded: <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: +<para>The <interface>editing panel</interface> 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> @@ -136,8 +134,8 @@ an example of a data structure being edited: </mediaobject> </screenshot> -For more specific information on each data structure's editing, please -see the appropriate chapter.</para> +For more specific information on each data structure's editing, please see +the appropriate chapter.</para> </sect2> |