From 8d6d6e039aa379b60edd61896dade90b23bb8596 Mon Sep 17 00:00:00 2001 From: Merlijn Wajer Date: Wed, 8 Dec 2010 01:02:42 +0100 Subject: [PATCH] Simbadoc: Update documentation. --- Doc/sphinx/features/autoupdate.rst | 9 +++++---- Doc/sphinx/features/notwellknown.rst | 5 ++++- Doc/sphinx/features/scriptmanager.rst | 2 +- Doc/sphinx/gettingstarted.rst | 5 +++++ Doc/sphinx/mmlref/libmml.rst | 6 ++++++ Doc/sphinx/referencemml.rst | 5 +++++ Doc/sphinx/troubleshooting.rst | 2 +- Doc/sphinx/tutorial.rst | 2 ++ Doc/sphinx/whatsnew.rst | 18 ++---------------- Doc/sphinx/whysimba.rst | 6 +++++- 10 files changed, 36 insertions(+), 24 deletions(-) create mode 100644 Doc/sphinx/mmlref/libmml.rst diff --git a/Doc/sphinx/features/autoupdate.rst b/Doc/sphinx/features/autoupdate.rst index c3fa80a..2d214ab 100644 --- a/Doc/sphinx/features/autoupdate.rst +++ b/Doc/sphinx/features/autoupdate.rst @@ -1,8 +1,9 @@ Updater in Simba ================ -A notice should appear in the Simba GUI, or you can alternatively -use Tools -> Update. - -Don't forget to restart Simba when it has been updated! +As soon as there is an update for Simba, an extra icon will appear in the icon +bar. If you click it, an update window will appear. Click *update* and Simba +will update itself. Note that you will have to restart Simba to use the updated +version. +Alternatively you can use Tools -> Update to update. diff --git a/Doc/sphinx/features/notwellknown.rst b/Doc/sphinx/features/notwellknown.rst index 125ab16..c7be836 100644 --- a/Doc/sphinx/features/notwellknown.rst +++ b/Doc/sphinx/features/notwellknown.rst @@ -1,10 +1,13 @@ Not Well Known Features ======================= +Simba has several features that are relatively unknown. +A few will be listed here. + Timestamped Writeln ------------------- -Simba can timestamp all your *writeln* calls. +Simba can timestamp all your debug. .. code-block:: pascal diff --git a/Doc/sphinx/features/scriptmanager.rst b/Doc/sphinx/features/scriptmanager.rst index 7668534..774bacb 100644 --- a/Doc/sphinx/features/scriptmanager.rst +++ b/Doc/sphinx/features/scriptmanager.rst @@ -2,4 +2,4 @@ Simba Script Manager ==================== Community-created scripts will be available for download from the -Script Manager. +Script Manager. The script manager will appear in release 1.0. diff --git a/Doc/sphinx/gettingstarted.rst b/Doc/sphinx/gettingstarted.rst index d576fb4..c3d5aed 100644 --- a/Doc/sphinx/gettingstarted.rst +++ b/Doc/sphinx/gettingstarted.rst @@ -60,6 +60,11 @@ This is the only supported way. You can simply do a svn checkout on the srl repository, but if you can do that, then you should be able to set up SRL yourself as well. +Setting up SRL 5 with Simba +--------------------------- + +This will follow later, upon SRL 5 release. (Which will be quite soon) + Installing scripts ------------------ diff --git a/Doc/sphinx/mmlref/libmml.rst b/Doc/sphinx/mmlref/libmml.rst new file mode 100644 index 0000000..b56fff6 --- /dev/null +++ b/Doc/sphinx/mmlref/libmml.rst @@ -0,0 +1,6 @@ +libMML +====== + +libMML is an effort to bring the entire MML to a single standalone library. + +MML usage will appear here soon. diff --git a/Doc/sphinx/referencemml.rst b/Doc/sphinx/referencemml.rst index 65d33c5..4598022 100644 --- a/Doc/sphinx/referencemml.rst +++ b/Doc/sphinx/referencemml.rst @@ -6,6 +6,10 @@ provide scripts with the required functionality, but also used to pick colours and select windows with Simba itself. The MML can run without any user interface. +There currently is an effort to create a standalone library of the MML; called +*libMML*. This way any application can just load the library and use the MML +functionality. + The MML is split up in "Core" classes and "Addon" classes. .. note:: @@ -20,3 +24,4 @@ The MML is split up in "Core" classes and "Addon" classes. mmlref/finder.rst mmlref/bitmap.rst mmlref/ocr.rst + mmlref/libmml diff --git a/Doc/sphinx/troubleshooting.rst b/Doc/sphinx/troubleshooting.rst index d6a054b..e2dc2e3 100644 --- a/Doc/sphinx/troubleshooting.rst +++ b/Doc/sphinx/troubleshooting.rst @@ -25,7 +25,7 @@ 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. +Note that this should no longer happen with Simba 750 and up. .. Anything else? diff --git a/Doc/sphinx/tutorial.rst b/Doc/sphinx/tutorial.rst index cbe3d56..04bf7cc 100644 --- a/Doc/sphinx/tutorial.rst +++ b/Doc/sphinx/tutorial.rst @@ -2,3 +2,5 @@ Tutorial ================= Complete tutorial. + +.. What should be in here in the first place? diff --git a/Doc/sphinx/whatsnew.rst b/Doc/sphinx/whatsnew.rst index 5861641..c0c1640 100644 --- a/Doc/sphinx/whatsnew.rst +++ b/Doc/sphinx/whatsnew.rst @@ -5,22 +5,8 @@ Currently Simba is still in its beta stages; this includes the documentation. You will probably notice some parts of the documentation aren't finished or are just plain missing. -So what's new in Simba? This documentation system. - Simba is being updated almost every day. To see changes as they are added, view 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 715:: - - - Array Operator support. (=, <>, +) - - Foldable comments - - Add Disguise - - Add Status - - Add ClearDebugImg - - Add PosEx - - Add a new interpreter - - Fix Hypot - - Fix Extension Menu Checkbox +tersely in one line, and the exact changes can be viewed with "commitdiff". +A list of new features since 750 will show up here eventually. diff --git a/Doc/sphinx/whysimba.rst b/Doc/sphinx/whysimba.rst index a1ee8e3..6ca1a7c 100644 --- a/Doc/sphinx/whysimba.rst +++ b/Doc/sphinx/whysimba.rst @@ -64,6 +64,10 @@ some issues remain. The biggest issue is the interpreter that executes your program. It is an external component and does not play too well on Linux. Hopefully this will be improved upon soon. +There are plans on supporting interpreter for alternative languages such as +Python, these would largely resolve the current problems wit the PascalScript +interpreter on Linux/Mac. + Fast ~~~~ @@ -91,5 +95,5 @@ Well Documented ~~~~~~~~~~~~~~~ Simba is well documented. (You're looking the documentation right now...) -There is still stuff left to document but overall the documentation is pretty +There is still a lot left to document but overall the documentation is pretty good.