Difference between revisions of "User:Minooz/OSD600/popcorn/doc"
< User:Minooz | OSD600 | popcorn
(→Documentation for tagthisperson plugin) |
|||
| (16 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===Documentation for <TT> tagthisperson </TT> plugin=== | ===Documentation for <TT> tagthisperson </TT> plugin=== | ||
| − | + | Name | |
| − | + | <pre>tagthisperson</pre> | |
| − | : | + | Example |
| − | :: Adds people's names to an element on the page | + | <pre> |
| − | :: | + | var p = Popcorn('#video') |
| − | :: | + | .tagthisperson( { |
| − | + | start: 0, // seconds | |
| − | + | end: 10, // seconds | |
| − | + | person: 'Anna Sob', | |
| − | + | image: 'http://newshour.s3.amazonaws.com/RichardNSmith_thumbnail.jpg', | |
| − | + | href: 'http://annasob.wordpress.com', | |
| + | target: 'tagdiv' | ||
| + | } ) | ||
| + | .tagthisperson( { | ||
| + | start: 5, // seconds | ||
| + | end: 15, // seconds | ||
| + | person: 'Scott', | ||
| + | target: 'tagdiv' | ||
| + | } ) | ||
| + | }, false ); | ||
| + | </pre> | ||
| + | Description | ||
| + | <pre>Adds people's names that are tagged in a subtitle to an element on the page | ||
| + | If the person has an image or a url to his/her webpage, it will be attached to the person</pre> | ||
| + | |||
| + | Syntax | ||
| + | <pre> | ||
| + | Popcorn.plugin( "tagthisperson" , ( function() { | ||
| + | return { | ||
| + | manifest: | ||
| + | options:{ | ||
| + | start : {elem:'input', type:'text', label:'In'}, | ||
| + | end : {elem:'input', type:'text', label:'Out'}, | ||
| + | target : 'tag-container', | ||
| + | person : {elem:'input', type:'text', label:'Name'}, | ||
| + | image : {elem:'input', type:'text', label:'Image Src'}, | ||
| + | href : {elem:'input', type:'text', label:'href Src'} | ||
| + | } | ||
| + | _setup: | ||
| + | _start: | ||
| + | _end: | ||
| + | }; | ||
| + | })()); | ||
| + | </pre> | ||
| + | |||
| + | Parameters | ||
| + | <pre> | ||
| + | start - The time that you want this plug-in to execute | ||
| + | end - The time that you want this plug-in to stop executing | ||
| + | person - The name of the person who you want to tag | ||
| + | image - The url to the image of the person - optional | ||
| + | href - The url to the webpage of the person - optional | ||
| + | target - The id of the document element that the text needs to be - attached to, this target element must exist on the DOM | ||
| + | </pre> | ||
Latest revision as of 22:12, 26 February 2011
Documentation for tagthisperson plugin
Name
tagthisperson
Example
var p = Popcorn('#video')
.tagthisperson( {
start: 0, // seconds
end: 10, // seconds
person: 'Anna Sob',
image: 'http://newshour.s3.amazonaws.com/RichardNSmith_thumbnail.jpg',
href: 'http://annasob.wordpress.com',
target: 'tagdiv'
} )
.tagthisperson( {
start: 5, // seconds
end: 15, // seconds
person: 'Scott',
target: 'tagdiv'
} )
}, false );
Description
Adds people's names that are tagged in a subtitle to an element on the page If the person has an image or a url to his/her webpage, it will be attached to the person
Syntax
Popcorn.plugin( "tagthisperson" , ( function() {
return {
manifest:
options:{
start : {elem:'input', type:'text', label:'In'},
end : {elem:'input', type:'text', label:'Out'},
target : 'tag-container',
person : {elem:'input', type:'text', label:'Name'},
image : {elem:'input', type:'text', label:'Image Src'},
href : {elem:'input', type:'text', label:'href Src'}
}
_setup:
_start:
_end:
};
})());
Parameters
start - The time that you want this plug-in to execute end - The time that you want this plug-in to stop executing person - The name of the person who you want to tag image - The url to the image of the person - optional href - The url to the webpage of the person - optional target - The id of the document element that the text needs to be - attached to, this target element must exist on the DOM
