Changeset 1326

Show
Ignore:
Timestamp:
03/12/08 07:43:30 (4 months ago)
Author:
bob@redivi.com
Message:

#292

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r1308 r1326  
    3535<div class="section"> 
    3636<h1><a id="description" name="description">Description</a></h1> 
    37 <p>MochiKit.Visual provides visual effects and support functions for 
    38 visuals.</p> 
     37<p>MochiKit.Visual provides visual effects and animations for HTML elements.</p> 
    3938</div> 
    4039<div class="section"> 
    …… 
    5049<div class="section"> 
    5150<h1><a id="overview" name="overview">Overview</a></h1> 
    52 <p>MochiKit.Visual provides different visual effect: rounded corners and 
     51<p>MochiKit.Visual provides different visual effects: rounded corners and 
    5352animations for your HTML elements. Rounded corners are created 
    5453completely through CSS manipulations and require no external images or 
    …… 
    6766<tt class="docutils literal"><span class="pre">className</span></tt> specifiers, using the options provided.  <tt class="docutils literal"><span class="pre">tagName</span></tt> 
    6867or <tt class="docutils literal"><span class="pre">className</span></tt> can be <tt class="docutils literal"><span class="pre">null</span></tt> to match all tags or classes. 
    69 For more information about the options, see the 
     68For more information about the <tt class="docutils literal"><span class="pre">options</span></tt>, see the 
    7069<a class="mochiref reference" href="#fn-roundelement">roundElement</a> function.</p> 
    7170<dl class="docutils"> 
    …… 
    7877<a class="mochidef reference" href="#fn-roundelement">roundElement(element[, options])</a>:</p> 
    7978<blockquote> 
    80 <p>Immediately round the corners of the specified element.  The 
    81 element can be given as either a string with the element ID, or as 
    82 an element object.</p> 
    83 <p>The options mapping has the following defaults:</p> 
    84 <table border="1" class="docutils"> 
     79<p>Immediately round the corners of the specified <tt class="docutils literal"><span class="pre">element</span></tt>.</p> 
     80<dl class="docutils"> 
     81<dt>element:</dt> 
     82<dd>An element ID string or a DOM node (see 
     83<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     84<dt>options:</dt> 
     85<dd><p class="first">The <tt class="docutils literal"><span class="pre">options</span></tt> mapping has the following defaults:</p> 
     86<table border="1" class="last docutils"> 
    8587<colgroup> 
    8688<col width="35%" /> 
    …… 
    108110</tbody> 
    109111</table> 
    110 <p>corners:</p> 
    111 <blockquote> 
    112 <p>specifies which corners of the element should be rounded. 
     112</dd> 
     113</dl> 
     114<p>The <tt class="docutils literal"><span class="pre">options</span></tt> parameters can have following values:</p> 
     115<dl class="docutils"> 
     116<dt>corners:</dt> 
     117<dd><p class="first">Specifies which corners of the element should be rounded. 
    113118Choices are:</p> 
    114119<ul class="simple"> 
    …… 
    121126<li>br (bottom right)</li> 
    122127</ul> 
    123 <dl class="docutils"> 
     128<dl class="last docutils"> 
    124129<dt>Example:</dt> 
    125130<dd><tt class="docutils literal"><span class="pre">&quot;tl</span> <span class="pre">br&quot;</span></tt>: top-left and bottom-right corners are rounded</dd> 
    126131</dl> 
    127 </blockquote> 
    128 <dl class="docutils"> 
     132</dd> 
    129133<dt>blend:</dt> 
    130 <dd>specifies whether the color and background color should be 
     134<dd>Specifies whether the color and background color should be 
    131135blended together to produce the border color.</dd> 
    132136<dt><em>Availability</em>:</dt> 
    …… 
    138142<a class="mochidef reference" href="#fn-toggle">toggle(element[, effect[, options]])</a>:</p> 
    139143<blockquote> 
    140 <p>Toggle an element between visible and invisible state using an effect.</p> 
    141 <dl class="docutils"> 
     144<p>Toggle an <tt class="docutils literal"><span class="pre">element</span></tt> between visible and invisible state using an 
     145effect.</p> 
     146<dl class="docutils"> 
     147<dt>element:</dt> 
     148<dd>An element ID string or a DOM node (see 
     149<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
    142150<dt>effect:</dt> 
    143 <dd>One of the visual pairs to use, between 'slide', 'blind', 
     151<dd>One of the visual pairs to use. Choose between 'slide', 'blind', 
    144152'appear', and 'size'.</dd> 
     153<dt>options:</dt> 
     154<dd>The optional effect options (see effect functions for details).</dd> 
    145155<dt><em>Availability</em>:</dt> 
    146156<dd>Available in MochiKit 1.4+</dd> 
    …… 
    151161<a class="mochidef reference" href="#fn-tagifytext">tagifyText(element[, tagifyStyle])</a>:</p> 
    152162<blockquote> 
    153 <p>Transform a node text into nodes containing one letter by tag.</p> 
    154 <dl class="docutils"> 
     163<p>Transform the node text into <tt class="docutils literal"><span class="pre">SPAN</span></tt> nodes each containing a single 
     164letter. Only text nodes that are immediate children will be modified 
     165by this function.</p> 
     166<dl class="docutils"> 
     167<dt>element:</dt> 
     168<dd>An element ID string or a DOM node (see 
     169<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
    155170<dt>tagifyStyle:</dt> 
    156 <dd>style to apply to character nodes, default to 'position: 
    157 relative'.</dd> 
     171<dd>Style to apply to each new <tt class="docutils literal"><span class="pre">SPAN</span></tt> node, defaults to 
     172<tt class="docutils literal"><span class="pre">'position:</span> <span class="pre">relative'</span></tt>.</dd> 
    158173<dt><em>Availability</em>:</dt> 
    159174<dd>Available in MochiKit 1.4+</dd> 
    …… 
    164179<a class="mochidef reference" href="#fn-multiple">multiple(elements, effect[, options])</a>:</p> 
    165180<blockquote> 
    166 <p>Launch the same effect on a list of elements.</p> 
    167 <dl class="docutils"> 
     181<p>Launch the same effect on a list of <tt class="docutils literal"><span class="pre">elements</span></tt>.</p> 
     182<dl class="docutils"> 
     183<dt>element:</dt> 
     184<dd>A list of element ID strings or a DOM nodes (see 
     185<a class="mochiref reference" href="DOM.html#fn-getelement">MochiKit.DOM.getElement</a>).</dd> 
     186<dt>effect:</dt> 
     187<dd>An effect class constructor function.</dd> 
     188<dt>options:</dt> 
     189<dd>The optional effect options (see effect classes for details).</dd> 
    168190<dt><em>Availability</em>:</dt> 
    169191<dd>Available in MochiKit 1.4+</dd> 

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

    r1308 r1326  
    2525=========== 
    2626 
    27 MochiKit.Visual provides visual effects and support functions for 
    28 visuals. 
     27MochiKit.Visual provides visual effects and animations for HTML elements. 
    2928 
    3029 
    …… 
    4140======== 
    4241 
    43 MochiKit.Visual provides different visual effect: rounded corners and 
     42MochiKit.Visual provides different visual effects: rounded corners and 
    4443animations for your HTML elements. Rounded corners are created 
    4544completely through CSS manipulations and require no external images or 
    …… 
    6362    ``className`` specifiers, using the options provided.  ``tagName`` 
    6463    or ``className`` can be ``null`` to match all tags or classes. 
    65     For more information about the options, see the 
     64    For more information about the ``options``, see the 
    6665    :mochiref:`roundElement` function. 
    6766 
    …… 
    7271:mochidef:`roundElement(element[, options])`: 
    7372 
    74     Immediately round the corners of the specified element.  The 
    75     element can be given as either a string with the element ID, or as 
    76     an element object. 
    77  
    78     The options mapping has the following defaults: 
    79  
    80     ========= ================= 
    81     corners   ``"all"`` 
    82     color     ``"fromElement"`` 
    83     bgColor   ``"fromParent"`` 
    84     blend     ``true`` 
    85     border    ``false`` 
    86     compact   ``false`` 
    87     ========= ================= 
     73    Immediately round the corners of the specified ``element``. 
     74 
     75    element: 
     76        An element ID string or a DOM node (see 
     77        :mochiref:`MochiKit.DOM.getElement`). 
     78 
     79    options:  
     80        The ``options`` mapping has the following defaults: 
     81 
     82        ========= ================= 
     83        corners   ``"all"`` 
     84        color     ``"fromElement"`` 
     85        bgColor   ``"fromParent"`` 
     86        blend     ``true`` 
     87        border    ``false`` 
     88        compact   ``false`` 
     89        ========= ================= 
     90 
     91    The ``options`` parameters can have following values: 
    8892 
    8993    corners: 
    90  
    91         specifies which corners of the element should be rounded. 
     94        Specifies which corners of the element should be rounded. 
    9295        Choices are: 
    9396 
    …… 
    104107 
    105108    blend: 
    106         specifies whether the color and background color should be 
     109        Specifies whether the color and background color should be 
    107110        blended together to produce the border color. 
    108111 
    …… 
    113116:mochidef:`toggle(element[, effect[, options]])`: 
    114117 
    115     Toggle an element between visible and invisible state using an effect. 
     118    Toggle an ``element`` between visible and invisible state using an 
     119    effect. 
     120 
     121    element: 
     122        An element ID string or a DOM node (see 
     123        :mochiref:`MochiKit.DOM.getElement`). 
    116124 
    117125    effect: 
    118         One of the visual pairs to use, between 'slide', 'blind', 
     126        One of the visual pairs to use. Choose between 'slide', 'blind', 
    119127        'appear', and 'size'. 
    120128 
     129    options: 
     130        The optional effect options (see effect functions for details). 
     131 
    121132    *Availability*: 
    122133        Available in MochiKit 1.4+ 
    …… 
    125136:mochidef:`tagifyText(element[, tagifyStyle])`: 
    126137 
    127     Transform a node text into nodes containing one letter by tag. 
     138    Transform the node text into ``SPAN`` nodes each containing a single 
     139    letter. Only text nodes that are immediate children will be modified 
     140    by this function. 
     141 
     142    element: 
     143        An element ID string or a DOM node (see 
     144        :mochiref:`MochiKit.DOM.getElement`). 
    128145 
    129146    tagifyStyle: 
    130         style to apply to character nodes, default to 'position: 
    131         relative'. 
     147        Style to apply to each new ``SPAN`` node, defaults to 
     148        ``'position: relative'``. 
    132149 
    133150    *Availability*: 
    …… 
    137154:mochidef:`multiple(elements, effect[, options])`: 
    138155 
    139     Launch the same effect on a list of elements. 
     156    Launch the same effect on a list of ``elements``. 
     157 
     158    element: 
     159        A list of element ID strings or a DOM nodes (see 
     160        :mochiref:`MochiKit.DOM.getElement`). 
     161 
     162    effect: 
     163        An effect class constructor function. 
     164 
     165    options: 
     166        The optional effect options (see effect classes for details). 
    140167 
    141168    *Availability*: