Write simple presentations using pure data in CLJS
Clojure HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples/intro
resources/public
src/jobim
test/jobim
.gitignore
README.md
project.clj

README.md

jobim

Clojars Project

jobim is a ClojureScript library aimed allowing ClojureScript developers to rapidly create slideshows and presentations that compile down to Javascript, and can be easily hosted on a persons website. jobim takes advantage of ClojureScript's homoiconic nature to allow developers to execute, and write tests for code snippets included in their presentations. Additionally, jobim provides some limited support for code snippets written in other languages.

Getting Started

Getting a jobim project up and running is as simple as running lein new jobim-presentation YOURNAMEHERE. To see more detailed instructions on using the template, check out jobim-template.

If you do not wish to use the template, or if you are customizing or debugging, here are some of the things required to set up and run a jobim presentation. jobim requires that the html file in which you are including the generated Javascript file has an element named jobim. It also requires that you include some very basic css on the page.

body, pre{
    padding: 0px;
    margin: 0px;
}

Finally, it requires that you include highlight.js. You should include a tag for a stylesheet, and for the Javascript. Check one of the example projects below for a more specific example.

jobim uses a bit of code by Bruce Hauman to provide some nice testing utility. If you'd like to use it yourself, check out jobim-figwheel. If you're using the lein template, this is included by default.

Usage

The philosophy of this library is that most slideshows utilize very similar patterns, and do not need a high level of customizablity. On the other hand, jobim also provides the user with a simple protocol to extend, so that they can create their own slides.

Creating a Presentation

jobim allows the user to define a presentation using the defshow macro. This macro registers various listeners to keys, and renders a Reagent component on an element with the id "jobim". jobim is currently only meant to be used standalone on a page that is landscape. It will not render properly on pages resized to be portrait, or in an embedded environment, though this may change in the future.

The macro takes a show name, where it will store your show. After that, it takes Reagent style CSS map, where you can define some basic themes for your show. If you'd rather use a CSS file, you can feel free to leave this option as an empty map, however, I recommend checking out what the default style is like so that your presentation looks right. After the styles, the macro takes any number of slides.

Additionally, if you would like to use CSS, I recommend checking out the docstrings of the various helper functions that can be found in jobim.core, both the .clj and the .cljs versions of this namespace. They include CSS classes that you can target.

(ns example.core
  (:require [jobim.core :as jobim
             :refer-macros [defshow]]))

(defonce show-state (jobim/new-show))

(defshow show-name
  show-state
  jobim/default-style
  (jobim/title "Presentation Title" "Subtitle")
  (jobim/text  "Some Text"))

Basic Slides

jobim provides a large array of macros and constructors to cover commonly used slides. The below are the the slides that do not interface with code in any way. The only notable one is ->CustomSlide, which expects a Reagent style component, like [:div [:span "a"] [:button "hi"]]. Note that any field that is just a text field can also take a reagent style component, so you can easily make a title a link by doing [:a {:href "url"} "Title Text"].

(jobim/title title subtitle)
(jobim/text text)
(jobim/img url)
(jobim/captioned-img url caption)
(jobim/custom-slide reagent-component)
(jobim/bullets title & bullets)

When you want a slide with Clojure code on it, use the pseudo-clj and clojure-code macros. pseudo-clj is meant for code that will not run in any way. It is meant for incomplete examples, or for code that just shouldn't be run on the browser. If you're using jobim to write presentations about Java interop in Clojure, for example, you could not test that code in the browser. Stick that in psuedo-clj. Support for testing on the JVM not currently planned, but it might happen.

Code Slides

(psuedo-clj character-width code-form)
(pseudo-clj 40 (+ 1 2 3 4)) ;; an example

(defonce show-state (jobim/new-show))

(defshow show show-state default-style
  (psuedo-clj 40 (+ 1 2 3 4)))

clojure-code defines a ClojureCode slide. This macro evaluates your expressions, and stores them for you under the :env key. Calling (:env your-clojure-code-slide) will return a map where all the expressions are evaluated. For your convinience, you can use defclj as a replacement for (def slide (clojure-code ...)).

(defclj code-slide 40
  (+ 1 2)              ;; The result of the 0th expression is stored in the key :%0
  (def b 3)            ;; This expression has a name, so it is stored under :b
  (defn a [c] (+ c 1)) ;; This expression is stored in the key :a
  (a 10))              ;; This expression is stored in the key :%3

(get (:env code-slide) :%0)     ;; 3
(get (:env code-slide) :b)      ;; 3
((get (:env code-slide) :a) 5)  ;; 6
(get (:env code-slide) :%3)     ;; 11

Alternatively, use the env macro.

(env code-slide %0)     ;; 3
(env code-slide b)      ;; 3
((env code-slide a) 5)  ;; 6
(let [{:keys [%3]} (env code-slide)] %3)     ;; 11

This allows you to write tests against your presentation. To see an example of this, check the the examples/intro/test directory.

jobim uses highlight.js and fipp to pretty print and color your code automatically. Since we are using Clojure's homoiconic nature to run our code, we can't let you define your own whitespace (because Clojure ignores whitespace). If defining your own whitespace is super important to you, consider creating your own non-testable slides. Alternatively, consider using the code macro.

code* is a macro meant to be used to create short snippets in other languages. code* determines whitespace through checking vector nestedness. The more vectors code* finds around a form, the more whitespace it adds. It also adds a newline to every separate string it finds. This saves you from having to type in the whitespace and newlines yourself. Of course, you still CAN write it all as one string. The first argument to the macro is the highlight.js class associated with your language. As long as your highligh.js package supports the language you included, everything should work. Not all languages are included in highlight.js by default. If your language isn't working, try and create a custom package of highlight.js where your language is included.

(code*
  "javascript"
  "function test(){"
  ["console.log(\"This is a JS function\");"]
  "};")

(code*
  "python"
  "def test():"
  ["print \"Jobim can do Python too!\""])

Your Own Slides

To create your custom slides, make sure your slides implement the Slide protocol. A Slide has three functions, render-slide, next-slide, and prev-slide. render slide should return a Reagent data structure like [:div "hi"]. next-slide and prev-slide are functions that recieve that current state of the app, a hashmap, and can modify that state. For most slides, just calling the std-next or std-prev functions should be adequate. Both these functions increase the :page value in the state by one. Your functions are free to modify this state as you wish, and are responsible for any clean up. See the the jobim.protocols namespace for more details.

More Information

All Jobim non-impl namespaces are heavily documented. This means that all of the functions and macros that you will be working with are heavily documented in the namespaces where they exist. If you need specific advice on how to use Jobim, I highly recommend reading the jobim.core namespace, in both clj and cljs file formats.

Upcoming Work

  • Improve CSS styles to improve responsiveness.
  • Add some optional URL parsing to allow users to link directly to a slide.
  • Add support for phone gestures

License

Copyright © 2015 Salomao Becker

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.