From aa599255740ca9024fd7d460fa45ed0bf3bb4f62 Mon Sep 17 00:00:00 2001 From: Merlijn Wajer Date: Sun, 13 Jun 2010 15:34:39 +0200 Subject: [PATCH] Few reverts and other changes. :-) --- Doc/sphinx/docdoc.rst | 11 +++++++++++ Doc/sphinx/gettingstarted.rst | 18 +++++++++--------- Doc/sphinx/simbaref/extensions.rst | 15 +++++++++++---- 3 files changed, 31 insertions(+), 13 deletions(-) diff --git a/Doc/sphinx/docdoc.rst b/Doc/sphinx/docdoc.rst index ae578e6..f13db03 100644 --- a/Doc/sphinx/docdoc.rst +++ b/Doc/sphinx/docdoc.rst @@ -57,3 +57,14 @@ part of the documentation, place it in the ``simbaref``, ``scriptref`` or ``features`` folder repectively. Any other files can be put directly in the root of the sphinx folder. (The same place as ``index.rst``) + +Capitalisation +~~~~~~~~~~~~~~ + +The titles of all major sections have all worlds capitalized. (The ones with +===) +The minor sections and subsections (---) and (~~~) have only the first word +Simba specific words (like Simba itself) capitalized. + +Try to stick to the Python documentation standards. +( http://docs.python.org/using/index.html ) diff --git a/Doc/sphinx/gettingstarted.rst b/Doc/sphinx/gettingstarted.rst index fe8e038..82c15eb 100644 --- a/Doc/sphinx/gettingstarted.rst +++ b/Doc/sphinx/gettingstarted.rst @@ -1,10 +1,10 @@ -Getting started with Simba +Getting Started With Simba ========================== This page will help you install Simba and highlight some basic Simba features. -Installing Simba +Installing simba ---------------- Installing Simba is pretty straighforward and will only take a couple of @@ -32,14 +32,14 @@ Tools -> Update. .. note:: Updating Simba regularly is recommended. -Simba Binary -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Downloading Simba binary +~~~~~~~~~~~~~~~~~~~~~~~~ + +This is harder and not recommended. Steps on how to do this will follow later. + +For now, simply stick to the installer and update Simba after the install has +completed. -This is not the recommended method due to some computers having problems -with FreePascal and Lazarus. However, all you must do is install FreePascal -and Lazarus (from repos or non) and open the Simba project file located -in the repository (retrieve the project with git). -You should then see a prominent "compile" button. Yay! Setting up SRL 4 with Simba --------------------------- diff --git a/Doc/sphinx/simbaref/extensions.rst b/Doc/sphinx/simbaref/extensions.rst index 9479b06..ec1fabb 100644 --- a/Doc/sphinx/simbaref/extensions.rst +++ b/Doc/sphinx/simbaref/extensions.rst @@ -9,7 +9,12 @@ Simba. Purposes vary from updaters to editors. How they work ------------- -Extensions are event based. Functions from the extension are called based on external events. +.. Explain what event based is. The documents are not just for people who are + already familiar with the term event based. + +Extensions are event based. This means you don't have some ``loop`` in your +program that never ends and does all the logic for you. When a system is event +based, you implement some functions and those are called on a certain event. Extension core hooks -------------------- @@ -185,8 +190,12 @@ onColourPick onScriptStart ~~~~~~~~~~~~~ + Special Cases -~~~~~~~~~~~~~ +------------- + +.. his is supposed to document the special cases, and multiple extensions + hooking onto the same event is a special case. Multiple extensions hooking onto the same event ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -208,8 +217,6 @@ Extensions can be very dangerous in the sense that they run on the main thread of Simba, it is very easy to crash Simba or make it hang. There is no way to prevent this, so make sure to check what you're doing before you try your own (or someone else's) extension. - - .. _extension-example-code: