Slide Notes

From: Rebecca Murphey Date: Fri, 8 Jun 2012 03:21:14 +0000 (-0400) Subject: taking a stab at a presenter notes server X-Git-Tag: 1.4.0~36^2~8 X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=60f2eb9fb3c4443fbc43d387e866f383f0f70d67;p=reveal.js.git taking a stab at a presenter notes server --- diff --git a/.gitignore b/.gitignore index dec0ea4..34058c4 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .svn log/*.log tmp/** +node_modules/ diff --git a/README.md b/README.md index 466dbb0..f84ee66 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,27 @@ Reveal.addEventListener( 'fragmenthidden', function( event ) { } ); ``` +## Speaker Notes + +If you're interested in using speaker notes, reveal.js comes with a Node server that allows you to deliver your presentation in one browser while viewing speaker notes in another. + +To include speaker notes in your presentation, simply add an `

` element to any slide. These notes will be hidden in the main presentation view. + +To use the speaker notes server, your `index.html` will need to include script tags for `socket.io/socket.io.js` and `js/slidenotes.js`. If you don't want to use the speaker notes server, you can safely remove these script tags, but they are included by default. + +You'll also need to [install Node.js](http://nodejs.org/); then, install the server dependencies by running `npm install`. + +Once Node.js and the dependencies are installed, run the following command from the root directory: + + node slidenotes + +By default, the slides will be served at [localhost:1947](http://localhost:1947). + +You can change the appearance of the speaker notes by editing the file at `slidenotes/notes.html`. + +### Known Issues + +- The notes page is supposed to show the current slide and the next slide, but when it first starts, it always shows the first slide in both positions. ## Examples diff --git a/css/main.css b/css/main.css index 41c06cf..00f06ff 100644 --- a/css/main.css +++ b/css/main.css @@ -942,6 +942,10 @@ body { background: rgba( 0, 0, 0, 0.6 ); } +/********************************************* + * SPEAKER NOTES + *********************************************/ - - +.reveal aside.notes { + display: none; +} diff --git a/index.html b/index.html index a68dd6a..d4420ac 100644 --- a/index.html +++ b/index.html @@ -48,6 +48,10 @@

- Hakim El Hattab / @hakimel

+ + @@ -268,6 +272,7 @@ linkify( 'a' ); + + + \ No newline at end of file diff --git a/js/slidenotes.js b/js/slidenotes.js new file mode 100644 index 0000000..9a4f152 --- /dev/null +++ b/js/slidenotes.js @@ -0,0 +1,32 @@ +(function() { + // don't emit events from inside the previews themselves + var qs = window.location.href.split('?'); + if (qs.length > 1 && qs[1].match('receiver')) { return; } + + var socket = io.connect('http://localhost:1947'); + + Reveal.addEventListener( 'slidechanged', function( event ) { + var nextindexh; + var nextindexv; + var slideElement = event.currentSlide; + + if (slideElement.nextElementSibling && slideElement.parentNode.nodeName == 'SECTION') { + nextindexh = event.indexh; + nextindexv = event.indexv + 1; + } else { + nextindexh = event.indexh + 1; + nextindexv = 0; + } + + var notes = slideElement.querySelector('aside.notes'); + var slideData = { + notes : notes ? notes.innerHTML : '', + indexh : event.indexh, + indexv : event.indexv, + nextindexh : nextindexh, + nextindexv : nextindexv + }; + + socket.emit('slidechanged', slideData); + } ); +}()); \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..68514f4 --- /dev/null +++ b/package.json @@ -0,0 +1,18 @@ +{ + "author": "Hakim El Hattab", + "name": "Reveal.js", + "description": "HTML5 Slideware with Presenter Notes", + "version": "1.5.0", + "repository": { + "type": "git", + "url": "git://github.com/hakimel/reveal.js.git" + }, + "engines": { + "node": "~0.6.8" + }, + "dependencies": { + "express" : "2.5.9", + "socket.io" : "0.9.6" + }, + "devDependencies": {} +} diff --git a/slidenotes/index.js b/slidenotes/index.js new file mode 100644 index 0000000..fb6baf8 --- /dev/null +++ b/slidenotes/index.js @@ -0,0 +1,41 @@ +var express = require('express'); +var fs = require('fs'); +var io = require('socket.io'); +var _ = require('underscore'); + +var app = express.createServer(); +var staticDir = express.static; + +io = io.listen(app); + +var opts = { + port : 1947, + baseDir : __dirname + '/../' +}; + +io.sockets.on('connection', function(socket) { + socket.on('slidechanged', function(slideData) { + socket.broadcast.emit('slidedata', slideData); + }); +}); + +app.configure(function() { + [ 'css', 'assets', 'js', 'lib' ].forEach(function(dir) { + app.use('/' + dir, staticDir(opts.baseDir + dir)); + }); +}); + +app.get("/", function(req, res) { + fs.createReadStream(opts.baseDir + '/index.html').pipe(res); +}); + +app.get("/_notes", function(req, res) { + fs.createReadStream(opts.baseDir + 'slidenotes/notes.html').pipe(res); +}); + +// Actually listen +app.listen(opts.port || null); + +console.log("Your slides are at http://localhost" + (opts.port ? (':' + opts.port) : '')); +console.log("Your notes are at http://localhost" + (opts.port ? (':' + opts.port) : '') + '/_notes'); +console.log("Advance through your slides and your speaker notes will advance automatically"); \ No newline at end of file diff --git a/slidenotes/notes.html b/slidenotes/notes.html new file mode 100644 index 0000000..955dce1 --- /dev/null +++ b/slidenotes/notes.html @@ -0,0 +1,87 @@ + + + + + + Slide Notes + + + + + + + + + + + + +

+ +

+ + + + + + +