Impress.js: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
Line 281: Line 281:
* each of these (or almost) should support the same small set of HTML tags: h1, ul, ol, li, p, q, big, b
* each of these (or almost) should support the same small set of HTML tags: h1, ul, ol, li, p, q, big, b
* Some extra stuff will be code with extra classes.
* Some extra stuff will be code with extra classes.
=== Test ===
(working, but not finished so far ....)
* Directory: http://tecfa.unige.ch/guides/impress.js/impress-demo-1/
* [http://tecfa.unige.ch/guides/impress.js/impress-demo-1/test.html test.html]
* [http://tecfa.unige.ch/guides/impress.js/impress-demo-1/impress.js impress.js]
* [http://tecfa.unige.ch/guides/impress.js/impress-demo-1/impress-min-presi.css impress-min-presi.css]


== Links ==
== Links ==

Revision as of 15:23, 27 August 2013

Draft

Introduction

Impress.js is a JavaScript library that allows creating "Prezi-style" presentations.

“impress.js is a presentation framework build upon the powerful CSS3 transformations and transitions on modern web browsers. Bartek Szopka is the creator of this amazing framework. According to the creator, the idea came to him while he was playing with CSS transformations. Prezi.com was the source that got him inspired.” (Ratnayake, 2013: 8)

Impress.js relies on CSS Transforms Level 1 and only will work in modern browser (compatibility table).

Demos

It's probably a good idea to look at a few demos, in order to decide whether you want to read on: Examples and demos

Principle

An impress.js presentation is (like in a Prezi presentation), a collection of "steps" that are positioned on a huge drawing canevas. Impress.js will allow the user to navigate to each "step", using transition animations.

An impression of the overal presentation canvas (from the impress.js demo)

This library is used in the following way:

  • You will have to write your "steps" in HTML code
  • Each step is wrapped in a div using the class "step". In addition, you can definition position, scale and rotation for each step.
  • Steps can be styled with classes and id's. There are some defaults, and in addition you can use the slide class". However, advanced authors would adapt the demo style sheet.
<div class="step slide" .... positioning/scaling/rotation parameters here ....>
 .... HTML contents here ...
</div>

Presentation of the library

Files

After downloading and unpacking, you will see a directory structure like this (Aug 25 2013):

bartaz-impress.js-master (directory)

css (directory)
impress-demo.css
js (directory)
impress.js
apple-touch-icon.png
bower.json
favicon.png
index.html
README.md

As you will see, for starters, you only need to consider two important files

  • impress.js - the library
  • impress-demo.css - a default stylesheet that defines size of slides, fonts and many other things. It is not strictly needed.
  • index.html - An HTML demo file that also includes the documentation if you look at the source.

The files impress-demo.css, favicon.png and apple-touch-icon.png are not needed and are not used by the index.html demo/manual file.

We suggest starting to learn impress.js by modifying the index.html file. Therefore, we suggest creating a copy of index.html and then opening it in a text editor (preferably one that understands HTML). Also consider renaming the original index.html file.

Structure of an impress.js presentation

The JavaScript code will relies on a precise HTML structure. Your HTML file must include at the least the following:

  • A div id="impress"> wrapper that will include all your steps (also called slides).
  • Each step is defined by a div class="step"> wrapper. The div then can include an id as well as positioning, scaling and rotation information. The latter are defined with HTML attributes. Finally, you can of course add your own classes.
  • Somewhere, e.g. after the end of the HTML code, you must load and initialize the library

Below is a minimalist HTML5 file that contains two slides: 

<!doctype html>
<html lang="en">
<head>
    <link href="css/impress-demo.css" rel="stylesheet" />
</head>

<body>

<div id="impress">
  <!-- slide 1 -->
  <div id="slide1" class="step" data-x="0" data-y="0">
     <p>Slide 1</p>
  </div>
  <!-- slide 2 -->
  <div id="slide2" class="step" data-x="0" data-y="-1000">
    <p>Slide 2</p>
    <p>More to say</p>
  </div>
</div>

<!-- initialize the script -->
<script src="js/impress.js"></script>
<script>impress().init();</script>
</body>
</html>

Try it: minimalistic.html

Positioning, rotation and scaling with HTML attributes

Basically, these attributes tell where a slide will on the global canvas. Impress.ch then will create movement, scaling and rotation animation to go from one slide to the next one.

Attribute Description Values Default value Example
data-x Center of slide on x-axis pixels 0 data-x ="-1000"
data-y Center of slide on y-axis pixels 0 data-y="1000"
data-z Center of slide on z-axis pixels 0
data-rotate-x Rotation of the slide around x-axis degrees 0
data-rotate-y Rotation of the slide around y-axis degrees 0
data-rotate-z (or data-rotate) Rotation of the slide around z-axis degrees 0 data-rotate="270"
data-scale Scaling of slide Number 1 data-scale = "10"

Here is a screenshot of a simple example. The screen capture was made using from the last step, which has no content but just a big zoom out.

Positioning, rotation and scaling

Code fragment: 

<div id="impress">

  <!-- slide 1 -->
  <div id="slide1" class="step slide" data-x="0" data-y="0">
    Slide 1
    <ul>
      <li>Sits in the middle</li>
    </ul>
  </div>

  <!-- slide 2 -->
  <div id="slide2" class="step slide" data-x="0" data-y="-1000">
    Slide 2
    <ul>
      <li>Sits up</li>
    </ul>
  </div>

  <!-- slide 3 -->
  <div id="slide3" class="step slide" data-x="1500" data-y="0" data-rotate="90" data-rotate-y="180">
    Slide 3
    <ul>
      <li>Sits right and is rotated</li>
    </ul>
  </div>

  <!-- slide 4 -->
  <div id="slide4" class="step slide" data-x="0" data-y="2000" data-scale="4">
    Slide 4
    <ul>
      <li>Sits down and is big</li>
    </ul>
  </div>

  <!-- overview, just position and zoom out a lot -->
  <div id="overview" class="step" data-x="1800" data-y="1500" data-scale="8">
  </div>

Try it: positions.html

The default style sheet

The default style sheet, i.e. css/impress-demo.css does a lot of things. Let's just introduce the easy stuff. Firstly, it resets all HTML elements. In other words, do not expect to see default rendering of HTML tags. For example, an <ul> <li> </li> </ul> will not produce bullets. This style sheet then defines some classes and id's that are useful to have for styling a "slide".

The demo style sheet sheet can be used as is. However, it is meant for inspiration. In particular it shows how to style differently each slide of the demo file, originally called index.html.

slide class
The slide class will make the slide look a slide
By default it has rounded corners, light background
Size 900 x 700 px
The HTML q tag is made big.
id=title
The title defines the style for the first step that has id=title
In particular it refines h1 to be big.
id=big
Styles the slide for big ideas
The b tag has a size of 250px

Below is the HTML fragment of a little demo file that makes use of this demo CSS. 

<div id="impress">
  <!-- slide 1 -->
  <div id="title" class="step slide" data-x="0" data-y="0">
     <h1>Slide 1</h1>
     <q>impress.js title slide</q>
     <p class="footnote">Play with the arrow keys, either up/down or back/forward</p>
  </div>

  <!-- slide 2 -->
  <div id="big" class="step slide" data-x="0" data-y="-1000">
    This is <b>nice</b>
    <p class="thoughts"> ... for communicating thoughts</p>
  </div>

  <!-- slide 2 -->
  <div id="big" class="step slide" data-x="0" data-y="-1000">
    This is <b>nice</b>
    <p class="thoughts"> ... for communicating thoughts</p>
  </div>

  <!-- slide 3 -->
  <div id="tiny" class="step slide" data-x="0" data-y="-800">
    <p>You may consider changing id's into classes, if you like the original demo slides</p>
    <p>The included CSS is just for inspiration. Actually, we make a few minor changes</p>
  </div>
</div>

Try it: minimalistic-with-style.html

The demo CSS file also demonstrates that you could do CSS animations within the style sheet and other fancy stuff. Study it yourself, we will go back to basics here...

Transition mechanics

When a user loads the page, impress.js assigns one three classes: `future`, `present` and `past` to each step. Only one, i.e. the one shown, is present. At presentation start, all steps are future. Each visited slide becomes past. future and past steps are rendered opaque in the demo style sheet.

By default, slides are shown after each other. However you also can script the transition using the API. The impress() function provides access to the API that controls the presentation. It provides four functions you can use, goto() being the most interesting one.

function Description Example 
impress().init()
initializes the presentation 
impress().next()
moves to next step of the presentation, 
impress().prev()
moves to previous step of the presentation, 
impress().goto() ( idx | id | element, [duration])
moves the presentation to the step given by its index number, id or the DOM element. The second duration parameter can be used to overide the default duration of the transition in ms. impress().goto("menu")

Alternatively you can get these like this: 

var api = impress;
api.next();
....

A simple example

Firstly, it is best to sketch out the presentation on paper.

  • Either position slides in different positions
  • Or make them big / tiny (then use scaling)

Second, you will have to think about the kinds of steps you would like to use, since you will have to make modifications to the CSS file. This example should provide you with some inspiration.

Requirements

We would like to produce five kinds of slides

  • slide: "Slides" styled steps
  • normal: normal steps (no slide look)
  • note: small notes
  • thoughts: bold thoughts, using one sentence and big fonts
  • pictures: pictures with a small legend

Each of these will have a CSS class, e.g. you could do something like: 

 <div id="slide1" class="step slide" data-x="-1000" data-y="-1000">
  ....
  </div>
  <div id="slide3" class="step note" data-x="200" data-y="-1100" data-scale="0.2">
    <p>One <b>bold</b> idea</p>
  </div>

In addition,

  • each of these (or almost) should support the same small set of HTML tags: h1, ul, ol, li, p, q, big, b
  • Some extra stuff will be code with extra classes.

Test

(working, but not finished so far ....)

Links

Official
Example code using in this page
Tutorials
CSS transformation (on which impress.js is based)
Books
Retrieved from "https://edutechwiki.unige.ch/mediawiki/index.php?title=Impress.js&oldid=46142"