• Stars
    star
    160
  • Rank 234,703 (Top 5 %)
  • Language
    Clojure
  • Created almost 13 years ago
  • Updated about 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

JavaScript presentation slides generated from Emacs org-mode

Org-HTML-Slideshow

You have an outline written in Emacs Org-Mode. Export it to HTML. Add Org-HTML-Slideshow, and you have an interactive slide presentation that runs in a web browser!

Supports anything Org-Mode can export: bulleted lists, code blocks, images, etc.

Should work in most modern web browsers; tested only in Google Chrome 29.0.1547.76.

Org-HTML-Slideshow is written in ClojureScript.

Recommended Emacs Platform

  • GNU Emacs version 24+
    • Check version with M-x emacs-version
  • Org-Mode version 8+
    • Check version by opening an .org file and M-x org-version
  • Htmlize version 1.37+

For Emacs 23 and Org-mode 7, use the older version of org-html-slideshow on the Git branch emacs23-org7

Using in Your Org-mode Files

Step 1. Copy the following files from the production directory to the directory containing your .org file:

org-html-slideshow.js
common.css
presenter.css
projection.css
screen.css

Step 2. Add the following lines to the bottom of your .org file:

#+OPTIONS: num:nil tags:t

#+TAGS: slide(s)

#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="common.css" />
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="screen.css" media="screen" />
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="projection.css" media="projection" />
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="presenter.css" media="presenter" />

#+BEGIN_HTML
<script type="text/javascript" src="org-html-slideshow.js"></script>
#+END_HTML

# Local Variables:
# org-html-head-include-default-style: nil
# org-html-head-include-scripts: nil
# End:

Step 3. Close and re-open your .org file. Type y to accept the buffer-local variables.

Adding Tags to Your Org-Mode File

For each org-mode headline that you want to make into a slide, add the :slide: tag by typing C-c C-c s RET with the cursor on the headline.

Additional tags will be added as CSS classes on the slides.

Read more about tags in the Org-Mode manual.

See the files example.org and example.html for more examples of things you can do with Org-Mode.

Exporting to HTML

Type C-c C-e h h in your .org file to export as HTML. Repeat whenever you modify the .org file.

Read more about HTML export in the Org-Mode manual.

Playing the Slide Show

Open the generated HTML file in your browser and type t to begin the slide show.

The Space, Enter, Page Down, and n keys advance to the next slide.

The Page Up and p keys go back to the previous slide.

The t key toggles between slide-show and normal views.

Move the mouse to the lower right-hand corner of the screen to show a control panel with links to navigate the slide show by mouse.

Presenter Preview

While playing the slide show, click on the control panel's "Open presenter preview" link. This will open a new window showing the currently visible slide, upcoming slide, wall clock time, and elapsed time since the presentation began.

Presenter Notes

Add a sub-heading with the tag :notes: beneath a :slide: heading. The content under the notes heading will be displayed in the Presenter Preview window with the slide.

Changing Styles

You can modify the appearance of your slides by editing the stylesheets:

  • projection.css affects only the slide-show view
  • screen.css affects only the normal view
  • common.css affects both
  • presenter.css affects only the presenter preview

Development

To develop and build org-html-slideshow, you will need the following programs already installed:

In the top-level directory of this project, run the following commands to download additional dependencies:

git submodule init
git submodule update

Rebuilding Development Examples

Build the development version (one file, unoptimized, readable JavaScript source) with:

lein cljsbuild once development

The JavaScript file will be written to out/development/org-html-slideshow.js.

You will need Emacs (version 24+) and org-mode (version 8+) to generate the HTML.

Open example.org in Emacs and type C-e h o. Emacs will generate an HTML file and open it in your default browser. Type t to begin the slide show.

Rebuilding Production Files

Build the production version (one file, optimized, not human-readable) with:

lein cljsbuild once production

The JavaScript file will be written to production/org-html-slideshow.js.

Change Log

  • 27-Sept-2013: Switch to Emacs 24 and Org-mode 8

    Org-mode 8 introduced breaking changes in the way it exports HTML, necessitating breaking changes in org-html-slideshow.

    For Emacs 23 and Org-mode 7, use the older version of org-html-slideshow on the Git branch emacs23-org7

  • 11-Dec-2011: Initial release

Copyright & Contributions

There is no copyright. I dedicate this work to the public domain.

I am not actively developing new features for this project.

Contributors

  • Stuart Sierra (primary author)
  • Craig Andera
  • Alex Redington

More Repositories

1

labrepl

Clojure
504
star
2

tarantula

a big hairy fuzzy spider that crawls your site, wreaking havoc
Ruby
444
star
3

rcov

The new home of RCov on GitHub
Ruby
409
star
4

streamlined

Ruby
207
star
5

diametric

Diametric is a library for building schemas, queries, and transactions for Datomic from Ruby objects.
Ruby
169
star
6

functional-koans

A set of common ideas for learning functional programming
156
star
7

etc

bash scripts, aliases, other misc things go here
Shell
153
star
8

log_buddy

logbuddy is your friendly little log buddy by your side
Ruby
141
star
9

clojure-conj

134
star
10

edn-ruby

Ruby implementation of Extensible Data Notation as defined by Rich Hickey
Ruby
119
star
11

cap_gun

Bang! You've deployed!
Ruby
115
star
12

castronaut

CAS Server
Ruby
101
star
13

mycroft

It's your data, look at it anywhere
Clojure
66
star
14

vasco

A route-explorer for Rails
JavaScript
57
star
15

hooppps

Ruby
56
star
16

boids

Boids flocking simulator in ClojureScript (for ClojureScript training)
JavaScript
38
star
17

blue-ridge-sample-app

Sample Rails project demonstrating JavaScript testing with Blue-Ridge
JavaScript
30
star
18

how_we_work

Relevance's How We Work site
JavaScript
22
star
19

java-tdd

TDD Examples, Labs, and References
Java
19
star
20

multi_rails

Test against many versions of Rails with a single command.
Ruby
19
star
21

spec_converter

Ruby
15
star
22

smoke_signals

CruiseControl.rb Campfire notifications
Ruby
11
star
23

cache_test

Fork of Damien Merenne's cache_test plugin. Updated to work with Rails 2.1.x.
10
star
24

jquery-demos

Demos and Presentation on jQuery
JavaScript
9
star
25

github_hook

Simple object wrapper around the Github post receive JSON payload.
Ruby
7
star
26

Iteration-Zero

Slides for Iteration Zero talk
5
star
27

clojure-async-blocks

Area to rough out async blocks in clojure
Clojure
5
star
28

prototaculous

sample code and presentation on Prototype and Scriptaculous
JavaScript
5
star
29

contegix-cloud-client

Contegix Cloud client API reference implementation
Ruby
5
star
30

relevance_rails

Relevance awesome sauce packaged up in an easy to use gem
Ruby
5
star
31

obsidian

It's metastable
Ruby
5
star
32

connectomatic

A simple gem that makes it easy to use multiple databases from Rails
Ruby
4
star
33

relevant-datetime

Datetime widget for Relevant
Ruby
4
star
34

relevant-hudson

Hudson widget for Relevant
Ruby
4
star
35

relevant-google-calendar

Google Calendar plugin for Relevant
Ruby
4
star
36

ending-legacy-code

Ending legacy code in our lifetime
4
star
37

koality

Runs opinionated code quality tools as part of you test stuite
Ruby
4
star
38

relevant-html

Simple html widget for Relevant
Ruby
3
star
39

automan

Let's just say it's awesome. Fair enough?
JavaScript
3
star
40

relevant-twitter

Twitter widget for the Relevant radiator
Ruby
3
star
41

boomstick

Boomstick tries to make it easier to explore Clojure and Datomic by generating an Ubuntu image containing a selection of Clojure editors, Datomic, and supporting software.
Shell
3
star
42

git-control

Git Control of Your Source (conference talk)
3
star
43

elzar

BAM!
Ruby
3
star
44

relevant-eventbrite-signups

Show event signups on Relevant
Ruby
3
star
45

jvm-shootout

JVM Shootout: Examples and presentation on various JVM languages
Clojure
3
star
46

relevant-widget

Base widget functionality for widgets
Ruby
3
star
47

relevant-github

View github feeds via Relevant
Ruby
3
star
48

rails-template

Build a Rails template for Relevance projects!
Ruby
3
star
49

relevance_portfolio_iteration_switcher

Simple switcher for navigating between iterations of projects in our portfolio.
Ruby
1
star
50

fluxion

Asynchronous metric collection, aggregation, and delivery
Clojure
1
star
51

slushy

Aussie kitchenhand helping in the provisional kitchen with Fog and Chef
Ruby
1
star
52

refactotum

Refactotum -- Presentation for RailsConf 2011 Refactotum Tutorial
1
star