Documentation

Doc/sphinx/gettingstarted.rst

@@ -19,7 +19,7 @@ Simba installer
 ~~~~~~~~~~~~~~~
 
 Everyone can download Simba at http://wizzup.org/simba/
-Go to download, and download the Simba installer.
+Go to download and download the Simba installer.
 
 Once it is done downloading, simply run the installer and follow the steps.
 

Doc/sphinx/index.rst

@@ -10,6 +10,8 @@ Welcome to the Simba documentation!
     The documentation is still WIP (Work In Progress)
 
 Welcome to the Documentation for the Simba project.
+This documentation is aimed at providing documentation on just about anything
+you'd want to know about Simba.
 
 Contents:
 

Doc/sphinx/mmlref/ocr.rst

@@ -1,4 +1,11 @@
 TMOCR Class
 ===========
 
+The TMOCR class uses the powerful ``ocrutil`` unit to create some default but
+useful functions that can be used to create and identify text. It also contains
+some functions used in special cases to filter noise. Specifically, these are
+all the ``Filter*`` functions.
+
+How the filtering works internally is extensively documented in the code itself
+and therefore won't be documented here.
 

Doc/sphinx/mmlref/os_linux.rst

@@ -14,3 +14,8 @@ the ``FreeReturnData`` procedure. Alternatively we could copy the image data to
 another place and then free the XImage, but this would result in additional
 overhead.
 
+Most mouse related functionality is implemented with XQueryPointer, XWarpPointer
+and XTestFakeButtonEvent. (Requires XTest Extension)
+
+All the keyboard functions use XTest as well. It currently lacks the
+functionality to test if a key on the keyboard is down.

Doc/sphinx/troubleshooting.rst

@@ -18,5 +18,14 @@ Where are my Extensions?
 All extensions are in the *Extensions* folder. If this folder is empty, you may
 need to manually download the Extensions or reinstall Simba.
 
+Simba crashes on start complaining about settings.xml
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This means your settings.xml has become corrupt somehow, or Simba may not be
+able to create it. If a settings.xml exists in your Simba directory, you can
+delete it. (All your settings will be lost, but this shouldn't be a bug deal)
+
+There is a bug report pending on this issue.
+
 ..  
-    Something about corrupt settings.xml
+    Anything else?

Doc/sphinx/whatis.rst

@@ -8,10 +8,6 @@ certain input.
 
 This "input" can vary greatly; from data in files to colors and text on the screen.
 
-..  This needs more info
-    yep
-    Not really, you basically covered what Simba is in the above paragraph.
-
 Simba can:
     *   Find and read colours on the screen.
     *   Click or move the mouse to a specific position on the screen. Typically

Doc/sphinx/whatsnew.rst

@@ -12,9 +12,15 @@ http://git.villavu.com/?p=simba.git;a=summary. Each commit should be explained
 tersely in one line, and the exact changes can be viewed with "commitdiff". This
 is a very verbose list of changes, large features or changes will be listed below:
 
-Changelog for X.XXX::
+Changelog for 715::
 
-	- Did some stuff
-		- Important note about stuff here.
-	- Other stuff
+    - Array Operator support. (=, <>, +)
+    - Foldable comments
+    - Add Disguise
+    - Add Status 
+    - Add ClearDebugImg
+    - Add PosEx
+    - Add a new interpreter
+    - Fix Hypot
+    - Fix Extension Menu Checkbox