Skip to content
This repository has been archived by the owner on Jan 24, 2019. It is now read-only.

Commit

Permalink
Made all of the docs use pygments now
Browse files Browse the repository at this point in the history
  • Loading branch information
dseif committed Dec 15, 2011
1 parent 534a4b4 commit a977ed3
Show file tree
Hide file tree
Showing 29 changed files with 88 additions and 21 deletions.
2 changes: 2 additions & 0 deletions effects/_posts/2012-12-12-applyclass.md
Expand Up @@ -13,6 +13,7 @@ Apply a class by CSS Selector. Selector is relative to plugin target's `id`

## Examples ##

{% highlight js linenos %}
var popcorn = Popcorn( "#video" );

popcorn.footnote({
Expand All @@ -33,5 +34,6 @@ Apply a class by CSS Selector. Selector is relative to plugin target's `id`
});

popcorn.play();
{% endhighlight %}

Simple applyclass effect [jsFiddle](http://jsfiddle.net/68tzd/)
3 changes: 2 additions & 1 deletion media-methods/_posts/2012-12-12-playbackrate.md
Expand Up @@ -13,11 +13,12 @@ Get or set playbackrate of calling Popcorn instance

## Example ##

{% highlight js linenos %}
var p = Popcorn( "#video" );

// returns the current playback rate
p.playbackrate();

// set the playback rate
p.playbackrate( 30 );

{% endhighlight %}
38 changes: 20 additions & 18 deletions modules/_posts/2012-12-12-data-timeline-sources.md
Expand Up @@ -11,29 +11,31 @@ This is primarily used in association with Popcorn's parsers and allows the user

## Examples ##

<html>
<head>
<script src="popcorn-complete.js"></script>
</head>
<body>
<video id="video" data-timeline-sources="data/data.json"
{% highlight html linenos %}
<html>
<head>
<script src="popcorn-complete.js"></script>
</head>
<body>
<video id="video" data-timeline-sources="data/data.json"
controls
width= '250px'
poster="../../test/poster.png"&gt;
poster="../../test/poster.png">

&lt;source id='mp4'
<source id='mp4'
src="../../test/trailer.mp4"
type='video/mp4; codecs="avc1, mp4a"'&gt;
type='video/mp4; codecs="avc1, mp4a"'>

&lt;source id='ogv'
<source id='ogv'
src="../../test/trailer.ogv"
type='video/ogg; codecs="theora, vorbis"'&gt;
type='video/ogg; codecs="theora, vorbis"'>

&lt;p&gt;Your user agent does not support the HTML5 Video element.&lt;/p&gt;
<p>Your user agent does not support the HTML5 Video element.</p>

&lt;/video&gt;
&lt;div id="footnote-container"&gt;&lt;/div&gt;
&lt;div id="map-container"&gt;&lt;/div&gt;
&lt;div id="iframe-container"&gt;&lt;/div&gt;
&lt;/body&gt;
&lt;/html&gt;
</video>
<div id="footnote-container"></div>
<div id="map-container"></div>
<div id="iframe-container"></div>
</body>
</html>
{% endhighlight %}
2 changes: 2 additions & 0 deletions modules/_posts/2012-12-12-sequence.md
Expand Up @@ -29,6 +29,7 @@ the sequencer also provides the following methods:

## Examples ##

{% highlight js linenos %}
var sequence = Popcorn.sequence(
"container-id",
\[
Expand All @@ -48,5 +49,6 @@ the sequencer also provides the following methods:
out: 6
}
\]);
{% endhighlight %}

[jsFiddle Example](http://jsfiddle.net/jmTgD/1/)
3 changes: 2 additions & 1 deletion players/_posts/2012-12-12-baseplayer.md
Expand Up @@ -21,6 +21,7 @@ The baseplayer has numerous use cases, such as :

## Examples ##

{% highlight js linenos %}
Popcorn.player( "baseplayer" );

var pop = Popcorn( "elementID" );
Expand All @@ -34,6 +35,6 @@ The baseplayer has numerous use cases, such as :
text: "Works with the baseplayer!",
target: "footnote-div"
});
{% endhighlight %}

// will work with 1.0
[jsFiddle](http://jsfiddle.net/popcornjs/qQ672/)
3 changes: 2 additions & 1 deletion players/_posts/2012-12-12-vimeo.md
Expand Up @@ -18,6 +18,7 @@ The vimeo player plugin allows for the use of all functions and properties that

## Examples ##

{% highlight js linenos %}
var pop = Popcorn.vimeo( "#video", "vimeoURL" );

pop.footnote({
Expand All @@ -28,6 +29,6 @@ The vimeo player plugin allows for the use of all functions and properties that
});

pop.play();
{% endhighlight %}

// wont work until after 1.0 lands
[jsFiddle example](http://jsfiddle.net/popcornjs/gBEek/)
2 changes: 2 additions & 0 deletions players/_posts/2012-12-12-youtube.md
Expand Up @@ -19,6 +19,7 @@ The youtube player plugin allows for the use of all functions and properties tha

## Examples ##

{% highlight js linenos %}
var pop = Popcorn.youtube( '#video', 'http://www.youtube.com/watch?v=9oar9glUCL0' );

pop.footnote({
Expand All @@ -29,5 +30,6 @@ The youtube player plugin allows for the use of all functions and properties tha
});

pop.play();
{% endhighlight %}

[jsFiddle example](http://jsfiddle.net/popcornjs/whvkP/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-attribution.md
Expand Up @@ -21,6 +21,7 @@ Allows the user to add proper attribution to the various sources used on the cur

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.attribution({
Expand All @@ -32,5 +33,6 @@ Allows the user to add proper attribution to the various sources used on the cur
licenseurl: "http://creativecommons.org/licenses/by-nc/2.0/",
target: "attribdiv"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/AykAT/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-code.md
Expand Up @@ -17,6 +17,7 @@ Allows for the ability to run arbitrary code ( JavaScript functions ) according

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.code({
Expand All @@ -29,5 +30,6 @@ Allows for the ability to run arbitrary code ( JavaScript functions ) according
document.getElementById( "test1" ).innerHTML = "No";
}
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/Wmskz/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-facebook.md
Expand Up @@ -36,6 +36,7 @@ The facebook plugin allows the user to bring popular aspects from facebook and d

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.facebook({
Expand All @@ -46,5 +47,6 @@ The facebook plugin allows the user to bring popular aspects from facebook and d
// id is from example http://developers.facebook.com/docs/reference/plugins/live-stream/
event_app_id: 174243249296725
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/UC6Px/);
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-flickr.md
Expand Up @@ -24,6 +24,7 @@ The Flickr plugin allows the user to hook into the popular picture hosting site

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.flickr({
Expand All @@ -32,5 +33,6 @@ The Flickr plugin allows the user to hook into the popular picture hosting site
userid: "35034346917@N01",
target: "flickrdiv"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/grMCk/);
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-footnote.md
Expand Up @@ -16,9 +16,11 @@ Adds text to an element on the page.

## Example ##

{% highlight js linenos %}
var p = Popcorn( "#video" ).footnote({
start: 5,
end: 15,
text: 'This text will appear in "target". ',
target: "footnotediv"
});
{% endhighlight %}
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-gml.md
Expand Up @@ -16,6 +16,7 @@ Renders a GML tag inside an HTML element

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.gml({
Expand All @@ -24,5 +25,6 @@ Renders a GML tag inside an HTML element
gmltag: "29582",
target: "gmldiv"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/kzwt8/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-googlefeed.md
Expand Up @@ -18,6 +18,7 @@ Adds a feed from a specified blog url into the target div

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.googlefeed({
Expand All @@ -28,5 +29,6 @@ Adds a feed from a specified blog url into the target div
title: "Planet Feed",
orientation: "Vertical"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/rZmL8/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-googlemaps.md
Expand Up @@ -36,6 +36,7 @@ Tweening animates a streetview from one location to another.

## Example ##

{% highlight js linenos %}
var p = Popcorn( "#video" ).googlemap({
start: 5,
end: 15,
Expand All @@ -44,3 +45,4 @@ Tweening animates a streetview from one location to another.
lat: 43.665429,
lng: -79.403323
});
{% endhighlight %}
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-mustache.md
Expand Up @@ -18,6 +18,7 @@ Adds the ability to render JSON using templates via the Mustache templating libr

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.mustache({
Expand Down Expand Up @@ -48,5 +49,6 @@ Adds the ability to render JSON using templates via the Mustache templating libr
'}',
static: true /* The json is not going to change, load it early. */
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/DmupJ/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-openmap.md
Expand Up @@ -27,6 +27,7 @@ Adds an OpenLayers map and open map tiles (OpenStreetMap \[default\], NASA World

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.openmap( {
Expand All @@ -38,5 +39,6 @@ Adds an OpenLayers map and open map tiles (OpenStreetMap \[default\], NASA World
lng: -79.403323,
zoom: "10"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/NKtvy/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-pause.md
Expand Up @@ -15,8 +15,10 @@ Links may cause a new page to display on a new window, or may cause a new page t

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" , {
pauseOnLinkClicked: true
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/CVeN6/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-processing.md
Expand Up @@ -17,6 +17,7 @@ This plugin adds a Processing.js sketch to be added to a target div or canvas.

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.processing({
Expand All @@ -26,3 +27,4 @@ This plugin adds a Processing.js sketch to be added to a target div or canvas.
sketch: "test.pjs",
noPause: true
});
{% endhighlight %}
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-subtitle.md
Expand Up @@ -16,12 +16,14 @@ Displays a subtitle over the video, or in the target div

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.subtitle({
start: 5,
end: 15,
text: "this is the first subtitle of 2011",
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/p8Kbs/1/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-tagthisperson.md
Expand Up @@ -18,6 +18,7 @@ Adds people's names to an element on the page.

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.tagthisperson({
Expand All @@ -28,5 +29,6 @@ Adds people's names to an element on the page.
href: "http://annasob.wordpress.com",
target: "tagdiv"
});
{% endhightlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/ya23v/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-timeline.md
Expand Up @@ -19,6 +19,7 @@ Adds data associated with a certain time in the video, which creates a scrolling

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.timeline({
Expand All @@ -29,5 +30,6 @@ Adds data associated with a certain time in the video, which creates a scrolling
innerHTML: "Click here for <a href='http://www.google.ca'>Google</a>" ,
direction: "up"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/yspL2/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-twitter.md
Expand Up @@ -18,6 +18,7 @@ Appends a Twitter widget to an element on the page.

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.twitter({
Expand All @@ -27,5 +28,6 @@ Appends a Twitter widget to an element on the page.
src: "@stevesong",
target: "twitterdiv",
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/GhD62/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-webpage.md
Expand Up @@ -17,6 +17,7 @@ Creates an iframe showing a website specified by the user

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.webpage({
Expand All @@ -26,5 +27,6 @@ Creates an iframe showing a website specified by the user
src: "http://webmademovies.org/",
target: "webpagediv"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/pMmAM/)
2 changes: 2 additions & 0 deletions plugins/_posts/2012-12-12-wikipedia.md
Expand Up @@ -19,6 +19,7 @@ Displays a wikipedia aricle in the target specified by the user by using new DOM

## Example ##

{% highlight js linenos %}
var pop = Popcorn( "#video" );

pop.wikipedia({
Expand All @@ -28,5 +29,6 @@ Displays a wikipedia aricle in the target specified by the user by using new DOM
title: "this is an article",
target: "wikidiv"
});
{% endhighlight %}

* [jsFiddle Example](http://jsfiddle.net/popcornjs/5q7QS/)

0 comments on commit a977ed3

Please sign in to comment.