From: Mark Otto <otto@github.com>
Date: Sun, 13 Jul 2014 07:54:14 +0000 (-0700)
Subject: markdownify js carousel
X-Git-Tag: v4.0.0-alpha~676
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=61ef72887350c4ce5395486ef78d8df91656b9f4;p=thirdparty%2Fbootstrap.git

markdownify js carousel
---

diff --git a/docs/javascript/carousel.md b/docs/javascript/carousel.md
index ebe880ceca..ccc6c4759b 100644
--- a/docs/javascript/carousel.md
+++ b/docs/javascript/carousel.md
@@ -3,66 +3,28 @@ layout: page
 title: Carousel
 ---
 
-<div class="bs-docs-section">
-  <h1 id="carousel" class="page-header">Carousel <small>carousel.js</small></h1>
-
-  <h2 id="carousel-examples">Examples</h2>
-  <p>The slideshow below shows a generic plugin and component for cycling through elements like a carousel.</p>
-  <div class="bs-example">
-    <div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
-      <ol class="carousel-indicators">
-        <li data-target="#carousel-example-generic" data-slide-to="0" class="active"></li>
-        <li data-target="#carousel-example-generic" data-slide-to="1"></li>
-        <li data-target="#carousel-example-generic" data-slide-to="2"></li>
-      </ol>
-      <div class="carousel-inner" role="listbox">
-        <div class="item active">
-          <img data-src="holder.js/900x500/auto/#777:#555/text:First slide" alt="First slide">
-        </div>
-        <div class="item">
-          <img data-src="holder.js/900x500/auto/#666:#444/text:Second slide" alt="Second slide">
-        </div>
-        <div class="item">
-          <img data-src="holder.js/900x500/auto/#555:#333/text:Third slide" alt="Third slide">
-        </div>
-      </div>
-      <a class="left carousel-control" href="#carousel-example-generic" role="button" data-slide="prev">
-        <span class="glyphicon glyphicon-chevron-left"></span>
-        <span class="sr-only">Previous</span>
-      </a>
-      <a class="right carousel-control" href="#carousel-example-generic" role="button" data-slide="next">
-        <span class="glyphicon glyphicon-chevron-right"></span>
-        <span class="sr-only">Next</span>
-      </a>
-    </div>
-  </div><!-- /example -->
-{% highlight html %}
+## Example
+
+The slideshow below shows a generic plugin and component for cycling through elements like a carousel.
+
+{% example html %}
 <div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
-  <!-- Indicators -->
   <ol class="carousel-indicators">
     <li data-target="#carousel-example-generic" data-slide-to="0" class="active"></li>
     <li data-target="#carousel-example-generic" data-slide-to="1"></li>
     <li data-target="#carousel-example-generic" data-slide-to="2"></li>
   </ol>
-
-  <!-- Wrapper for slides -->
   <div class="carousel-inner" role="listbox">
     <div class="item active">
-      <img src="..." alt="...">
-      <div class="carousel-caption">
-        ...
-      </div>
+      <img data-src="holder.js/900x500/auto/#777:#555/text:First slide" alt="First slide">
     </div>
     <div class="item">
-      <img src="..." alt="...">
-      <div class="carousel-caption">
-        ...
-      </div>
+      <img data-src="holder.js/900x500/auto/#666:#444/text:Second slide" alt="Second slide">
+    </div>
+    <div class="item">
+      <img data-src="holder.js/900x500/auto/#555:#333/text:Third slide" alt="Third slide">
     </div>
-    ...
   </div>
-
-  <!-- Controls -->
   <a class="left carousel-control" href="#carousel-example-generic" role="button" data-slide="prev">
     <span class="glyphicon glyphicon-chevron-left"></span>
     <span class="sr-only">Previous</span>
@@ -72,55 +34,58 @@ title: Carousel
     <span class="sr-only">Next</span>
   </a>
 </div>
-{% endhighlight %}
+{% endexample %}
 
-  <div class="bs-callout bs-callout-warning" id="callout-carousel-transitions">
-    <h4>Transition animations not supported in Internet Explorer 8 &amp; 9</h4>
-    <p>Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 8 &amp; 9 don't support the necessary CSS properties. Thus, there are no slide transition animations when using these browsers. We have intentionally decided not to include jQuery-based fallbacks for the transitions.</p>
-  </div>
+<div class="bs-callout bs-callout-warning" id="callout-carousel-transitions">
+  <h4>Transition animations not supported in Internet Explorer 8 &amp; 9</h4>
+  <p>Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 8 &amp; 9 don't support the necessary CSS properties. Thus, there are no slide transition animations when using these browsers. We have intentionally decided not to include jQuery-based fallbacks for the transitions.</p>
+</div>
 
-  <h3>Optional captions</h3>
-  <p>Add captions to your slides easily with the <code>.carousel-caption</code> element within any <code>.item</code>. Place just about any optional HTML within there and it will be automatically aligned and formatted.</p>
-  <div class="bs-example">
-    <div id="carousel-example-captions" class="carousel slide" data-ride="carousel">
-      <ol class="carousel-indicators">
-        <li data-target="#carousel-example-captions" data-slide-to="0" class="active"></li>
-        <li data-target="#carousel-example-captions" data-slide-to="1"></li>
-        <li data-target="#carousel-example-captions" data-slide-to="2"></li>
-      </ol>
-      <div class="carousel-inner" role="listbox">
-        <div class="item active">
-          <img data-src="holder.js/900x500/auto/#777:#777" alt="First slide image">
-          <div class="carousel-caption">
-            <h3>First slide label</h3>
-            <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
-          </div>
+### Optional captions
+
+Add captions to your slides easily with the `.carousel-caption` element within any `.item`. Place just about any optional HTML within there and it will be automatically aligned and formatted.
+
+<div class="bs-example">
+  <div id="carousel-example-captions" class="carousel slide" data-ride="carousel">
+    <ol class="carousel-indicators">
+      <li data-target="#carousel-example-captions" data-slide-to="0" class="active"></li>
+      <li data-target="#carousel-example-captions" data-slide-to="1"></li>
+      <li data-target="#carousel-example-captions" data-slide-to="2"></li>
+    </ol>
+    <div class="carousel-inner" role="listbox">
+      <div class="item active">
+        <img data-src="holder.js/900x500/auto/#777:#777" alt="First slide image">
+        <div class="carousel-caption">
+          <h3>First slide label</h3>
+          <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
         </div>
-        <div class="item">
-          <img data-src="holder.js/900x500/auto/#666:#666" alt="Second slide image">
-          <div class="carousel-caption">
-            <h3>Second slide label</h3>
-            <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
-          </div>
+      </div>
+      <div class="item">
+        <img data-src="holder.js/900x500/auto/#666:#666" alt="Second slide image">
+        <div class="carousel-caption">
+          <h3>Second slide label</h3>
+          <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
         </div>
-        <div class="item">
-          <img data-src="holder.js/900x500/auto/#555:#5555" alt="Third slide image">
-          <div class="carousel-caption">
-            <h3>Third slide label</h3>
-            <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur.</p>
-          </div>
+      </div>
+      <div class="item">
+        <img data-src="holder.js/900x500/auto/#555:#5555" alt="Third slide image">
+        <div class="carousel-caption">
+          <h3>Third slide label</h3>
+          <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur.</p>
         </div>
       </div>
-      <a class="left carousel-control" href="#carousel-example-captions" role="button" data-slide="prev">
-        <span class="glyphicon glyphicon-chevron-left"></span>
-        <span class="sr-only">Previous</span>
-      </a>
-      <a class="right carousel-control" href="#carousel-example-captions" role="button" data-slide="next">
-        <span class="glyphicon glyphicon-chevron-right"></span>
-        <span class="sr-only">Next</span>
-      </a>
     </div>
-  </div><!-- /example -->
+    <a class="left carousel-control" href="#carousel-example-captions" role="button" data-slide="prev">
+      <span class="glyphicon glyphicon-chevron-left"></span>
+      <span class="sr-only">Previous</span>
+    </a>
+    <a class="right carousel-control" href="#carousel-example-captions" role="button" data-slide="next">
+      <span class="glyphicon glyphicon-chevron-right"></span>
+      <span class="sr-only">Next</span>
+    </a>
+  </div>
+</div>
+
 {% highlight html %}
 <div class="item">
   <img src="..." alt="...">
@@ -131,117 +96,131 @@ title: Carousel
 </div>
 {% endhighlight %}
 
-  <div class="bs-callout bs-callout-danger">
-    <h4>Accessibility issue</h4>
-    <p>The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.</p>
-  </div>
+<div class="bs-callout bs-callout-danger">
+  <h4>Accessibility issue</h4>
+  <p>The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.</p>
+</div>
+
+## Usage
+
+### Multiple carousels</h3>
 
-  <h2 id="carousel-usage">Usage</h2>
+Carousels require the use of an `id` on the outermost container (the `.carousel`) for carousel controls to function properly. When adding multiple carousels, or when changing a carousel's `id`, be sure to update the relevant controls.
 
-  <h3>Multiple carousels</h3>
-  <p>Carousels require the use of an <code>id</code> on the outermost container (the <code>.carousel</code>) for carousel controls to function properly. When adding multiple carousels, or when changing a carousel's <code>id</code>, be sure to update the relevant controls.</p>
+### Via data attributes
 
-  <h3>Via data attributes</h3>
-  <p>Use data attributes to easily control the position of the carousel. <code>data-slide</code> accepts the keywords <code>prev</code> or <code>next</code>, which alters the slide position relative to its current position. Alternatively, use <code>data-slide-to</code> to pass a raw slide index to the carousel <code>data-slide-to="2"</code>, which shifts the slide position to a particular index beginning with <code>0</code>.</p>
-  <p>The <code>data-ride="carousel"</code> attribute is used to mark a carousel as animating starting at page load. <strong class="text-danger">It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.</strong></p>
+Use data attributes to easily control the position of the carousel. `data-slide` accepts the keywords `prev` or `next`, which alters the slide position relative to its current position. Alternatively, use `data-slide-to` to pass a raw slide index to the carousel `data-slide-to="2"`, which shifts the slide position to a particular index beginning with `0`.
+
+The `data-ride="carousel"` attribute is used to mark a carousel as animating starting at page load. **It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.**
+
+### Via JavaScript
+
+Call carousel manually with:
 
-  <h3>Via JavaScript</h3>
-  <p>Call carousel manually with:</p>
 {% highlight js %}
 $('.carousel').carousel()
 {% endhighlight %}
 
-  <h3>Options</h3>
-  <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-interval=""</code>.</p>
-  <div class="table-responsive">
-    <table class="table table-bordered table-striped">
-      <thead>
-       <tr>
-         <th style="width: 100px;">Name</th>
-         <th style="width: 50px;">type</th>
-         <th style="width: 50px;">default</th>
-         <th>description</th>
-       </tr>
-      </thead>
-      <tbody>
-       <tr>
-         <td>interval</td>
-         <td>number</td>
-         <td>5000</td>
-         <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td>
-       </tr>
-       <tr>
-         <td>pause</td>
-         <td>string</td>
-         <td>"hover"</td>
-         <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td>
-       </tr>
-       <tr>
-         <td>wrap</td>
-         <td>boolean</td>
-         <td>true</td>
-         <td>Whether the carousel should cycle continuously or have hard stops.</td>
-       </tr>
-      </tbody>
-    </table>
-  </div><!-- /.table-responsive -->
-
-  <h3>Methods</h3>
-
-  <h4>.carousel(options)</h4>
-  <p>Initializes the carousel with an optional options <code>object</code> and starts cycling through items.</p>
+### Options
+
+Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-interval=""`.
+
+<div class="table-responsive">
+  <table class="table table-bordered table-striped">
+    <thead>
+     <tr>
+       <th style="width: 100px;">Name</th>
+       <th style="width: 50px;">type</th>
+       <th style="width: 50px;">default</th>
+       <th>description</th>
+     </tr>
+    </thead>
+    <tbody>
+     <tr>
+       <td>interval</td>
+       <td>number</td>
+       <td>5000</td>
+       <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td>
+     </tr>
+     <tr>
+       <td>pause</td>
+       <td>string</td>
+       <td>"hover"</td>
+       <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td>
+     </tr>
+     <tr>
+       <td>wrap</td>
+       <td>boolean</td>
+       <td>true</td>
+       <td>Whether the carousel should cycle continuously or have hard stops.</td>
+     </tr>
+    </tbody>
+  </table>
+</div>
+
+### Methods
+
+#### .carousel(options)
+
+Initializes the carousel with an optional options `object` and starts cycling through items.
+
 {% highlight js %}
 $('.carousel').carousel({
   interval: 2000
 })
 {% endhighlight %}
 
-  <h4>.carousel('cycle')</h4>
-  <p>Cycles through the carousel items from left to right.</p>
-
-  <h4>.carousel('pause')</h4>
-  <p>Stops the carousel from cycling through items.</p>
-
-
-  <h4>.carousel(number)</h4>
-  <p>Cycles the carousel to a particular frame (0 based, similar to an array).</p>
-
-  <h4>.carousel('prev')</h4>
-  <p>Cycles to the previous item.</p>
-
-  <h4>.carousel('next')</h4>
-  <p>Cycles to the next item.</p>
-
-  <h3>Events</h3>
-  <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p>
-  <p>Both events have the following additional properties:</p>
-  <ul>
-    <li><code>direction</code>: The direction in which the carousel is sliding (either <code>"left"</code> or <code>"right"</code>).</li>
-    <li><code>relatedTarget</code>: The DOM element that is being slid into place as the active item.</li>
-  </ul>
-  <div class="table-responsive">
-    <table class="table table-bordered table-striped">
-      <thead>
-       <tr>
-         <th style="width: 150px;">Event Type</th>
-         <th>Description</th>
-       </tr>
-      </thead>
-      <tbody>
-       <tr>
-         <td>slide.bs.carousel</td>
-         <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td>
-       </tr>
-       <tr>
-         <td>slid.bs.carousel</td>
-         <td>This event is fired when the carousel has completed its slide transition.</td>
-       </tr>
-      </tbody>
-    </table>
-  </div><!-- /.table-responsive -->
+#### .carousel('cycle')
+
+Cycles through the carousel items from left to right.
+
+#### .carousel('pause')
+
+Stops the carousel from cycling through items.
+
+#### .carousel(number)
+
+Cycles the carousel to a particular frame (0 based, similar to an array).
+
+#### .carousel('prev')
+
+Cycles to the previous item.
+
+#### .carousel('next')
+
+Cycles to the next item.
+
+### Events
+
+Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:
+
+- `direction`: The direction in which the carousel is sliding (either `"left"` or `"right"`).
+- `relatedTarget`: The DOM element that is being slid into place as the active item.
+
+
+<div class="table-responsive">
+  <table class="table table-bordered table-striped">
+    <thead>
+     <tr>
+       <th style="width: 150px;">Event Type</th>
+       <th>Description</th>
+     </tr>
+    </thead>
+    <tbody>
+     <tr>
+       <td>slide.bs.carousel</td>
+       <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td>
+     </tr>
+     <tr>
+       <td>slid.bs.carousel</td>
+       <td>This event is fired when the carousel has completed its slide transition.</td>
+     </tr>
+    </tbody>
+  </table>
+</div>
+
 {% highlight js %}
 $('#myCarousel').on('slide.bs.carousel', function () {
   // do something…
 })
 {% endhighlight %}
-</div>