Skip to content

Commit 8103e08

Browse files
agcolomAurelioDeRosa
authored andcommitted
Entries: Added description to Figures
Closes gh-841
1 parent a232f00 commit 8103e08

25 files changed

+28
-27
lines changed

entries/animate.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@ $( "#clickme" ).click(function() {
5858
<p class="image">
5959
<figure>
6060
<img src="/resources/animate-1.jpg" alt=""/>
61-
<figcaption>figure 1</figcaption>
61+
<figcaption>Figure 1 - Illustration of the specified animation effect</figcaption>
6262
</figure>
6363
</p>
6464
<p>Note that the target value of the <code>height</code> property is <code>'toggle'</code>. Since the image was visible before, the animation shrinks the height to 0 to hide it. A second click then reverses this transition:
6565
</p>
6666
<p class="image">
6767
<figure>
6868
<img src="/resources/animate-2.jpg" alt=""/>
69-
<figcaption>figure 2</figcaption>
69+
<figcaption>Figure 2 - Illustration of the specified animation effect</figcaption>
7070
</figure>
7171
</p>
7272
<p>The <code>opacity</code> of the image is already at its target value, so this property is not animated by the second click. Since the target value for <code>left</code> is a relative value, the image moves even farther to the right during this second animation.</p>

entries/click.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</code></pre>
3737
<figure>
3838
<img src="/resources/0042_05_03.png" alt=""/>
39-
<figcaption>figure 1</figcaption>
39+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4040
</figure>
4141
<p>The event handler can be bound to any <code>&lt;div&gt;</code>:</p>
4242
<pre><code>

entries/dblclick.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</code></pre>
3737
<figure>
3838
<img src="/resources/0042_05_04.png" alt=""/>
39-
<figcaption>figure 1</figcaption>
39+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4040
</figure>
4141
<p>The event handler can be bound to any <code>&lt;div&gt;</code>:</p>
4242
<pre><code>

entries/fadeIn.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ $( "#clickme" ).click(function() {
4040
<img class="column three" src="/resources/0042_06_34.png" alt=""/>
4141
<img class="column three" src="/resources/0042_06_35.png" alt=""/>
4242
<img class="column three" src="/resources/0042_06_36.png" alt=""/>
43-
<figcaption>figure 1</figcaption>
43+
<figcaption>Figure 1 - Illustration of the <code>fadeIn()</code> effect</figcaption>
4444
</figure>
4545
<h4 id="easing">Easing</h4>
4646
<p><strong>As of jQuery 1.4.3</strong>, an optional string naming an easing function may be used. Easing functions specify the speed at which the animation progresses at different points within the animation. The only easing implementations in the jQuery library are the default, called <code>swing</code>, and one that progresses at a constant pace, called <code>linear</code>. More easing functions are available with the use of plug-ins, most notably the <a href="http://jqueryui.com">jQuery UI suite</a>.</p>

entries/fadeOut.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ $( "#clickme" ).click(function() {
4141
<img class="column three" src="/resources/0042_06_38.png" alt=""/>
4242
<img class="column three" src="/resources/0042_06_39.png" alt=""/>
4343
<img class="column three" src="/resources/0042_06_40.png" alt=""/>
44-
<figcaption>figure 1</figcaption>
44+
<figcaption>Figure 1 - Illustration of the <code>fadeOut()</code> effect</figcaption>
4545
</figure>
4646
<div class="warning">
4747
<p><strong>Note: </strong>To avoid unnecessary DOM manipulation, <code>.fadeOut()</code> will not hide an element that is already considered hidden. For information on which elements jQuery considers hidden, see <a href="/hidden-selector/"> :hidden Selector</a>.</p>

entries/fadeTo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ $( "#clickme" ).click(function() {
5555
<img class="column three" src="/resources/0042_06_42.png" alt=""/>
5656
<img class="column three" src="/resources/0042_06_43.png" alt=""/>
5757
<img class="column three" src="/resources/0042_06_44.png" alt=""/>
58-
<figcaption>figure 1</figcaption>
58+
<figcaption>Figure 1 - Illustration of the <code>fadeTo()</code> effect</figcaption>
5959
</figure>
6060
<p>With <code>duration</code> set to <code>0</code>, this method just changes the <code>opacity</code> CSS property, so <code>.fadeTo( 0, opacity )</code> is the same as <code>.css( "opacity", opacity )</code>.</p>
6161
</longdesc>

entries/height.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<p>The difference between <code>.css( "height" )</code> and <code>.height()</code> is that the latter returns a unit-less pixel value (for example, <code>400</code>) while the former returns a value with units intact (for example, <code>400px</code>). The <code>.height()</code> method is recommended when an element's height needs to be used in a mathematical calculation.</p>
1212
<figure>
1313
<img src="/resources/0042_04_01.png"/>
14-
<figcaption>figure 1</figcaption>
14+
<figcaption>Figure 1 - Illustration of the measured height</figcaption>
1515
</figure>
1616
<p>This method is also able to find the height of the window and document.</p>
1717
<pre><code>

entries/hide.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ $( "#clickme" ).click(function() {
6060
<img class="column three" src="/resources/0042_06_06.png" alt=""/>
6161
<img class="column three" src="/resources/0042_06_07.png" alt=""/>
6262
<img class="column three" src="/resources/0042_06_08.png" alt=""/>
63+
<figcaption>Figure 1 - Illustration of the <code>hide()</code> effect</figcaption>
6364
</figure>
6465
</longdesc>
6566
<note id="jquery.fx.off" type="additional" data-title=".hide()"/>

entries/innerHeight.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<p>This method is not applicable to <code>window</code> and <code>document</code> objects; for these, use <code><a href="/height/">.height()</a></code> instead.</p>
1414
<figure>
1515
<img src="/resources/0042_04_02.png"/>
16-
<figcaption>figure 1</figcaption>
16+
<figcaption>Figure 1 - Illustration of the measured height</figcaption>
1717
</figure>
1818
</longdesc>
1919
<note id="dimensions-number" type="additional" data-title=".innerHeight()"/>

entries/innerWidth.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<p>This method is not applicable to <code>window</code> and <code>document</code> objects; for these, use <code><a href="/width/">.width()</a></code> instead.</p>
1313
<figure>
1414
<img src="/resources/0042_04_05.png"/>
15-
<figcaption>figure 1</figcaption>
15+
<figcaption>Figure 1 - Illustration of the measured width</figcaption>
1616
</figure>
1717
</longdesc>
1818
<note id="dimensions-number" type="additional" data-title=".innerWidth()"/>

entries/mousedown.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
</code></pre>
3636
<figure>
3737
<img src="/resources/0042_05_01.png" alt=""/>
38-
<figcaption>figure 1</figcaption>
38+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
3939
</figure>
4040
<p>The event handler can be bound to any <code>&lt;div&gt;</code>:</p>
4141
<pre><code>

entries/mouseenter.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
&lt;div id="log"&gt;&lt;/div&gt;</code></pre>
4040
<figure>
4141
<img src="/resources/0042_05_08.png" alt=""/>
42-
<figcaption>figure 1</figcaption>
42+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4343
</figure>
4444
<p>The event handler can be bound to any element:</p>
4545
<pre><code>

entries/mouseleave.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
&lt;div id="log"&gt;&lt;/div&gt;</code></pre>
4040
<figure>
4141
<img src="/resources/0042_05_09.png" alt=""/>
42-
<figcaption>figure 1</figcaption>
42+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4343
</figure>
4444
<p>The event handler can be bound to any element:</p>
4545
<pre><code>

entries/mouseout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
</code></pre>
4141
<figure>
4242
<img src="/resources/0042_05_07.png" alt=""/>
43-
<figcaption>figure 1</figcaption>
43+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4444
</figure>
4545
<p>The event handler can be bound to any element:</p>
4646
<pre><code>

entries/mouseover.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
</code></pre>
4141
<figure>
4242
<img src="/resources/0042_05_06.png" alt=""/>
43-
<figcaption>figure 1</figcaption>
43+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4444
</figure>
4545
<p>The event handler can be bound to any element:</p>
4646
<pre><code>

entries/mouseup.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</code></pre>
3737
<figure>
3838
<img src="/resources/0042_05_02.png" alt=""/>
39-
<figcaption>figure 1</figcaption>
39+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4040
</figure>
4141
<p>The event handler can be bound to any <code>&lt;div&gt;</code>:</p>
4242
<pre><code>

entries/outerHeight.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<p>This method is not applicable to <code>window</code> and <code>document</code> objects; for these, use <code><a href="/height/">.height()</a></code> instead.</p>
1616
<figure>
1717
<img src="/resources/0042_04_03.png"/>
18-
<figcaption>figure 1</figcaption>
18+
<figcaption>Figure 1 - Illustration of the measured height</figcaption>
1919
</figure>
2020
</longdesc>
2121
<note id="dimensions-number" type="additional" data-title=".outerHeight()"/>

entries/outerWidth.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<p>This method is not applicable to <code>window</code> and <code>document</code> objects; for these, use <code><a href="/width/">.width()</a></code> instead. Although <code>.outerWidth()</code> can be used on table elements, it may give unexpected results on tables using the <code>border-collapse: collapse</code> CSS property.</p>
1717
<figure>
1818
<img src="/resources/0042_04_06.png"/>
19-
<figcaption>figure 1</figcaption>
19+
<figcaption>Figure 1 - Illustration of the measured width</figcaption>
2020
</figure>
2121
</longdesc>
2222
<note id="dimensions-number" type="additional" data-title=".outerWidth()"/>

entries/scroll.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<p>The style definition is present to make the target element small enough to be scrollable:</p>
4646
<figure>
4747
<img src="/resources/0042_05_11.png" alt=""/>
48-
<figcaption>figure 1</figcaption>
48+
<figcaption>Figure 1 - Illustration of the rendered HTML</figcaption>
4949
</figure>
5050
<p>The <code>scroll</code> event handler can be bound to this element:</p>
5151
<pre><code>

entries/show.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ $( "#clickme" ).click(function() {
6161
<img class="column three" src="/resources/0042_06_02.png" alt=""/>
6262
<img class="column three" src="/resources/0042_06_03.png" alt=""/>
6363
<img class="column three" src="/resources/0042_06_04.png" alt=""/>
64-
<figcaption>figure 1</figcaption>
64+
<figcaption>Figure 1 - Illustration of the <code>show()</code> effect</figcaption>
6565
</figure>
6666
</longdesc>
6767
<note id="jquery.fx.off" type="additional" data-title=".show()"/>

entries/slideDown.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ $( "#clickme" ).click(function() {
4141
<img class="column three" src="/resources/0042_06_18.png" alt=""/>
4242
<img class="column three" src="/resources/0042_06_19.png" alt=""/>
4343
<img class="column three" src="/resources/0042_06_20.png" alt=""/>
44-
<figcaption>figure 1</figcaption>
44+
<figcaption>Figure 1 - Illustration of the <code>slideDown()</code> effect</figcaption>
4545
</figure>
4646
<h4 id="easing">Easing</h4>
4747
<p><strong>As of jQuery 1.4.3</strong>, an optional string naming an easing function may be used. Easing functions specify the speed at which the animation progresses at different points within the animation. The only easing implementations in the jQuery library are the default, called <code>swing</code>, and one that progresses at a constant pace, called <code>linear</code>. More easing functions are available with the use of plug-ins, most notably the <a href="http://jqueryui.com">jQuery UI suite</a>.</p>

entries/slideToggle.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ $( "#clickme" ).click(function() {
4242
<img class="column three" src="/resources/0042_06_26.png" alt=""/>
4343
<img class="column three" src="/resources/0042_06_27.png" alt=""/>
4444
<img class="column three" src="/resources/0042_06_28.png" alt=""/>
45-
<figcaption>figure 1</figcaption>
45+
<figcaption>Figure 1 - Illustration of the <code>slideToggle()</code> effect when hiding the image</figcaption>
4646
</figure>
4747
<p>A second click will show the element once again:</p>
4848
<figure>
4949
<img class="column three" src="/resources/0042_06_29.png" alt=""/>
5050
<img class="column three" src="/resources/0042_06_30.png" alt=""/>
5151
<img class="column three" src="/resources/0042_06_31.png" alt=""/>
5252
<img class="column three" src="/resources/0042_06_32.png" alt=""/>
53-
<figcaption>figure 2</figcaption>
53+
<figcaption>Figure 2 - Illustration of the <code>slideToggle()</code> effect when showing the image</figcaption>
5454
</figure>
5555
<h4 id="easing">Easing</h4>
5656
<p><strong>As of jQuery 1.4.3</strong>, an optional string naming an easing function may be used. Easing functions specify the speed at which the animation progresses at different points within the animation. The only easing implementations in the jQuery library are the default, called <code>swing</code>, and one that progresses at a constant pace, called <code>linear</code>. More easing functions are available with the use of plug-ins, most notably the <a href="http://jqueryui.com">jQuery UI suite</a>.</p>

entries/slideUp.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ $( "#clickme" ).click(function() {
4141
<img class="column three" src="/resources/0042_06_22.png" alt=""/>
4242
<img class="column three" src="/resources/0042_06_23.png" alt=""/>
4343
<img class="column three" src="/resources/0042_06_24.png" alt=""/>
44-
<figcaption>figure 1</figcaption>
44+
<figcaption>Figure 1 - Illustration of the <code>slideUp()</code> effect</figcaption>
4545
</figure>
4646
<h4 id="easing">Easing</h4>
4747
<p><strong>As of jQuery 1.4.3</strong>, an optional string naming an easing function may be used. Easing functions specify the speed at which the animation progresses at different points within the animation. The only easing implementations in the jQuery library are the default, called <code>swing</code>, and one that progresses at a constant pace, called <code>linear</code>. More easing functions are available with the use of plug-ins, most notably the <a href="http://jqueryui.com">jQuery UI suite</a>.</p>

entries/toggle.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ $( "#clickme" ).click(function() {
6464
<img class="column three" src="/resources/0042_06_10.png" alt=""/>
6565
<img class="column three" src="/resources/0042_06_11.png" alt=""/>
6666
<img class="column three" src="/resources/0042_06_12.png" alt=""/>
67-
<figcaption>figure 1</figcaption>
67+
<figcaption>Figure 1 - Illustration of the <code>toggle()</code> effect when hiding the image</figcaption>
6868
</figure>
6969
<p>A second click will show the element once again:</p>
7070
<figure>
7171
<img class="column three" src="/resources/0042_06_13.png" alt=""/>
7272
<img class="column three" src="/resources/0042_06_14.png" alt=""/>
7373
<img class="column three" src="/resources/0042_06_15.png" alt=""/>
7474
<img class="column three" src="/resources/0042_06_16.png" alt=""/>
75-
<figcaption>figure 2</figcaption>
75+
<figcaption>Figure 2 - Illustration of the <code>toggle()</code> effect when showing the image</figcaption>
7676
</figure>
7777
<p>The second version of the method accepts a Boolean parameter. If this parameter is <code>true</code>, then the matched elements are shown; if <code>false</code>, the elements are hidden. In essence, the statement:
7878
</p>

entries/width.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<p>The difference between <code>.css(width)</code> and <code>.width()</code> is that the latter returns a unit-less pixel value (for example, <code>400</code>) while the former returns a value with units intact (for example, <code>400px</code>). The <code>.width()</code> method is recommended when an element's width needs to be used in a mathematical calculation.</p>
1212
<figure>
1313
<img src="/resources/0042_04_04.png"/>
14-
<figcaption>figure 1</figcaption>
14+
<figcaption>Figure 1 - Illustration of the measured width</figcaption>
1515
</figure>
1616
<p>This method is also able to find the width of the window and document.</p>
1717
<pre><code>

0 commit comments

Comments
 (0)