summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Boeckel <MathStuf@gmail.com>2009-08-08 11:00:18 -0400
committerBen Boeckel <MathStuf@gmail.com>2009-08-08 11:00:18 -0400
commit4d43aed6974a929e22b5864adc4ebcffb080ed2b (patch)
treeb987411839e83b8d2d8a4c743fdc79776f8fbb99
parent47c71627898417564fb18eb1fca64fadf0965cee (diff)
downloadsigen-4d43aed6974a929e22b5864adc4ebcffb080ed2b.tar.gz
sigen-4d43aed6974a929e22b5864adc4ebcffb080ed2b.tar.xz
sigen-4d43aed6974a929e22b5864adc4ebcffb080ed2b.zip
Fix paragraph breaks over tags
-rw-r--r--sigmodr/doc/basics.docbook54
-rw-r--r--sigmodr/doc/editing-beginning.docbook41
-rw-r--r--sigmodr/doc/editing-sigmod.docbook36
-rw-r--r--sigmodr/doc/index.docbook9
4 files changed, 71 insertions, 69 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>&laquo;</quote> and <quote>&raquo;</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>&laquo;</quote> and <quote>&raquo;</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&apos;s editing, please
-see the appropriate chapter.</para>
+For more specific information on each data structure&apos;s editing, please see
+the appropriate chapter.</para>
</sect2>
diff --git a/sigmodr/doc/editing-beginning.docbook b/sigmodr/doc/editing-beginning.docbook
index 527fdb88..b8f55e62 100644
--- a/sigmodr/doc/editing-beginning.docbook
+++ b/sigmodr/doc/editing-beginning.docbook
@@ -21,15 +21,15 @@
internal ID numbers and that ID numbers are assigned to new objects as the
lowest available number. ID numbers are unique within each group of children of
a specific object. When adding and deleting objects, references may be changed
-from what was originally intended. Using the
-<link linkend="validation">validator</link> after each deletion can help to
-reduce errors made from such automatic assignments.</para>
+from what was originally intended. Using the <link linkend="validation">
+validator</link> after each deletion can help to reduce errors made from such
+automatic assignments.</para>
</caution>
<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>
+click the <guibutton>Edit</guibutton> button in the <link linkend="sigmod-tree">
+tree</link>.</para>
<sect1 id="editing-basics">
@@ -39,12 +39,12 @@ click the <guibutton>Edit</guibutton> button in the
<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="reporting-bugs">submit a bug</link> if this occurs.
-Here is an example of such a dialog box:
+<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="reporting-bugs">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>
@@ -58,10 +58,10 @@ Here is an example of such a dialog box:
</mediaobject>
</screenshot>
-This dialog shows that the expected range of values of
-<guilabel>sellPrice</guilabel> is from &minus;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>
+This dialog shows that the expected range of values of <guilabel>sellPrice
+</guilabel> is from &minus;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>
@@ -71,12 +71,11 @@ reverted to the last valid value.</para>
<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>
+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>
diff --git a/sigmodr/doc/editing-sigmod.docbook b/sigmodr/doc/editing-sigmod.docbook
index 3002f408..029a85a3 100644
--- a/sigmodr/doc/editing-sigmod.docbook
+++ b/sigmodr/doc/editing-sigmod.docbook
@@ -22,10 +22,10 @@
<para>The top-level data structure keeps information about the &sigmod; for the
engine as well as kendling interconnections between the other data structures
-that do not (or cannot) be handled elsewhere. The
-<link linkend="sigmod-typechart">type effectiveness chart</link> controls how
-effective types are against one another in battle and the
-<link linkend="sigmod-worldmap">world map editor</link> describes how maps are
+that do not (or cannot) be handled elsewhere. The <link
+linkend="sigmod-typechart">type effectiveness chart</link> controls how
+effective types are against one another in battle and the <link
+linkend="sigmod-worldmap">world map editor</link> describes how maps are
positioned in the world relative to each other.</para>
</sect1>
@@ -56,8 +56,8 @@ values:</para>
<listitem>
<para>The title of the &sigmod;. Anything after a <quote>:</quote> is understood
to be a subtitle, so that a single &sigmod; may have different flavors, &eg;
-<userinput>Ice Cream: Vanilla Flavor</userinput> or
-<userinput>Ice Cream: Chocolate Flavor</userinput>.</para>
+<userinput>Ice Cream: Vanilla Flavor</userinput> or <userinput>Ice Cream:
+Chocolate Flavor</userinput>.</para>
</listitem>
</varlistentry>
@@ -65,8 +65,7 @@ to be a subtitle, so that a single &sigmod; may have different flavors, &eg;
<term>Version</term>
<listitem>
<para>The version number of the &sigmod;. This is used to check whether the
-&sigmod; is newer than another of the same
-<guilabel>Title</guilabel>.</para>
+&sigmod; is newer than another of the same <guilabel>Title</guilabel>.</para>
</listitem>
</varlistentry>
@@ -122,14 +121,19 @@ its Chapter.</para>
<para>The typechart is a matrix of multipliers related to how effective one type
is against another. To interpret the typechart, the type that is on the offense
-is on the left. Across the top is the defending type for each defense type.
-By multiplying the factors together, the overall type effectiveness multipler is
+is on the left. Across the top is the defending type for each defense type. By
+multiplying the factors together, the overall type effectiveness multipler is
found.</para>
<para>In the typechar, the cells are colored to help find particularly effective
-or ineffective type matches. Above 2, the cell is colored
-<quote>positively</quote> according to the color scheme and below &frac12;, the
-cell is colored <quote>negatively</quote>.</para>
+or ineffective type matches. Above 2, the cell is colored <quote>positively
+</quote> according to the color scheme and below &frac12;, the cell is colored
+<quote>negatively</quote>.</para>
+
+<para>In order to edit a multiplier, use the &LMB; to activate the appropriate
+cell. The fraction editor at the bottom will then start editing that cell. The
+fraction editor also displays the type matchup that is currently being edited
+above it.</para>
</sect1>
@@ -139,15 +143,15 @@ cell is colored <quote>negatively</quote>.</para>
<important>
<para>The world map editor is incomplete. This will become a higher priority
-when the <acronym>RPG</acronym> elements of the game engine are further
-along.</para>
+when the <acronym>RPG</acronym> elements of the game engine are further along.
+</para>
</important>
<warning>
<para>Validation for world map placement is not in place yet. This means that
maps may have gaps between them and players can reach an edge which does not go
anywhere. All that is currently done is making sure that maps do not overlap
-each other (though this is not 100% working either).</para>
+each other (though this is not 100&percnt; working either).</para>
</warning>
<screenshot id="screen-sigmod-worldmap">
diff --git a/sigmodr/doc/index.docbook b/sigmodr/doc/index.docbook
index ce9a1099..26249953 100644
--- a/sigmodr/doc/index.docbook
+++ b/sigmodr/doc/index.docbook
@@ -72,13 +72,14 @@ engine.</para>
<para>&sigmodr; is a part of &sigen;</para>
-<para>For further information about &sigen;, please visit
-<ulink url="&sigenwww;">&sigenwww;</ulink>.</para>
+<para>For further information about &sigen;, please visit <ulink
+url="&sigenwww;">&sigenwww;</ulink>.</para>
-<para>For further information about &sigmodr;, please visit
-<ulink url="&sigenwww;/sigmodr">&sigenwww;/sigmodr</ulink>.</para>
+<para>For further information about &sigmodr;, please visit <ulink
+url="&sigenwww;/sigmodr">&sigenwww;/sigmodr</ulink>.</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
&underFDL;
</appendix>