Changeset 1328

Show
Ignore:
Timestamp:
03/16/08 09:38:38 (4 months ago)
Author:
cederberg@gmail.com
Message:

Fixed docs for MochiKit.Visual.multiple() function.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • mochikit/trunk/doc/html/MochiKit/Visual.html

    r1327 r1328  
    208208<p>Launch the same effect on a list of <tt class="docutils literal"><span class="pre">elements</span></tt>.</p> 
    209209<dl class="docutils"> 
    210 <dt>element:</dt> 
     210<dt>elements:</dt> 
    211211<dd>A list of element ID strings or a DOM nodes (see 
    212212<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
    …… 
    214214<dd>An effect class constructor function.</dd> 
    215215<dt>options:</dt> 
    216 <dd>The optional effect options (see effect classes for details).</dd> 
     216<dd><p class="first">The effect options (see the effect classes). A special <tt class="docutils literal"><span class="pre">speed</span></tt> 
     217value will be added to the effect <tt class="docutils literal"><span class="pre">delay</span></tt> for each additional 
     218element in the list. This cause the effects to not run exactly 
     219in parallel by default.</p> 
     220<table border="1" class="last docutils"> 
     221<colgroup> 
     222<col width="35%" /> 
     223<col width="65%" /> 
     224</colgroup> 
     225<tbody valign="top"> 
     226<tr><td>speed</td> 
     227<td><tt class="docutils literal"><span class="pre">0.1</span></tt></td> 
     228</tr> 
     229<tr><td>delay</td> 
     230<td><tt class="docutils literal"><span class="pre">0.0</span></tt> (initial)</td> 
     231</tr> 
     232</tbody> 
     233</table> 
     234</dd> 
    217235<dt><em>Availability</em>:</dt> 
    218236<dd>Available in MochiKit 1.4+</dd> 

  • mochikit/trunk/doc/rst/MochiKit/Visual.rst

    r1327 r1328  
    3636- :mochiref:`MochiKit.Color` 
    3737- :mochiref:`MochiKit.Position` 
     38 
    3839 
    3940Overview 
    …… 
    6869- `parallel`: the effect run normally with others. 
    6970 
    70  
    7171But you have even more control if you use an array with the following keys: 
    7272 
    …… 
    186186    Launch the same effect on a list of ``elements``. 
    187187 
    188     element: 
     188    elements: 
    189189        A list of element ID strings or a DOM nodes (see 
    190190        :mochiref:`MochiKit.DOM.getElement`). 
    …… 
    194194 
    195195    options: 
    196         The optional effect options (see effect classes for details). 
     196        The effect options (see the effect classes). A special ``speed`` 
     197        value will be added to the effect ``delay`` for each additional 
     198        element in the list. This cause the effects to not run exactly 
     199        in parallel by default. 
     200 
     201        ========= ================= 
     202        speed     ``0.1`` 
     203        delay     ``0.0`` (initial) 
     204        ========= ================= 
    197205 
    198206    *Availability*: