fa20-bt/README.md

247 lines
9.8 KiB
Markdown
Raw Normal View History

2011-12-05 02:21:15 +00:00
# reveal.js
2011-06-07 20:38:22 +00:00
2012-08-08 01:44:40 +00:00
A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
2011-12-27 05:34:53 +00:00
2012-08-08 01:44:40 +00:00
reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.
2011-12-05 02:21:15 +00:00
2012-08-08 01:44:40 +00:00
#### More reading in the Wiki:
2012-08-08 01:55:08 +00:00
- [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history.
- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
2012-08-08 01:44:40 +00:00
2012-09-10 02:07:57 +00:00
## rvl.io
2012-09-04 16:33:40 +00:00
2012-09-10 02:07:57 +00:00
Slides are written using HTML or markdown but there's also an online editor for those of you who prefer a more traditional user interface. Give it a try at [www.rvl.io](http://www.rvl.io).
2012-09-04 16:33:40 +00:00
2012-08-08 01:44:40 +00:00
## Instructions
2012-01-15 02:20:52 +00:00
### Markup
2012-01-15 02:20:52 +00:00
Markup heirarchy needs to be ``<div class="reveal"> <div class="slides"> <section>`` where the ``<section>`` represents one slide and can be repeated indefinitely. If you place multiple ``<section>``'s inside of another ``<section>`` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and it will be included in the horizontal sequence. For example:
2012-06-07 02:52:49 +00:00
```html
<div class="reveal">
<div class="slides">
<section>Single Horizontal Slide</section>
<section>
<section>Vertical Slide 1</section>
<section>Vertical Slide 2</section>
</section>
</div>
</div>
```
2012-07-31 05:49:02 +00:00
### Markdown
2012-10-08 13:17:39 +00:00
It's possible to write your slides using Markdown. To enable Markdown, add the ```data-markdown``` attribute to your ```<section>``` elements and wrap the contents in a ```<script type="text/template">``` like the example below.
2012-07-31 05:49:02 +00:00
This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) which in turn uses [showdown](https://github.com/coreyti/showdown/). This is sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).
2012-07-31 05:49:02 +00:00
```html
<section data-markdown>
<script type="text/template">
## Page title
A paragraph with some text and a [link](http://hakim.se).
</script>
2012-07-31 05:49:02 +00:00
</section>
```
### Configuration
2012-08-08 01:44:40 +00:00
At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
2012-01-15 02:20:52 +00:00
2012-06-07 02:52:49 +00:00
```javascript
2012-01-15 02:20:52 +00:00
Reveal.initialize({
// Display controls in the bottom right corner
2012-01-15 02:20:52 +00:00
controls: true,
// Display a presentation progress bar
progress: true,
// Push each slide change to the browser history
history: false,
2012-01-15 02:20:52 +00:00
// Enable keyboard shortcuts for navigation
keyboard: true,
// Enable the slide overview mode
overview: true,
// Loop the presentation
2012-04-28 16:16:56 +00:00
loop: false,
// Number of milliseconds between automatically proceeding to the
// next slide, disabled when set to 0, this value can be overwritten
// by using a data-autoslide attribute on your slides
autoSlide: 0,
// Enable slide navigation via mouse wheel
2012-01-15 03:22:27 +00:00
mouseWheel: true,
2012-01-15 02:20:52 +00:00
// Apply a 3D roll to links on hover
rollingLinks: true,
// Transition style
2012-10-13 14:28:34 +00:00
transition: 'default' // default/cube/page/concave/zoom/linear/none
2012-01-15 02:20:52 +00:00
});
```
2012-08-12 00:52:56 +00:00
### Dependencies
Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example:
```javascript
Reveal.initialize({
dependencies: [
2012-08-15 02:06:53 +00:00
// Syntax highlight for <code> elements
2012-08-12 00:52:56 +00:00
{ src: 'lib/js/highlight.js', async: true, callback: function() { window.hljs.initHighlightingOnLoad(); } },
2012-08-15 02:06:53 +00:00
// Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/
2012-08-12 00:52:56 +00:00
{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }
2012-08-15 02:06:53 +00:00
// Interpret Markdown in <section> elements
{ src: 'lib/js/data-markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'lib/js/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
2012-10-15 06:15:41 +00:00
// Zoom in and out with Alt+click
{ src: 'plugin/zoom-js/zoom.js', condition: function() { return !!document.body.classList; } },
2012-08-15 02:06:53 +00:00
// Speaker notes support
{ src: 'plugin/speakernotes/client.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } },
2012-09-03 08:54:43 +00:00
{ src: '/socket.io/socket.io.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } },
2012-08-12 00:52:56 +00:00
]
});
```
You can add your own extensions using the same syntax. The following properties are available for each dependency object:
- **src**: Path to the script to load
- **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false
- **callback**: [optional] Function to execute when the script has loaded
- **condition**: [optional] Function which must return true for the script to be loaded
### API
The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
2012-07-21 02:57:23 +00:00
```javascript
// Navigation
Reveal.slide( indexh, indexv );
Reveal.left();
Reveal.right();
Reveal.up();
Reveal.down();
Reveal.prev();
Reveal.next();
2012-07-21 02:57:23 +00:00
Reveal.toggleOverview();
// Retrieves the previous and current slide elements
Reveal.getPreviousSlide();
Reveal.getCurrentSlide();
Reveal.getIndices(); // { h: 0, v: 0 } }
2012-07-21 02:57:23 +00:00
```
### States
If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
Furthermore you can also listen to these changes in state via JavaScript:
2012-06-07 02:52:49 +00:00
```javascript
Reveal.addEventListener( 'somestate', function() {
// TODO: Sprinkle magic
}, false );
```
2012-10-17 04:20:42 +00:00
### Ready event
The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.
```javascript
Reveal.addEventListener( 'ready', function( event ) {
// event.currentSlide, event.indexh, event.indexv
} );
```
### Slide change event
An 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes.
2012-06-07 02:52:49 +00:00
```javascript
Reveal.addEventListener( 'slidechanged', function( event ) {
// event.previousSlide, event.currentSlide, event.indexh, event.indexv
} );
```
### Fragment events
When a slide fragment is either shown or hidden reveal.js will dispatch an event.
2012-06-07 02:52:49 +00:00
```javascript
Reveal.addEventListener( 'fragmentshown', function( event ) {
// event.fragment = the fragment DOM element
} );
Reveal.addEventListener( 'fragmenthidden', function( event ) {
// event.fragment = the fragment DOM element
} );
```
2012-08-21 02:13:00 +00:00
### Internal links
2012-08-24 20:48:54 +00:00
It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (```<section id="some-slide">```):
2012-08-21 02:13:00 +00:00
```html
<a href="#/2/2">Link</a>
<a href="#/some-slide">Link</a>
```
2012-08-04 20:38:59 +00:00
## PDF Export
Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.
2012-09-21 12:50:28 +00:00
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).
2012-08-04 20:38:59 +00:00
2. Open the in-browser print dialog (CMD+P).
3. Change the **Destination** setting to **Save as PDF**.
2012-08-08 02:01:56 +00:00
4. Change the **Layout** to **Landscape**.
2012-08-04 20:38:59 +00:00
5. Change the **Margins** to **None**.
6. Click **Save**.
![Chrome Print Settings](https://s3.amazonaws.com/hakim-static/reveal-js/pdf-print-settings.png)
## 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 `<aside class="notes">` element to any slide. These notes will be hidden in the main presentation view.
2012-09-21 13:08:24 +00:00
It's also possible to write your notes with Markdown. To enable Markdown, add the ```data-markdown``` attribute to your note ```<aside>``` elements.
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 plugin/speakernotes
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 `plugin/speakernotes/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.
2012-08-08 01:44:40 +00:00
## Folder Structure
- **css/** Core styles without which the project does not function
- **js/** Like above but for JavaScript
- **plugin/** Components that have been developed as extensions to reveal.js
- **lib/** All other third party assets (JavaScript, CSS, fonts)
2011-06-07 20:38:22 +00:00
## License
2011-06-09 19:21:54 +00:00
MIT licensed
Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se
2012-10-15 06:15:41 +00:00