created new branch as a simple solution to the /manual branch mess

manual/opencs/filters.tex

@@ -116,10 +116,9 @@ This is probably enough to create around 90 string filters you will eventually n
 -- it accepts regular expressions (also called regexps). Regular expressions is a way to create string criteria that will be matched
 by one than just one specific value in the column. For instance, you can display both left and right gauntlets with the following expression:
 \mono{string("armor type", ".* gauntlet"))} because \mono{.*} in regexps means just: ``anything''. This filter says: please, show me ``any'' gauntlet.
-There are left and right gauntlets in the morrowind so this will evaluate to true for both. Simple, isn't it?
+There are left and right gauntlets in the \MW{} so this will evaluate to true for both. Simple, isn't it?
 
-Creating regexps can be a difficult and annoying -- especially when you need complex criteria. On the other hand, we are under impression
-that in reality complex expressions are needed only in sporadic cases. In fact, the truth is: that most of the time only already mentioned
+Creating regexps can be a difficult and annoying -- especially when you need complex criteria. On the other hand, we are under impression that in reality complex expressions are needed only in sporadic cases. In fact, the truth is: that most of the time only already mentioned
 \mono{.*} is needed and therefore the following description of regexps can be skipped by vast majority of readers.
 
 Before working with Regular Expressions, you should understand what actually are regular expressions. Essentially, the idea is simple:
@@ -131,19 +130,18 @@ Before introducing other ways to choose between characters, I want explain ancho
 You surely should know about \mono{\textasciicircum} anchor and \mono{\textdollar}. Putting \mono{\textasciicircum} will tell to \OCS{}
 to look on the beginning of string, while \mono{\textdollar} is used to mark the end of it. For instance, pattern
 \mono{\textasciicircum{}Pink.* elephant.\textdollar} will match any sentence beginning with the word \mono{Pink} and ending with
-\mono{ elephant.}. Pink fat elephant. Pink cute elephant. It does not matter what is in between, because \mono{.*} is used.
+\mono{ elephant.}. Pink fat elephant. Pink cute elephant. It does not matter what is in between because \mono{.*} is used.
 
 You have already seen the power of the simple \mono{.*}. But what if you want to chose between only two (or more) letters? Well, this is when
 \mono{[|]} comes in handy. If you write something like: \mono{\textasciicircum[a|k].*} you are simply telling \OCS{} to filter anything that
-starts with either \mono{a} or \mono{k}. Using \mono{\textasciicircum[a|k|l].*} will work in the same manner, but it will also cover
-strings starting with \mono{l}.
+starts with either \mono{a} or \mono{k}. Using \mono{\textasciicircum[a|k|l].*} will work in the same manner, that is; it will also cover strings starting with \mono{l} as well.
 
-What if you want to match more than just one latter? Just use \mono{(|)}. it is pretty similar to the above one letter as you see, but it is
+What if you want to match more than just one latter? Just use \mono{(|)}. It is pretty similar to the above one letter as you see, but it is
 used to fit more than just one character. For instance: \mono{\textasciicircum(Pink|Green).* (elephant|crocodile).\textdollar} will be
 true for all sentences starting with \mono{Pink} or \mono{Green} and ending with either \mono{elephant.} or \mono{crocodile.}.
 
 Regular expressions are not the main topic of this manual. If you wish to learn more on this subject please, read the documentation on
-Qt regular expressions syntax, or TRE regexp syntax (it is almost like in Qt). Above is just enough to use \OCS{} effectively to be sure.
+Qt regular expressions syntax, or TRE regexp syntax (it is almost like in Qt). Above is just enough to use \OCS{} effectively.
 
 \paragraph{Value -- value(``value'', (``open'', ``close''))}
 While string expression covers vast group of columns containing string values, there are in fact columns with just numerical values like
@@ -169,12 +167,11 @@ belonging to the same group of logical expressions.
 
 \paragraph{not -- not expression()}
 Sometimes you may be in need of reversing the output of the expression. This is where \textit{not} comes in handy. Adding \textit{not} before
-expression will revert it: if expression was returning true, it will return false; if it was returning false, it will return true. Brackets
-are not needed: \textit{not} will revert only the first expression following it.
+expression will revert it: if expression was returning true, it will return false; if it was returning false, it will return true. Parenthesis are not needed: \textit{not} will revert only the first expression following it.
 
 To show this on know example, let's consider the \mono{string("armor type", ".* gauntlet"))} filter. As we mentioned earlier this will return true
 for every gauntlet found in game. In order to show everything, but gauntlets we simply do \mono{not string("armor type", ".* gauntlet"))}.
-This is probably not the most useful filter on earth, but this is not a surprise: real value of \textit{not} expression shines when combined with
+This is probably not the most useful filter on earth. The real value of \textit{not} expression shines when combined with
 \textit{or}, \textit{and} filters.
 
 \paragraph{or -- or(expression1(), expression2())}

manual/opencs/main.tex

@@ -30,5 +30,6 @@
 \input{creating_file}
 \input{windows}
 \input{tables}
+\input{recordtypes}
 \input{filters}
 \end{document}

manual/opencs/recordmodification.tex

@@ -0,0 +1,26 @@
+\section{Records Modification}
+
+\subsection{Introduction}
+So far you learned how to browse trough records stored inside the content files, but not how to modify them using the \OCS{} editor. Although browsing is certainly a usefull ability on it's own, You probabbly counted on doing actual editing with this editor. There are few ways user can alter records stored in the content files, each suited for certain class of a problem. In this section We will describe how to do change records using tables interface and edit panel.
+
+\subsubsection{Glossary}
+\begin{description}
+  \item[Edit Panel] Interface element used inside the \OCS{} to present records data for editing. Unlike table it showes only one record at the time. However it also presents fields that are not visible inside the table. It is also safe to say that Edit Panel presents data in way that is easier to read thanks to it's horizontal layout.
+\end{description}
+
+\subsection{Edit Panel Interface}
+Edit Panel is designed to aid you with record modification tasks. As It has been said, it uses vertical layout and presents some additional fields when compared with the table -- and some fields, even if they are actually displayed in the table, clearly ill-suited for modification isnide of them (this applies to fields that holds long text strings -- like descriptions). It also displays visual difference beetween non-editable field and editable.\\
+To open edit panel, please open context menu on any record and choose edit action. This will open edit panel in the same window as your table and will present you the record fields. First data fields are actually not user editable and presented in the form of the text labels at the top of the edit panel. Lower data fields are presented in the form of actually user-editable widgets. Those includes spinboxes, text edits and text fields\footnote{Those are actually a valid terms used to describe classes of the user interface elements. If you don't understand those, don't worry -- those are very standard {GUI} elements present in almost every application since the rise of the desktop metaphor.}. Once you will finish editing one of those fields, data will be updated. There is no apply button of any sort -- simply use one of those widgets and be merry.\\
+In addition to that you probabbly noticed some icons in the bar located at the very bottom of the edit panel. Those can be used to perform the following actions:
+
+\begin{description}
+  \item[Preview] This will launch simple preview panel -- which will be described later.
+  \item[Next] This will switch edit panel to the next record. It is worth noticing that edit panel will skip deleted records.
+  \item[Prev] Do We really need to say what this button does? I guess we should! Well, this will switch edit panel to former record. Deleted records are skipped.
+\end{description}
+
+\subsection{Verification tool}
+As you could notice there is nothing that can stop you from breaking the game by violating record fields logic, and yet -- it is something that you are always trying to avoid. To adress this problem \OCS{} utilizes so called verification tool (or verifer as many prefer to call it) that basicly goes trough all records and checks if it contains any illogical fields. This includes for instance torch duration equal 0\footnote{Interestingly negative values are perfectly fine: they indicate that light source has no duration limit at all. There are records like this in the original game.} or characters without name, race or any other record with a mandatory field missing.\\
+This tool is even more usefull than it seems. If you somehow delete race that is used by some of the characters, all those characters will be suddenly broken. As a rule of thumb it is a good idea to use verifer before saving your content file.\\
+To launch this usefull tool %don't remember, todo...
+Resoults are presented as a yet another table with short (and hopefully descriptive enough) description of the identified problem. It is worth noticing that some records located in the \MW{} esm files are listed by the verification tool -- it is not fault of our tool: those records are just broken. For instance, you actually may find the 0 duration torch. However, those records are usually not placed in game world itself -- and that's good since \MW{} game engine will crash if player equip light source like this!\footnote{We would like to thanks \BS{} for such a usefull testing material. It makes us feel special.}

manual/opencs/recordtypes.tex

@@ -0,0 +1,18 @@
+\section{Record Types}
+
+\subsection{Introduction}
+A gameworld contains many objects, such as chests, weapons and monsters. All these objects are merely instances of templates that we call Referenceables. The OpenCS Referenceables table contains information about each of these template objects, eg. its value and weight in the case of items and an aggression level in the case of NPCs.
+
+Let's go through all Record Types and discuss what you can tell OpenCS about them.
+
+\begin{description}
+ \item[Activator:] When the player enters the same cell as this object, a script is started. Often it also has a \textbf{Script} attached to it, though it not mandatory. These scripts are small bits of code written in a special scripting language that OpenCS can read and interpret.
+ \item[Potion:] This is a potion that is not self-made. It has an \textbf{Icon} for your inventory, Aside from the self-explanatory \textbf{Weight} and \textbf{Coin Value}, it has an attribute called \textbf{Auto Calc} set to ``False''. This means that the effects of this potion are preconfigured. This does not happen when the player makes their own potion.
+ \item[Apparatus:] This is a tool to make potions. Again there's an icon for your inventory as well as a weight and a coin value. It also has a \textbf{Quality} value attached to it: higher the number, the better the effect on your potions will be. The \textbf{Apparatus Type} describes if the item is a Calcinator, Retort, Alembir or Mortar & Pestal. Each has a different effect on the potion the player makes. For more information on this subject, please refer to the \href{http://www.uesp.net/wiki/Morrowind:Alchemy#Tools}{UESP page on Alchemy Tools}.
+ \item[Armor:] This type of item adds \textbf{Enchantment Points} to the mix. Every piece of clothing or armor has a ''pool'' of potential magicka that gets unlocked when you enchant it. Strong enchantments consume more magicka from this pool: the stronger the enchantment, the more Enchantment Points each cast will take up. For more information on this subject, please refer to the \href{Enchant page on UESP}{http://www.uesp.net/wiki/Morrowind:Enchant}. \textbf{Health} means the amount of hit points this piece of armor has. If it sustains enough damage, the armor will be destroyed. Finally, \textbf{Armor Value} tells the game how much points to add to the player character's Armor Rating.
+ \item[Book:] This includes scrolls and notes. For the game to make the distinction between books and scrolls, an extra property, \textbf{Scroll}, has been added. Under the \textbf{Skill} column a scroll or book can have an in-game skill listed. Reading this item will raise the player's level in that specific skill. For more information on this, please refer to the \href{Skill Books page on UESP}{http://www.uesp.net/wiki/Morrowind:Skill_Books}.
+ \item[Clothing:] These items work just like Armors, but confer no protective properties. Rather than ``Armor Type'', these items have a ``Clothing Type''.
+ \item[Container:] This is all the stuff that stores items, from chests to sacks to plants. Its \textbf{Capacity} shows how much stuff you can put in the container. You can compare it to the maximum allowed load a player character can carry (who will get over-encumbered and unable to move if he crosses this threshold). A container, however, will just refuse to take the item in question when it gets ''over-encumbered''. \textbf{Organic Container}s are containers such as plants. Containers that \textbf{Respawn} are not safe to store stuff in. After a certain amount of time they will reset to their default contents, meaning that everything in it is gone forever.
+ \item[Creature:] These can be monsters, animals and the like. 
+ 
+\end{description}

manual/opencs/tables.tex

@@ -14,21 +14,14 @@ Let's browse through the various screens and see what all these tables show.
 \begin{description}
  \item[Record:] An entry in \OCS{} representing an item, location, sound, NPC or anything else.
 
- \item[Reference, Referenceable:] When an item is placed in the world, it does not create a new record each time. For example, the game world might
- contain a lot of exquisite belts on different NPCs and in many crates, but they all refer to one specific record: the Exquisite Belt record.
- In this case, all those belts in crates and on NPCs are references. The central Exquisite Belt record is called a referenceable. This allows modders
- to make changes to all items of the same type. For example, if you want all exquisite belts to have 4000 enchantment points rather than 400, you will
- only need to change the referenceable Exquisite Belt rather than all exquisite belts references individually.
+ \item[Reference, Referenceable:] When an item is placed in the world, it isn't an isolated and unique object. For example, the game world might contain a lot of exquisite belts on different NPCs and in many crates, but they all refer to one specific record in the game's library: the Exquisite Belt record. In this case, all those belts in crates and on NPCs are references. The central Exquisite Belt record is called a referenceable. This allows modders to make changes to all items of the same type. For example, if you want all exquisite belts to have 4000 enchantment points rather than 400, you will only need to change the referenceable Exquisite Belt rather than all exquisite belts references individually.
 \end{description}
 
 \subsubsection{Recurring Terms}
 Some columns are recurring throughout \OCS. They show up in (nearly) every table in \OCS.
 
 \begin{description}
-\item[ID] Each item, location, sound, etc. gets the same unique identifier in both \OCS{} and \MW. This is usually a very self-explanatory name.
-For example, the ID for the (unique) black pants of Caius Cosades is ``Caius\_pants''. This allows you to manipulate the game in many ways. For example,
-you could add these pants to your inventory by simply opening the console and write: ``player->addItem Caius\_pants''. Either way, in both Morrowind 
-and \OCS, the ID is the primary way to identify all these different parts of the game. %Wrong! Cells do not have ID, only name.
+\item[ID] Many items in the OpenCS database have a unique identifier in both OpenCS and Morrowind. This is usually a very self-explanatory name. For example, the ID for the (unique) black pants of Caius Cosades is ``Caius\_pants''. This allows you to manipulate the game in many ways. For example, you could add these pants to your inventory by simply opening the console and write: ``player->addItem Caius\_pants''. Either way, in both Morrowind and OpenCS, the ID is the primary way to identify all these different parts of the game.
 \item[Modified] This column shows what has happened (if something has happened) to this record. There are four possible states in which it can exist. 
 \item[Base] means that this record is part of the base game and is in its original state. Usually, if you create a mod, the base game is Morrowind with
 optionally the Bloodmoon and Tribunal expansions.
@@ -96,8 +89,8 @@ a record is, it will need specific information to function. For example, an NPC
 does not. All Record Types contain at least a~model. How else would the player see them? Usually they also have a Name, which is what you see
 when you hover your reticle  over the object.
 
-Let's go through all Record Types and discuss what you can tell \OCS{} about them.
+This is a library of all the items, triggers, containers, NPCs, etc. in the game. There are several kinds of Record Types. Depending on which type a record is, it will need specific information to function. For example, an NPC needs a value attached to its aggression level. A chest, of course, does not. All Record Types contain at least a model. How else would the player see them? Usually they also have a Name, which is what you see when you hover your reticle over the object.
+
+Please refer to the Record Types section for an overview of what each type of Referenceable does and what you can tell OpenCS about these objects.
 
-\begin{description}
- \item[Activator:] This is an item that, when activated, starts a script or even just shows a~tooltip.
 \end{description}