Skip to content

mikesimons/jqPresent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

jqPresent - A jQuery presentation plugin
========================================

jqPresent is a jQuery plugin for giving presentations via your web browser.

Requirements
------------
All of the requirements are bundled in this repo but if you wish to just use the plugin script (scripts/jqPresent.js) then you will need jQuery, jQuery UI with the scale effect and jQuery.hotkeys.

Intended usage
--------------
Fork this repo, edit index.html to suit your content, commit, present.

Current features
----------------
* Per slide transition (see index.html)
* Incremental points with per point transitions (see index.html)
* Slides can contain anything a normal webpage can including HTML5 video, canvas tags etc (however, to keep it slick I recommend putting these in a lightbox)
* Keyboard navigation
* Automatically generated pager
* Next / prev links
* 'Visited' slides concept

'Visited' slides are slides that have been entered and have had all points on them exposed. When viewing a 'visited' slide, the points are all visible and are ignored for the forward / backward actions. If you need to make a lside un-'visited' then you must reset it with CTRL+X.

Keys
----

* __UP__     - Previous slide
* __DOWN__   - Next slide 
* __LEFT__   - Go backward (will hide previous point or flip to previous slide of no points left)
* __RIGHT__  - Go forward (will show next point or flip to next slide if no points left)
* __CTRL+X__ - Reset slide
* __CTRL+SHIFT+X__ - Reset presentation
* __CTRL+SHIFT+P__ - Toggle presentation mode

Options
-------
  slideSelector: '.slide',
  pointSelector: '.point',
  pagerSelector: '#pager',
  nextSelector: '#next',
  prevSelector: '#prev',
  presModeHideSelector: '#header, #footer',
  wrap: false,
  keys: 
   prevSlide: 'up',
   nextSlide: 'down',
   forward: 'right',
   backward: 'left',
   resetSlide: 'ctrl+x',
   resetPresentation: 'ctrl+shift+x',
   presentationModeToggle: 'ctrl+shift+p'

Roadmap
-------
0.2

* (DONE) Per slide events (will allow you to bind JS to slide entry / exit and point show / hide)
* (DONE) Simple autoscale 
* (DONE) Presentation mode (Hides relnav and pager)
* Code highlighting http://code.google.com/p/syntaxhighlighter/wiki/Overview
* Highlighting of current slide and pager by class
* Fix the back / forward buttons by usig jQuery.history

0.3

* Print mode (to allow you to print to PDF and upload to slideshare et.al)
* Overlay / non-visible point support (To point out specific aspects of a slide)
* Autoscale working on resize events

About

jQuery plugin for giving presentations

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published