Skip to content

Commit 9bc5b81

Browse files
committed
merged dev branch
2 parents 2bc36f2 + 80c375f commit 9bc5b81

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+4949
-2212
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@
33
log/*.log
44
tmp/**
55
node_modules/
6-
.sass-cache
6+
.sass-cache
7+
css/reveal.min.css
8+
js/reveal.min.js

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
language: node_js
22
node_js:
3-
- 0.8
3+
- 0.10
44
before_script:
55
- npm install -g grunt-cli

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Contributing
2+
3+
Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**.
4+
5+
6+
### Personal Support
7+
If you have personal support or setup questions the best place to ask those are [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js).
8+
9+
10+
### Bug Reports
11+
When reporting a bug make sure to include information about which browser and operating system you are on as well as the necessary steps to reproduce the issue. If possible please include a link to a sample presentation where the bug can be tested.
12+
13+
14+
### Pull Requests
15+
- Should follow the coding style of the file you work in, most importantly:
16+
- Tabs to indent
17+
- Single-quoted strings
18+
- Should be made towards the **dev branch**
19+
- Should be submitted from a feature/topic branch (not your master)
20+
- Should not include the minified **reveal.min.js** or **reveal.min.css** files

Gruntfile.js

+13-3
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,9 @@ module.exports = function(grunt) {
7070
head: false,
7171
module: false,
7272
console: false,
73-
unescape: false
73+
unescape: false,
74+
define: false,
75+
exports: false
7476
}
7577
},
7678
files: [ 'Gruntfile.js', 'js/reveal.js' ]
@@ -96,7 +98,9 @@ module.exports = function(grunt) {
9698
server: {
9799
options: {
98100
port: port,
99-
base: '.'
101+
base: '.',
102+
livereload: true,
103+
open: true
100104
}
101105
}
102106
},
@@ -113,6 +117,9 @@ module.exports = function(grunt) {
113117
},
114118

115119
watch: {
120+
options: {
121+
livereload: true
122+
},
116123
main: {
117124
files: [ 'Gruntfile.js', 'js/reveal.js', 'css/reveal.css' ],
118125
tasks: 'default'
@@ -124,7 +131,10 @@ module.exports = function(grunt) {
124131
css: {
125132
files: [ 'css/reveal.bare.css' ],
126133
tasks: 'css'
127-
}
134+
},
135+
html: {
136+
files: [ 'index.html']
137+
}
128138
}
129139

130140
});

README.md

+44-35
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ reveal.js comes with a broad range of features including [nested slides](https:/
1313

1414
## Online Editor
1515

16-
Presentations are written using HTML or markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slid.es](http://slid.es).
16+
Presentations are written using HTML or markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slides.com](http://slides.com).
1717

1818

1919
## Instructions
@@ -59,8 +59,8 @@ When used locally, this feature requires that reveal.js [runs from a local web s
5959
```html
6060
<section data-markdown="example.md"
6161
data-separator="^\n\n\n"
62-
data-vertical="^\n\n"
63-
data-notes="^Note:"
62+
data-separator-vertical="^\n\n"
63+
data-separator-notes="^Note:"
6464
data-charset="iso-8859-15">
6565
</section>
6666
```
@@ -136,6 +136,10 @@ Reveal.initialize({
136136
// i.e. contained within a limited portion of the screen
137137
embedded: false,
138138

139+
// Flags if we should show a help overlay when the questionmark
140+
// key is pressed
141+
help: true,
142+
139143
// Number of milliseconds between automatically proceeding to the
140144
// next slide, disabled when set to 0, this value can be overwritten
141145
// by using a data-autoslide attribute on your slides
@@ -154,13 +158,13 @@ Reveal.initialize({
154158
previewLinks: false,
155159

156160
// Transition style
157-
transition: 'default', // default/cube/page/concave/zoom/linear/fade/none
161+
transition: 'default', // none/fade/slide/convex/concave/zoom
158162

159163
// Transition speed
160164
transitionSpeed: 'default', // default/fast/slow
161165

162166
// Transition style for full page slide backgrounds
163-
backgroundTransition: 'default', // default/none/slide/concave/convex/zoom
167+
backgroundTransition: 'default', // none/fade/slide/convex/concave/zoom
164168

165169
// Number of slides away from the current that are visible
166170
viewDistance: 3,
@@ -175,8 +179,6 @@ Reveal.initialize({
175179
});
176180
```
177181

178-
Note that the new default vertical centering option will break compatibility with slides that were using transitions with backgrounds (`cube` and `page`). To restore the previous behavior, set `center` to `false`.
179-
180182

181183
The configuration can be updated after initialization using the ```configure``` method:
182184

@@ -266,15 +268,20 @@ Reveal.configure({
266268
autoSlide: 5000
267269
});
268270
```
271+
When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »a« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
269272

270-
When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Sliding is also paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
271-
272-
You can also override the slide duration for individual slides by using the ```data-autoslide``` attribute on individual sections:
273+
You can also override the slide duration for individual slides and fragments by using the ```data-autoslide``` attribute:
273274

274275
```html
275-
<section data-autoslide="10000">This will remain on screen for 10 seconds</section>
276+
<section data-autoslide="2000">
277+
<p>After 2 seconds the first fragment will be shown.</p>
278+
<p class="fragment" data-autoslide="10000">After 10 seconds the next fragment will be shown.</p>
279+
<p class="fragment">Now, the fragment is displayed for 2 seconds before the next slide is shown.</p>
280+
</section>
276281
```
277282

283+
Whenever the auto-slide mode is resumed or paused the ```autoslideresumed``` and ```autoslidepaused``` events are fired.
284+
278285

279286
### Keyboard Bindings
280287

@@ -290,6 +297,23 @@ Reveal.configure({
290297
});
291298
```
292299

300+
### Lazy Loading
301+
302+
When working on presentation with a lot of media or iframe content it's important to load lazily. Lazy loading means that reveal.js will only load content for the few slides nearest to the current slide. The number of slides that are preloaded is determined by the `viewDistance` configuration option.
303+
304+
To enable lazy loading all you need to do is change your "src" attributes to "data-src" as shown below. This is supported for image, video, audio and iframe elements.
305+
306+
```html
307+
<section>
308+
<img data-src="image.png">
309+
<iframe data-src="http://slides.com">
310+
<video>
311+
<source data-src="video.webm" type="video/webm" />
312+
<source data-src="video.mp4" type="video/mp4" />
313+
</video>
314+
</section>
315+
```
316+
293317

294318
### API
295319

@@ -308,6 +332,7 @@ Reveal.prevFragment();
308332
Reveal.nextFragment();
309333
Reveal.toggleOverview();
310334
Reveal.togglePause();
335+
Reveal.toggleAutoSlide();
311336

312337
// Retrieves the previous and current slide elements
313338
Reveal.getPreviousSlide();
@@ -320,6 +345,7 @@ Reveal.isFirstSlide();
320345
Reveal.isLastSlide();
321346
Reveal.isOverview();
322347
Reveal.isPaused();
348+
Reveal.isAutoSliding();
323349
```
324350

325351
### Ready Event
@@ -390,7 +416,7 @@ Reveal.initialize({
390416
parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
391417

392418
// This slide transition gives best results:
393-
transition: linear
419+
transition: 'slide'
394420

395421
});
396422
```
@@ -563,7 +589,7 @@ Limitations:
563589
Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
564590
Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.
565591

566-
1. Open your presentation with [css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css) included on the page. The default index HTML lets you add *print-pdf* anywhere in the query to include the stylesheet, for example: [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
592+
1. Open your presentation with `print-pdf` included anywhere in the query string. This triggers the default index HTML to load the PDF print stylesheet ([css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css)). You can test this with [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
567593
2. Open the in-browser print dialog (CMD+P).
568594
3. Change the **Destination** setting to **Save as PDF**.
569595
4. Change the **Layout** to **Landscape**.
@@ -614,7 +640,7 @@ When used locally, this feature requires that reveal.js [runs from a local web s
614640
If you're using the external Markdown plugin, you can add notes with the help of a special delimiter:
615641

616642
```html
617-
<section data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n" data-notes="^Note:"></section>
643+
<section data-markdown="example.md" data-separator="^\n\n\n" data-separator-vertical="^\n\n" data-separator-notes="^Note:"></section>
618644

619645
# Title
620646
## Sub-title
@@ -683,7 +709,7 @@ Reveal.initialize({
683709

684710
// Don't forget to add the dependencies
685711
dependencies: [
686-
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
712+
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
687713
{ src: 'plugin/multiplex/master.js', async: true },
688714

689715
// and if you want speaker notes
@@ -711,7 +737,7 @@ Reveal.initialize({
711737

712738
// Don't forget to add the dependencies
713739
dependencies: [
714-
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
740+
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
715741
{ src: 'plugin/multiplex/client.js', async: true }
716742

717743
// other dependencies...
@@ -749,7 +775,7 @@ Reveal.initialize({
749775

750776
// Don't forget to add the dependencies
751777
dependencies: [
752-
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
778+
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
753779
{ src: 'plugin/multiplex/client.js', async: true }
754780

755781
// other dependencies...
@@ -772,7 +798,7 @@ Reveal.initialize({
772798

773799
// Don't forget to add the dependencies
774800
dependencies: [
775-
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
801+
{ src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.16/socket.io.min.js', async: true },
776802
{ src: 'plugin/multiplex/master.js', async: true },
777803
{ src: 'plugin/multiplex/client.js', async: true }
778804

@@ -909,23 +935,6 @@ Some reveal.js features, like external markdown and speaker notes, require that
909935
- **lib/** All other third party assets (JavaScript, CSS, fonts)
910936
911937
912-
### Contributing
913-
914-
Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue.
915-
916-
If you have personal support questions use [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js).
917-
918-
919-
#### Pull requests
920-
921-
- Should follow the coding style of the file you work in, most importantly:
922-
- Tabs to indent
923-
- Single-quoted strings
924-
- Should be made towards the **dev branch**
925-
- Should be submitted from a feature/topic branch (not your master)
926-
- Should not include the minified **reveal.min.js** file
927-
928-
929938
## License
930939
931940
MIT licensed

0 commit comments

Comments
 (0)