Difference between revisions of "User:Minooz/OSD600/popcorn/doc"

From CDOT Wiki
Jump to: navigation, search
(Documentation for tagthisperson plugin)
(Documentation for tagthisperson plugin)
Line 4: Line 4:
 
:: <TT>tagthisperson</TT>
 
:: <TT>tagthisperson</TT>
  
: Description   Adds people's names to an element on the page
+
: Description
 +
:: Adds people's names to an element on the page
 
:: Options parameter will need a start, end, target, image and person.
 
:: Options parameter will need a start, end, target, image and person.
 
:: Start is the time that you want this plug-in to execute
 
:: Start is the time that you want this plug-in to execute
Line 12: Line 13:
 
:: Target is the id of the document element that the text needs to be
 
:: Target is the id of the document element that the text needs to be
 
:: attached to, this target element must exist on the DOM
 
:: attached to, this target element must exist on the DOM
 +
 +
: Parameters
 +
:: {Object} options

Revision as of 18:09, 23 February 2011

Documentation for tagthisperson plugin

Name
tagthisperson
Description
Adds people's names to an element on the page
Options parameter will need a start, end, target, image and person.
Start is the time that you want this plug-in to execute
End is the time that you want this plug-in to stop executing
Person is the name of the person who you want to tag
Image is the url to the image of the person - optional
Target is the id of the document element that the text needs to be
attached to, this target element must exist on the DOM
Parameters
{Object} options