myplanetdigital/reveal.js-drupal8_essentials

Name: reveal.js-drupal8_essentials

Owner: Myplanet

Description: Planetarium to summarize what we learned at @palantirnet's Drupal 8 Essentials course.

Created: 2013-08-15 03:15:19.0

Updated: 2014-02-16 03:31:44.0

Pushed: 2013-08-15 03:45:21.0

Homepage: http://myplanetdigital.github.io/reveal.js-drupal8_essentials/

Size: 308

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

reveal.js Build Status

A framework for easily creating beautiful presentations using HTML. Check out the live demo.

reveal.js comes with a broad range of features including nested slides, markdown contents, PDF export, speaker notes and a JavaScript API. It's best viewed in a browser with support for CSS 3D transforms but fallbacks are available to make sure your presentation can still be viewed elsewhere.

More reading:
Slides

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.

Instructions
Markup

Markup hierarchy 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:

 class="reveal">
<div class="slides">
    <section>Single Horizontal Slide</section>
    <section>
        <section>Vertical Slide 1</section>
        <section>Vertical Slide 2</section>
    </section>
</div>
v>
Markdown

It's possible to write your slides using Markdown. To enable Markdown, add the `data-markdownattribute to your ``

` elements and wrap the contents in a<script type="text/template">`` like the example below.

This is based on data-markdown from Paul Irish modified to use marked to support Github Flavoured Markdown. Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).

tion data-markdown>
<script type="text/template">
    ## Page title

    A paragraph with some text and a [link](http://hakim.se).
</script>
ction>
External Markdown

You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file.

tion data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n"></section>
Configuration

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.

al.initialize({

// Display controls in the bottom right corner
controls: true,

// Display a presentation progress bar
progress: true,

// Push each slide change to the browser history
history: false,

// Enable keyboard shortcuts for navigation
keyboard: true,

// Enable touch events for navigation
touch: true,

// Enable the slide overview mode
overview: true,

// Vertical centering of slides
center: true,

// Loop the presentation
loop: false,

// Change the presentation direction to be RTL
rtl: 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
mouseWheel: false,

// Apply a 3D roll to links on hover
rollingLinks: true,

// Transition style
transition: 'default', // default/cube/page/concave/zoom/linear/fade/none

// Transition speed
transitionSpeed: 'default', // default/fast/slow

// Transition style for full page backgrounds
backgroundTransition: 'default' // default/linear


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.

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

urn autoSlide off
al.configure({ autoSlide: 0 });

tart auto-sliding every 5s
al.configure({ autoSlide: 5000 });
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:

al.initialize({
dependencies: [
    // Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/
    { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },

    // Interpret Markdown in <section> elements
    { src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
    { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },

    // Syntax highlight for <code> elements
    { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },

    // Zoom in and out with Alt+click
    { src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },

    // Speaker notes
    { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } },

    // Remote control your reveal.js presentation using a touch device
    { src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } }
]

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
Presentation Size

All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport.

See below for a list of configuration options related to sizing, including default values:

al.initialize({

...

// The "normal" size of the presentation, aspect ratio will be preserved
// when the presentation is scaled to fit different resolutions. Can be
// specified using percentage units.
width: 960,
height: 700,

// Factor of the display size that should remain empty around the content
margin: 0.1,

// Bounds for smallest/largest possible scale to apply to content
minScale: 0.2,
maxScale: 1.0


Keyboard Bindings

If you're unhappy with any of the default keyboard bindings you can override them using the `keyboard` config option:

al.configure({
yboard: {
13: 'next', // go to the next slide when the ENTER key is pressed
27: function() {}, // do something custom when ESC is pressed
32: null // don't do anything when SPACE is pressed (i.e. disable a reveal.js default binding)


API

The Reveal class provides a JavaScript API for controlling navigation and reading state:

avigation
al.slide( indexh, indexv, indexf );
al.left();
al.right();
al.up();
al.down();
al.prev();
al.next();
al.prevFragment();
al.nextFragment();
al.toggleOverview();
al.togglePause();

etrieves the previous and current slide elements
al.getPreviousSlide();
al.getCurrentSlide();

al.getIndices(); // { h: 0, v: 0 } }

tate checks
al.isFirstSlide();
al.isLastSlide();
al.isOverview();
al.isPaused();
Ready Event

The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.

al.addEventListener( 'ready', function( event ) {
// event.currentSlide, event.indexh, event.indexv

Slide Changed 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.

Some libraries, like MathJax (see #226), get confused by the transforms and display states of slides. Often times, this can be fixed by calling their update or render function from this callback.

al.addEventListener( 'slidechanged', function( event ) {
// event.previousSlide, event.currentSlide, event.indexh, event.indexv

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:

al.addEventListener( 'somestate', function() {
// TODO: Sprinkle magic
alse );
Slide Backgrounds

Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page background colors or images by applying a `data-backgroundattribute to your ``

``` elements. Below are a few examples.

tion data-background="#ff0000">
<h2>All CSS color formats are supported, like rgba() or hsl().</h2>
ction>
tion data-background="http://example.com/image.png">
<h2>This slide will have a full-size background image.</h2>
ction>
tion data-background="http://example.com/image.png" data-background-size="100px" data-background-repeat="repeat">
<h2>This background image will be sized to 100px and repeated.</h2>
ction>

Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing `backgroundTransition: 'slide'to the ``Reveal.initialize()` call. Alternatively you can setdata-background-transition`` on any section with a background to override that specific transition.

Slide Transitions

The global presentation transition is set using the `transitionconfig value. You can override the global transition for a specific slide by using the ``data-transition``` attribute:

tion data-transition="zoom">
<h2>This slide will override the presentation transition and zoom!</h2>
ction>

tion data-transition-speed="fast">
<h2>Choose from three transition speeds: default, fast or slow!</h2>
ction>

Note that this does not work with the page and cube transitions.

Internal links

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">`):

ref="#/2/2">Link</a>
ref="#/some-slide">Link</a>

You can also add relative navigation links, similar to the built in reveal.js controls, by appending one of the following classes on any element. Note that each element is automatically given an `enabled` class when it's a valid navigation route based on the current slide.

ref="#" class="navigate-left">
ref="#" class="navigate-right">
ref="#" class="navigate-up">
ref="#" class="navigate-down">
ref="#" class="navigate-prev"> <!-- Previous vertical or horizontal slide -->
ref="#" class="navigate-next"> <!-- Next vertical or horizontal slide -->
Fragments

Fragments are used to highlight individual elements on a slide. Every element with the class `fragment` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/16

The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:

tion>
<p class="fragment grow">grow</p>
<p class="fragment shrink">shrink</p>
<p class="fragment roll-in">roll-in</p>
<p class="fragment fade-out">fade-out</p>
<p class="fragment highlight-red">highlight-red</p>
<p class="fragment highlight-green">highlight-green</p>
<p class="fragment highlight-blue">highlight-blue</p>
ction>

Multiple fragments can be applied to the same element sequentially by wrapping it, this will fade in the text on the first step and fade it back out on the second.

tion>
<span class="fragment fade-in">
    <span class="fragment fade-out">I'll fade in, then out</span>
</span>
ction>

The display order of fragments can be controlled using the `data-fragment-index` attribute.

tion>
<p class="fragment" data-fragment-index="3">Appears last</p>
<p class="fragment" data-fragment-index="1">Appears first</p>
<p class="fragment" data-fragment-index="2">Appears second</p>
ction>
Fragment events

When a slide fragment is either shown or hidden reveal.js will dispatch an event.

al.addEventListener( 'fragmentshown', function( event ) {
// event.fragment = the fragment DOM element

al.addEventListener( 'fragmenthidden', function( event ) {
// event.fragment = the fragment DOM element

Code syntax highlighting

By default, Reveal is configured with highlight.js for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted. When the data-trim attribute is present surrounding whitespace is automatically removed.

tion>
<pre><code data-trim>
 lazy-fib
oncat
0 1]
(fn rfib [a b]
    (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))
</code></pre>
ction>
Overview mode

Press “Esc” key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides, as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:

al.addEventListener( 'overviewshown', function( event ) { /* ... */ } );
al.addEventListener( 'overviewhidden', function( event ) { /* ... */ } );

oggle the overview mode programmatically
al.toggleOverview();
Fullscreen mode

Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.

Embedded media

Embedded HTML5 <video>/<audio> and YouTube iframes are automatically paused when your navigate away from a slide. This can be disabled by decorating your element with a data-ignore attribute.

Add data-autoplay to your media element if you want it to automatically start playing when the slide is shown:

eo data-autoplay src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
PDF Export

Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use Google Chrome. Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.

  1. Open your presentation with 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.
  2. Open the in-browser print dialog (CMD+P).
  3. Change the Destination setting to Save as PDF.
  4. Change the Layout to Landscape.
  5. Change the Margins to None.
  6. Click Save.

Chrome Print Settings

Theming

The framework comes with a few different themes included:

  • default: Gray background, white text, blue links
  • beige: Beige background, dark text, brown links
  • sky: Blue background, thin white text, blue links
  • night: Black background, thick white text, orange links
  • serif: Cappuccino background, gray text, brown links
  • simple: White background, black text, blue links

Each theme is available as a separate stylesheet. To change theme you will need to replace default below with your desired theme name in index.html:

k rel="stylesheet" href="css/theme/default.css" id="theme">

If you want to add a theme of your own see the instructions here: /css/theme/README.md.

Speaker Notes

reveal.js comes with a speaker notes plugin which can be used to present per-slide notes in a separate browser window. The notes window also gives you a preview of the next upcoming slide so it may be helpful even if you haven't written any notes. Press the 's' key on your keyboard to open the notes window.

By default notes are written using standard HTML, see below, but you can add a `data-markdownattribute to the ``


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.