Mercurial > ff-herdict-preso
changeset 8:c9bb7e3e1821
Tweaked docs.
| author | Atul Varma <varmaa@toolness.com> |
|---|---|
| date | Wed, 10 Feb 2010 12:13:18 -0800 |
| parents | 7b67d3e40479 |
| children | 01c24a5912f8 |
| files | js/ff-herdict-preso.js |
| diffstat | 1 files changed, 6 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/js/ff-herdict-preso.js Wed Feb 10 12:07:27 2010 -0800 +++ b/js/ff-herdict-preso.js Wed Feb 10 12:13:18 2010 -0800 @@ -39,15 +39,18 @@ // to provide e.g. the visuals for a narrated slide-show, or // subtitles for a movie. // -// The options object should contain the following keys: +// The options object should contain the following keys, all +// required unless otherwise specified: // // audio - CSS selector that points to a single HTML5 // <audio> element. The visuals will be synchronized -// with this. Required. +// with this. // // visuals - CSS selector that points to a collection // of DOM elements, each of which is a visual -// to be displayed at some point in the audio. Required. +// to be displayed at some point in the audio. +// When the page is first loaded, these elements +// shouldn't be visible. // // visibleClass - Class to add to a visual element when it is // being displayed. Defaults to "visible".