]> git.decadent.org.uk Git - ion3.git/blobdiff - doc/ionconf/node6.html
projects / ion3.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
[svn-upgrade] Integrating new upstream version, ion3 (20070506)
[ion3.git] / doc / ionconf / node6.html
diff --git a/doc/ionconf/node6.html b/doc/ionconf/node6.html
index 17e8f34d6980950fb3a4ff4a8d13ce17a1511dd1..88aa9be89661e5a3719240a63cd598f2d4affce6 100644 (file)
--- a/doc/ionconf/node6.html
+++ b/doc/ionconf/node6.html
@@ -28,31 +28,31 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
 <BODY >
 
 <DIV CLASS="navigation"><!--Navigation Panel-->
-<A NAME="tex2html335"
+<A NAME="tex2html363"
   HREF="node7.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html329"
+<A NAME="tex2html357"
   HREF="ionconf.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html323"
+<A NAME="tex2html351"
   HREF="node5.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html331"
+<A NAME="tex2html359"
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
-<A NAME="tex2html333"
+<A NAME="tex2html361"
   HREF="node11.html">
 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
 <BR>
-<B> Next:</B> <A NAME="tex2html336"
+<B> Next:</B> <A NAME="tex2html364"
   HREF="node7.html">6. Function reference</A>
-<B> Up:</B> <A NAME="tex2html330"
+<B> Up:</B> <A NAME="tex2html358"
   HREF="ionconf.html">Configuring and extending Ion3</A>
-<B> Previous:</B> <A NAME="tex2html324"
+<B> Previous:</B> <A NAME="tex2html352"
   HREF="node5.html">4. Graphical styles</A>
- &nbsp; <B>  <A NAME="tex2html332"
+ &nbsp; <B>  <A NAME="tex2html360"
   HREF="node1.html">Contents</A></B> 
- &nbsp; <B>  <A NAME="tex2html334"
+ &nbsp; <B>  <A NAME="tex2html362"
   HREF="node11.html">Index</A></B> 
 <BR>
 <BR></DIV>
@@ -61,20 +61,20 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
 <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
 
 <UL CLASS="ChildLinks">
-<LI><A NAME="tex2html337"
+<LI><A NAME="tex2html365"
   HREF="node6.html#SECTION00610000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">1</SPAN> Hooks</A>
-<LI><A NAME="tex2html338"
+<LI><A NAME="tex2html366"
   HREF="node6.html#SECTION00620000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">2</SPAN> Referring to regions</A>
 <UL>
-<LI><A NAME="tex2html339"
+<LI><A NAME="tex2html367"
   HREF="node6.html#SECTION00621000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> Direct object references</A>
-<LI><A NAME="tex2html340"
+<LI><A NAME="tex2html368"
   HREF="node6.html#SECTION00622000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> Name-based lookups</A>
 </UL>
 <BR>
-<LI><A NAME="tex2html341"
+<LI><A NAME="tex2html369"
   HREF="node6.html#SECTION00630000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">3</SPAN> Alternative winprop selection criteria</A>
-<LI><A NAME="tex2html342"
+<LI><A NAME="tex2html370"
   HREF="node6.html#SECTION00640000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">4</SPAN> Writing <TT>ion-statusd</TT> monitors</A>
 </UL>
 <!--End of Table of Child-Links-->
@@ -89,7 +89,7 @@ original version by:  Nikos Drakos, CBLU, University of Leeds
 <P>
 This 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 <A HREF="node4.html#chap:config">3</A>.
+the basic configuration explained in chapter <A HREF="node4.html#chap:config">3</A>.
 
 <P>
 
@@ -101,16 +101,16 @@ the basic configuration exlained in chapter <A HREF="node4.html#chap:config">3</
 
 <P>
 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 <TT>true</TT> is returned, remaining handlers are not called.
 
 <P>
 Hook handlers are registered by first finding the hook
-with <A HREF="#fn:ioncore.get_hook"><TT>ioncore.get_hook</TT></A> and then calling <A HREF="#fn:WHook.add"><TT>WHook.add</TT></A>
-on the (succesfull) result with the handler as parameter. Similarly
-handlers are unregistered with <A HREF="#fn:WHook.remove"><TT>WHook.remove</TT></A>. For example:
+with <A HREF="node7.html#fn:ioncore.get_hook"><TT>ioncore.get_hook</TT></A> and then calling <A HREF="node7.html#fn:WHook.add"><TT>WHook.add</TT></A>
+on the (successful) result with the handler as parameter. Similarly
+handlers are unregistered with <A HREF="node7.html#fn:WHook.remove"><TT>WHook.remove</TT></A>. For example:
 
 <P>
 <PRE>
@@ -125,7 +125,7 @@ handlers do. The types of parameters for each hook are listed in
 the hook reference, section <A HREF="node7.html#sec:hookref">6.9</A>.
 
 <P>
-Note that many of the hooks are called in ''protected mode'' and can not 
+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.
 
@@ -142,7 +142,7 @@ documentation when this is final.
 </H3>
 
 <P>
-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 +219,10 @@ and <A HREF="node7.html#fn:ioncore.x_get_text_property"><TT>ioncore.x_get_text_p
 
 <P>
 
-<H2><A NAME="SECTION00640000000000000000">
-<SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">4</SPAN> Writing <TT>ion-statusd</TT> monitors</A>
+<H2><A NAME="SECTION00640000000000000000"></A>
+<A NAME="sec:statusd"></A>
+<BR>
+<SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">4</SPAN> Writing <TT>ion-statusd</TT> monitors
 </H2>
 
 <P>
@@ -228,11 +230,11 @@ All statusbar meters that do not monitor the internal state of Ion should
 go in the separate <TT>ion-statusd</TT> program. 
 
 <P>
-Whenever the user requests a meter <TT>%foo</TT> or <TT>%foo_bar</TT> to be 
-inserted in a statusbar, <SPAN  CLASS="textit">mod_statusbar</SPAN> asks <TT>ion-statusd</TT> to
-load <A HREF="#fn:statusd_foo.lua"><TT>statusd_foo.lua</TT></A> on its search path (same as that for Ion-side 
+Whenever the user requests a meter `<TT>%foo</TT>' or `<TT>%foo_bar</TT>' to 
+be  inserted in a statusbar, <SPAN  CLASS="textit">mod_statusbar</SPAN> asks <TT>ion-statusd</TT> 
+to load <A HREF="#fn:statusd_foo.lua"><TT>statusd_foo.lua</TT></A> on its search path (same as that for Ion-side 
 scripts). This script should then supply all meters with the initial part
-'<TT>foo</TT>'.
+`<TT>foo</TT>'.
 
 <P>
 To provide this value, the script should simply call <TT>statusd.inform</TT>
@@ -241,11 +243,11 @@ Additionally the script should provide a 'template' for the meter to
 facilitate expected width calculation by <SPAN  CLASS="textit">mod_statusbar</SPAN>, 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 <TT>normal</TT>, <TT>important</TT> and 
-<TT>critical</TT> hints.
+stock styles support the `<TT>normal</TT>', `<TT>important</TT>' and 
+`<TT>critical</TT>' hints.
 
 <P>
-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:
 
 <P>
@@ -319,31 +321,31 @@ local settings=table.join(statusd.get_config("foo"), defaults)
 
 <DIV CLASS="navigation"><HR>
 <!--Navigation Panel-->
-<A NAME="tex2html335"
+<A NAME="tex2html363"
   HREF="node7.html">
 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
-<A NAME="tex2html329"
+<A NAME="tex2html357"
   HREF="ionconf.html">
 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
-<A NAME="tex2html323"
+<A NAME="tex2html351"
   HREF="node5.html">
 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
-<A NAME="tex2html331"
+<A NAME="tex2html359"
   HREF="node1.html">
 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
-<A NAME="tex2html333"
+<A NAME="tex2html361"
   HREF="node11.html">
 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
 <BR>
-<B> Next:</B> <A NAME="tex2html336"
+<B> Next:</B> <A NAME="tex2html364"
   HREF="node7.html">6. Function reference</A>
-<B> Up:</B> <A NAME="tex2html330"
+<B> Up:</B> <A NAME="tex2html358"
   HREF="ionconf.html">Configuring and extending Ion3</A>
-<B> Previous:</B> <A NAME="tex2html324"
+<B> Previous:</B> <A NAME="tex2html352"
   HREF="node5.html">4. Graphical styles</A>
- &nbsp; <B>  <A NAME="tex2html332"
+ &nbsp; <B>  <A NAME="tex2html360"
   HREF="node1.html">Contents</A></B> 
- &nbsp; <B>  <A NAME="tex2html334"
+ &nbsp; <B>  <A NAME="tex2html362"
   HREF="node11.html">Index</A></B> </DIV>
 <!--End of Navigation Panel-->
 
Package: Ion3 [unmaintained]