/neo4j-slide-types

A catalog of HTML5-based slide types for Neo4j presentations

Primary LanguageCSS

Neo4j Slide Types

This repository documents slide types and presentation techniques and also provides a sample Bespoke.js presentation that implements several of these ideas.

Building the presentation

Prerequisites

In order to use this project, you only need to be able to run Gradle (specifically, the Gradle Wrappper). To run Gradle, you need:

  1. Java Development Kit (JDK) (typically OpenJDK or Oracle JDK) [1]

Gradle takes care of the rest!

Setup

Next, clone the repository and switch to the project directory:

$ git clone https://github.com/opendevise/neo4j-slide-types.git
  cd neo4j-slide-types

Then, collect the required dependencies and initialize the build:

$ ./gradlew setup

That’s it! You’re all set to build the presentation.

Building the static version

You can build a static version of the slides using the following command:

$ ./gradlew build

The files are built into the build/bespoke directory. You can view the slides by navigating to build/bespoke/index.html in your browser.

Launching the preview server

The preview server makes the presentation available through a local URL. You can launch the preview server using:

$ ./gradlew serve

Once the server is running, you can view the slides by navigating to http://localhost:8000 in your browser.

Note
 Use ctrl+c to shutdown the preview server.

Enabling automatic updates

You can have the build monitor the source files for changes and rerun the tasks whenever a change is detected. You can also get it to push updates directly to the browser (i.e., LiveReload), saving you from having to manually refresh the page.

In order to activate this arrangement, you’ll need two terminal windows open. In the first window, run the task that generates the slides using continuous build mode:

$ ./gradlew -t build

This command runs Gradle indefinitely, actively monitoring the source files for changes and rerunning the build task whenever a change is detected. Thanks to Gradle’s up-to-date checks, only the tasks affected by the source file(s) that changed will do work.

In the second window, run the task that launches the preview server and activates the LiveReload protocol:

$ ./gradlew serveLive

Once the server is running, you can view the slides by navigating to http://localhost:8000 in your browser. This time, however, you won’t have to worry about refreshing the page.

Note
 Use ctrl+c to shutdown the preview server and LiveReload.

Catalog

See the Neo4j Slide Types catalog (in progress) for a list of slide types, their definitions, design concepts and comps and notes about how to apply them.

Resources

Advice for giving presentations

They were just there to learn about XYZ, and, hopefully, we delivered -- the software was there just to help. Which is otherwise a great way to think about any slide deck you ever do.
— Marcin Wichary
You really don’t need your corporate logo on every slide.
— Damian Conway

Other essential background

Terminology

stagedeck

A presentation that is designed to projected and delivered to an audience (i.e., on stage). Opposite of an infodeck.

See the Presentation Patterns glossary for other defined terminology.

Reference presentations

The following presentations are either good examples or exhibit bright spots.

1. We strongly recommend using jenv to manage the JDK.