X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;ds=sidebyside;f=ionconf%2Fnode6.html;h=7baa979c00be598aa0b2fa0fa9de890c072a6bbd;hb=20071109;hp=8c985d1cb3fa2bed420c7114658bcb529fc9f1be;hpb=16a5f824c31d29598763c5f49918ef67a47ad7e0;p=ion3-doc.git diff --git a/ionconf/node6.html b/ionconf/node6.html index 8c985d1..7baa979 100644 --- a/ionconf/node6.html +++ b/ionconf/node6.html @@ -28,31 +28,31 @@ original version by: Nikos Drakos, CBLU, University of Leeds
@@ -61,20 +61,20 @@ original version by: Nikos Drakos, CBLU, University of Leeds SubsectionsThis chapter documents some additional features of the Ion configuration and scripting interface that can be used for more advanced scripting than -the basic configuration exlained in chapter 3. +the basic configuration explained in chapter 3.
@@ -101,16 +101,16 @@ the basic configuration exlained in chapter 3
Hooks are lists of functions to be called when a certain event occurs.
-There are two types of them; normal and ''alternative'' hooks. Normal
+There are two types of them; normal and ``alternative'' hooks. Normal
hooks do not return anything, but alt-hooks should return a boolean
-indicating whether it handled its assigned task succesfully. In the case
+indicating whether it handled its assigned task successfully. In the case
that true is returned, remaining handlers are not called.
Hook handlers are registered by first finding the hook
-with ioncore.get_hook and then calling WHook.add
-on the (succesfull) result with the handler as parameter. Similarly
-handlers are unregistered with WHook.remove. For example:
+with ioncore.get_hook and then calling WHook.add
+on the (successful) result with the handler as parameter. Similarly
+handlers are unregistered with WHook.remove. For example:
In this example the hook handler has no parameters, but many hook
handlers do. The types of parameters for each hook are listed in
-the hook reference, section 6.8.
+the hook reference, section 6.9.
-Note that many of the hooks are called in ''protected mode'' and can not
-use any functions that modify Ion's internal state. TODO: More detailed
-documentation when this is final.
+Note that many of the hooks are called in ``protected mode'' and can not
+use any functions that modify Ion's internal state.
@@ -142,7 +141,7 @@ documentation when this is final.
-All Ion objects are passed to Lua scriptss as 'userdatas', and you may
+All Ion objects are passed to Lua scripts as 'userdatas', and you may
safely store such object references for future use. The C-side object
may be destroyed while Lua still refers to the object. All exported
functions gracefully fail in such a case, but if you need to explicitly
@@ -219,8 +218,10 @@ and ioncore.x_get_text_p
-
@@ -228,11 +229,11 @@ All statusbar meters that do not monitor the internal state of Ion should
go in the separate ion-statusd program.
-Whenever the user requests a meter %foo or %foo_bar to be
-inserted in a statusbar, mod_statusbar asks ion-statusd to
-load statusd_foo.lua on its search path (same as that for Ion-side
+Whenever the user requests a meter `%foo' or `%foo_bar' to
+be inserted in a statusbar, mod_statusbar asks ion-statusd
+to load statusd_foo.lua on its search path (same as that for Ion-side
scripts). This script should then supply all meters with the initial part
-'foo'.
+`foo'.
To provide this value, the script should simply call statusd.inform
@@ -241,11 +242,11 @@ Additionally the script should provide a 'template' for the meter to
facilitate expected width calculation by mod_statusbar, and
may provide a 'hint' for colour-coding the value. The interpretation
of hints depends on the graphical style in use, and currently the
-stock styles support the normal, important and
-critical hints.
+stock styles support the `normal', `important' and
+`critical' hints.
-In our example of the 'foo monitor', at script init we might broadcast
+In our example of the 'foo monitor', at script initialisation we might broadcast
the template as follows:
@@ -319,31 +320,31 @@ local settings=table.join(statusd.get_config("foo"), defaults)
@@ -122,12 +122,11 @@ ioncore.get_hook("ioncore_snapshot_hook"):add(
-5.4 Writing ion-statusd monitors
+
+
+
+5.4 Writing ion-statusd monitors