From 4d43aed6974a929e22b5864adc4ebcffb080ed2b Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Sat, 8 Aug 2009 11:00:18 -0400 Subject: Fix paragraph breaks over tags --- sigmodr/doc/basics.docbook | 54 +++++++++++++++++------------------ sigmodr/doc/editing-beginning.docbook | 41 +++++++++++++------------- sigmodr/doc/editing-sigmod.docbook | 36 ++++++++++++----------- sigmodr/doc/index.docbook | 9 +++--- 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 @@ 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 -File Associations settings (found in -System Settings). By default, &sigmodr; can be +with other applications can be changed using the File Associations + settings (found in &systemsettings;). By default, &sigmodr; can be started in any of the following ways: @@ -38,8 +37,7 @@ started in any of the following ways: -From a launcher (&ie;, KRunner or -Katapault) +From a launcher (&ie;, &krunner;) @@ -76,8 +74,8 @@ edit the data structures within &sigmodr;. The main window works best when tall and narrow since the tree and the editing widgets are both oriented this way. -The window consists of the &sigmod; -tree and the editor panel. +The window consists of the &sigmod; tree and the +editor panel. @@ -85,15 +83,15 @@ tree and the editor panel. The &sigmod; Tree -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 -« and », 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: +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 « and », 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: &sigmod; tree image @@ -113,16 +111,16 @@ and some items expanded: The Editor Panel -The editing panel is where the widgets used to edit a data structure are -shown. The Apply button will save the information to the -&sigmod; in memory. In order to save the &sigmod; to disk, use the -Save or Save As... entries -in the File menu. The Discard button -will undo changes since the last Apply. The -Validate button will check the data structure (and all -children) for errors and warnings. See the -validation page for more information. Here is -an example of a data structure being edited: +The editing panel is where the widgets used to edit +a data structure are shown. The Apply button will save +the information to the &sigmod; in memory. In order to save the &sigmod; to +disk, use the Save or Save As... + entries in the File menu. The +Discard button will undo changes since the last Apply +. The Validate button will check the data +structure (and all children) for errors and warnings. See the validation page for more information. Here is an +example of a data structure being edited: Editor panel image @@ -136,8 +134,8 @@ an example of a data structure being edited: -For more specific information on each data structure's editing, please -see the appropriate chapter. +For more specific information on each data structure's editing, please see +the appropriate chapter. 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 -validator after each deletion can help to -reduce errors made from such automatic assignments. +from what was originally intended. Using the +validator after each deletion can help to reduce errors made from such +automatic assignments. Editing in &sigmodr; is done in the editor panel. In order to edit an object, -click the Edit button in the -tree. +click the Edit button in the +tree. @@ -39,12 +39,12 @@ click the Edit button in the Boundary Dialogs -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 submit a bug if this occurs. -Here is an example of such a dialog box: +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 submit a bug if this occurs. Here is an example +of such a dialog box: Invalid input dialog @@ -58,10 +58,10 @@ Here is an example of such a dialog box: -This dialog shows that the expected range of values of -sellPrice 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. +This dialog shows that the expected range of values of sellPrice + 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. @@ -71,12 +71,11 @@ reverted to the last valid value. &sigmodr; does not currently feature Undo and Redo support. It currently can only save the current -edited state (data that is shown in the -editing panel), the last applied state of -the object (restored with Discard), and the on-disk file -(restored when reloading the file and written when saving). As such, data can -easily be lost with an Apply or a -Discard. +edited state (data that is shown in the editing +panel), the last applied state of the object (restored with +Discard), and the on-disk file (restored when reloading the file and +written when saving). As such, data can easily be lost with an Apply + or a Discard. 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 @@ 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 -type effectiveness chart controls how -effective types are against one another in battle and the -world map editor describes how maps are +that do not (or cannot) be handled elsewhere. The type effectiveness chart controls how +effective types are against one another in battle and the world map editor describes how maps are positioned in the world relative to each other. @@ -56,8 +56,8 @@ values: The title of the &sigmod;. Anything after a : is understood to be a subtitle, so that a single &sigmod; may have different flavors, ⪚ -Ice Cream: Vanilla Flavor or -Ice Cream: Chocolate Flavor. +Ice Cream: Vanilla Flavor or Ice Cream: +Chocolate Flavor. @@ -65,8 +65,7 @@ to be a subtitle, so that a single &sigmod; may have different flavors, ⪚ Version The version number of the &sigmod;. This is used to check whether the -&sigmod; is newer than another of the same -Title. +&sigmod; is newer than another of the same Title. @@ -122,14 +121,19 @@ its Chapter. 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. In the typechar, the cells are colored to help find particularly effective -or ineffective type matches. Above 2, the cell is colored -positively according to the color scheme and below ½, the -cell is colored negatively. +or ineffective type matches. Above 2, the cell is colored positively + according to the color scheme and below ½, the cell is colored +negatively. + +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. @@ -139,15 +143,15 @@ cell is colored negatively. The world map editor is incomplete. This will become a higher priority -when the RPG elements of the game engine are further -along. +when the RPG elements of the game engine are further along. + 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). +each other (though this is not 100% working either). 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. &sigmodr; is a part of &sigen; -For further information about &sigen;, please visit -&sigenwww;. +For further information about &sigen;, please visit &sigenwww;. -For further information about &sigmodr;, please visit -&sigenwww;/sigmodr. +For further information about &sigmodr;, please visit &sigenwww;/sigmodr. + &underFDL; -- cgit