Fork me on GitLab

How to create presentations with emacs-reveal

(Press ? for help, n and p for next and previous slide)

Jens Lechtenbörger (License Information)
April 2018

Introduction

What’s This?

  • Emacs-reveal is free software to generate reveal.js presentations (slides with audio) from simple text files in Org mode

    Presenter explaining technical sketch on board

    Image under CC0; converted from Pixabay

    • Benefits
    • For your audience
      • Self-contained presentations embedding audio
      • Usable on lots of (including mobile and offline) devices with just a browser
    • For you as producer
      • Separation of layout and contents
        • Similarly to, e.g., LaTeX
      • Simple text format allows diff and merge for ease of collaboration

Prerequisites

  • I suppose (and strongly recommend) that you use GNU/Linux (help on getting started)
    • Actually, not much here is operating system specific
  • Emacs-reveal should really be used with the text editor GNU Emacs
    • (You could try other editors and build presentations within GitLab, thanks to emacs-reveal’s GitLab infrastructure)
      • (In fact, you do not need an editor at all but could edit presentations using a Web browser on GitLab.com)

Installation

  1. Download software
    • Install emacs-reveal-howto
      • git clone https://gitlab.com/oer/emacs-reveal-howto.git
      • cd emacs-reveal-howto/
    • Install submodules
      • git submodule sync --recursive
      • git submodule update --init --recursive
  2. Install and configure Emacs packages
    • emacs --batch --load emacs-reveal/install.el --funcall install
    • Add a line like this to ~/.emacs
      • (load "/path/to/emacs-reveal/reveal-config.el")

Usage

Alternatives

  1. Create presentations locally on Command Line
  2. Create presentations in Emacs
  3. Create and publish presentations on GitLab

    GitLab Logo

    GitLab Logo by GitLab under CC BY-NC-SA 4.0; from gitlab.com

Build Presentations on Command Line

  1. Create Org file in directory emacs-reveal-howto/
    • See contained source file for this presentation, howto.org
  2. Build presentations for files ending in .org (except internal ones listed in elisp/publish.el)
    • emacs --batch --load elisp/publish.el --funcall org-publish-all
    • Presentations are built in subdirectory public/
  3. Open presentation in Firefox
    • E.g.: firefox public/howto.html
  4. Optional: Copy public/ to web server for public accessibility

Building Presentations in Emacs

  1. Generate HTML presentation for visited .org file using the usual Org export functionality:
    Press C-c C-e R B
    • This generates an HTML file in the same directory and opens it in your default browser
    • For this to work, necessary resources, in particular the reveal.js directory, must be accessible in the .org file’s directory

Build Presentations on GitLab

  1. Fork project on GitLab (fork documentation)
    • (Instead of forking, maybe use git clone as shown above; import that as new project on GitLab)
  2. Create project’s files locally
    • git clone <the URL of YOUR GitLab project>
  3. Create or update Org files in cloned directory, add, commit, and push (see next slide)
  4. GitLab infrastructure picks up changes and publishes presentations as GitLab Pages
    • Takes some minutes
    • Go to Settings → Pages to see the Pages’ address

On Git

Some Presentation Features

Text Slide

  • A list
  • With a sub-list whose items appear
    • This is emphasized
    • This is bold
    • This looks like code
    • This is green
    • Nothing special

Some Fragment Styles

  • Forget
  • Shrink
  • Grow
  • Very important

Fragments with Custom Order

  • I’m first.
  • Fourth.
  • Third
  • Second
  • I’m also first.

Centered Text

Just some horizontally centered text. Created by assigning a class with text-align: center.

On Sections

  • This slide is part of section Some Presentation Features
    • We can link to slides, e.g., the previous slide
      • You can use the browser history to go back
    • Side note: Check source code to see two variants of link targets used on this slide
  • This slide can also be perceived as its own subsection
  • (This list item appears simultaneously with previous bullet point)

Another Slide

  • This slide is on a deeper level of nesting
  • This level of nesting is not shown in the table of contents in the slide’s bottom
  • By the way, the headings in the table of contents below are hyperlinks
    • And your browser remembers the history, back/forward buttons and shortcuts should work
    • Mousewheel and swiping work

Two Columns: Pro/Con of emacs-reveal

Pro

  • Free/libre open source software
  • Device-independent presentations
    • Also mobile and offline
    • Generated from simple text format
      • Easy to learn
      • Collaboration with diff/merge/git
      • Separation of layout and content

Con

  • No WYSIWYG
  • (Need to learn something new)

Figures and Audio

Slide with Figure and Audio

Figure with Caption and License

  • Display image with meta-data specified in file
    • Simplify sharing of images with source and license
  • Functionality and meta-data format are specific to emacs-reveal
    • See next slide for sample file

Balance tipping in favor of Yes

To share or not to share

Image under CC0; converted from Pixabay

Meta-Data File for Previous Image

;; Semicolon starts comment until end of line (Emacs Lisp).
;; Note that the line for dc:title below is just a comment.  In that
;; case, "Image" is used as generic title; uncomment for real title.
;; CC0 does not require attribution of author/creator; uncomment if needed.

((filename . "./figures/3d-man/decision-1013751_1920.jpg") ; Note the path prefix
; (dc:title . "The title given by the author")
 (licenseurl . "https://creativecommons.org/publicdomain/zero/1.0/")
 (licensetext . "CC0")
; (cc:attributionName . "Jens Lechtenbörger")
; (cc:attributionURL . "https://gitlab.com/lechten")
 (dc:source . "https://pixabay.com/en/decision-question-response-1013751/")
 (sourcetext . "Pixabay")
 (imgalt . "Balance tipping in favor of Yes")
 (imgadapted . "converted from") ; Adjust as needed
 (texwidth . 0.5) ; Width in percent of textwidth for LaTeX export
)

An Image Grid: Computers

Server

Server under CC0; from Pixabay

C64

C64 under CC0; from Pixabay

Notebook

Notebook under CC0; from Pixabay

Router

Router under CC0; from Pixabay

Car

Car under CC0; from Pixabay

Doll

Doll under CC0; from Pixabay

TV

TV under CC0; from Pixabay

Smart watch

Smart watch under CC0; cropped from Pixabay

Fairphone 2

Fairphone 2 by Kaihsu Tai under CC BY-SA 4.0; cropped from Wikimedia

Creation of Previous Image Grid

  • Single line in source file, using macro revealgrid

    {{{revealgrid(42,"./figures/devices/computer.grid",60,4,3,"\"ga1 ga2 ga2 ga3\" \"ga1 ga4 ga5 ga6\" \"ga7 ga8 ga9 ga9\"")}}}
    
    • Arguments explained in emacs-reveal/config.el
    • With computer.grid as follows

      ("./figures/devices/white-male-1834091_1920.meta"
       "./figures/devices/commodore-160186_1280-CC0.meta"
       "./figures/devices/laptop-154091_1280.meta"
       "./figures/devices/router-157597_1280.meta"
       "./figures/devices/car-49278_960_720.meta"
       "./figures/devices/beauty-1260974_1920.meta"
       "./figures/devices/vintage-tv-1116587_960_720.meta"
       "./figures/devices/smartwatch-1874536_1280.meta"
       "./figures/devices/Fairphone_2_reverse.meta")
      

Appearing Items with Audio

(Audios produced with MaryTTS, converted to Ogg format with Audacity)

  • One
  • Two
  • Three

The End

Further Reading

Go for it!

Person taking steps to top

The road ahead …

Image under CC0; converted from Pixabay

https://gitlab.com/oer/

License Information

Except where otherwise noted, this work, “How to create presentations with emacs-reveal”, is © 2017, 2018 by Jens Lechtenbörger, published under the Creative Commons license CC BY-SA 4.0.

No warranties are given. The license may not give you all of the permissions necessary for your intended use.

In particular, trademark rights are not licensed under this license. Thus, rights concerning third party logos and other (trade-) marks (e.g., “Creative Commons” itself) remain with their respective holders.