Changeset 1356

Timestamp:

04/19/08 02:39:27 (3 months ago)

Author:

cederberg@gmail.com

Message:

Minor doc fixes to MochiKit.Visual (patch from Christoph Zwerschke).

Files:

• mochikit/trunk/doc/html/MochiKit/Visual.html (modified) (8 diffs)
• mochikit/trunk/doc/rst/MochiKit/Visual.rst (modified) (13 diffs)

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

@@ -76 +76 @@
-<p>By default, you have one Queue called <tt class="docutils literal"><span class="pre">'global'</span></tt>, and the effects run in
-<tt class="docutils literal"><span class="pre">'parallel'</span></tt> (see <a class="mochiref reference" href="#fn-defaultoptions">DefaultOptions</a>). Every effect has a <tt class="docutils literal"><span class="pre">queue</span></tt>
-'
+
-<tt class="docutils literal"><span class="pre">global</span></tt> scope:</p>
-<ul class="simple">
@@ -108 +108 @@
-<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>
-or <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.
-
-
+
-<dl class="docutils">
-<dt><em>Availability</em>:</dt>
@@ -214 +213 @@
-</dd>
-<dt>options:</dt>
-
+
+
-<dt><em>Availability</em>:</dt>
-<dd>Available in MochiKit 1.4+</dd>
@@ -249 +249 @@
-<dd>An effect class constructor function.</dd>
-<dt>options:</dt>
-effect classes). A special <tt class="docutils literal"><span class="pre">speed</span></tt>
-
-
-
+respective effect class). A special
+
+
+exactly 
-<table border="1" class="last docutils">
-<colgroup>
@@ -312 +312 @@
-<blockquote>
-<p>Slowly shows an <tt class="docutils literal"><span class="pre">element</span></tt> using the <a class="mochiref reference" href="#fn-opacity">Opacity</a> effect.
-
+,
-to <tt class="docutils literal"><span class="pre">&quot;display:</span> <span class="pre">block&quot;</span></tt> with <a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a>.</p>
-<dl class="docutils">
@@ -382 +382 @@
-<p>Blind an <tt class="docutils literal"><span class="pre">element</span></tt> down, restoring its vertical size using the
-<a class="mochiref reference" href="#fn-scale">Scale</a> effect. If the <tt class="docutils literal"><span class="pre">element</span></tt> has <tt class="docutils literal"><span class="pre">&quot;display:</span> <span class="pre">none&quot;</span></tt>
-
+,
-<a class="mochiref reference" href="Style.html#fn-showelement">MochiKit.Style.showElement</a>.</p>
-<dl class="docutils">
@@ -775 +775 @@
-<p>Default options for all effects. Note that all effects inherit
-the <a class="mochiref reference" href="#fn-base">Base</a> class and thereby also support a number of
-,
+
-effect options.</p>
-<table border="1" class="docutils">
@@ -839 +839 @@
-});
-</pre>
-abone the
-
-
-
+listed above,
+
+
+access to event 
-<dl class="docutils">
-<dt><em>Availability</em>:</dt>

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

@@ -80 +80 @@
-By default, you have one Queue called ``'global'``, and the effects run in
-``'parallel'`` (see :mochiref:`DefaultOptions`). Every effect has a ``queue``
-'
+
-``global`` scope:
-
@@ -111 +111 @@
-    ``className`` specifiers, using the options provided.  ``tagName``
-    or ``className`` can be ``null`` to match all tags or classes.
-
-
+
-
-    *Availability*:
@@ -126 +125 @@
-        :mochiref:`MochiKit.DOM.getElement`).
-
- 
+
-        The ``options`` mapping has the following defaults:
-
@@ -183 +182 @@
-
-    options:
-
+
+
-
-    *Availability*:
@@ -219 +219 @@
-
-    options:
-effect classes). A special ``speed``
-value will be added to the effect ``delay`` for each additional
-element in the list. This cause the effects to not run exactly
-
+respective effect class). A special
+``speed`` value will be added to the effect ``delay`` for each
+additional element in the list. This cause the effects to not run
+exactly 
-
-        ========= =================
@@ -260 +260 @@
-
-    Slowly shows an ``element`` using the :mochiref:`Opacity` effect.
-
+,
-    to ``"display: block"`` with :mochiref:`MochiKit.Style.showElement`.
-
@@ -319 +319 @@
-    Blind an ``element`` down, restoring its vertical size using the
-    :mochiref:`Scale` effect. If the ``element`` has ``"display: none"``
-
+,
-    :mochiref:`MochiKit.Style.showElement`.
-
@@ -477 +477 @@
-        ================= ========================================
-        direction         ``"center"``
-    
-    
-    
+
+
+
-        ================= ========================================
-
@@ -517 +517 @@
-        ================= ========================================
-        direction         ``"center"``
-    
-    
-    
+
+
+
-        ================= ========================================
-
@@ -609 +609 @@
-    Default options for all effects. Note that all effects inherit
-    the :mochiref:`Base` class and thereby also support a number of
-,
+
-    effect options.
-
@@ -651 +651 @@
-            slideDown('myelement');
-        });
-
-abone the
-same exists with 'Internal' (example: 'beforeStartInternal'). Their purpose
-is mainly for creating your own effect and keep the user access to event
-
+
+listed above,
+the same exists with an 'Internal' postfix (e.g. 'beforeStartInternal').
+Their purpose is mainly for creating your own effect and keep the user
+access to event 
-
-    *Availability*:
@@ -762 +762 @@
-        ``"contents"``   Uses ``scrollHeight`` and ``scrollWidth``
-        {...}            Uses ``originalHeight`` and ``originalWidth`` from the specified object
-        
+
-
-    *Availability*:
@@ -814 +814 @@
-    ``style`` with an array holding the styles to change. It works with
-    properties for size (``font-size``, ``border-width``, ...) and properties
- 
+
-
-    For size, it's better to have defined the original style. You *must*
-    use the same unit in the call to Morph (no translation exists between two
-    different units).
-
+
-    Parsed length are postfixed with: em, ex, px, in, cm, mm, pt, pc.
-
+
-    Example::
-
+
-        <div id="foo" style="font-size: 1em">MyDiv</div>
-        ...