reveal.js style presentation theme for Sphinx.

|travis| |coveralls| |downloads| |version| |license|


Output Sample
=============
:output: http://packages.python.org/sphinxjp.themes.revealjs/
:source: http://packages.python.org/sphinxjp.themes.revealjs/_sources/index.txt


Features
========
* provide ``revealjs`` directive for reveal.js presetation slide control.
* provide ``revealjs`` theme for render presetation.


Set up
======
Make environment with pip::

    $ pip install sphinxjp.themes.revealjs

Make environment with easy_install::

    $ easy_install sphinxjp.themes.revealjs


Convert Usage
=============
setup conf.py with::

    extensions = ['sphinxjp.themes.revealjs']
    html_theme = 'revealjs'
    html_use_index = False

and run::

    $ make html

Writing Custom Directives
=============================

revealjs
--------------------

This directive crate a slide section for reveal.js.

::

  .. revealjs:: Heads Up

   reveal.js is a framework for easily creating beautiful presentations using HTML.
   You'll need a browser with support for CSS 3D transforms to see it in its full glory.


Slides can be nested inside of other slides,

::

  .. revealjs::

   .. revealjs:: Vertical Slide1

    vertical slide1

   .. revealjs:: Vertical Slide2

    vertical slide2

   .. revealjs:: Vertical Slide3

    vertical slide3

You can set various directive options.


class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Set 'class' attribute to 'section' tag.

::

  .. revealjs:: Slide Title
     :class: spam


noheading
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It does not display the title heading.

::

  .. revealjs:: Slide Title
     :noheading:

title-heading
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can change the size of the title tag. h1〜h2

::

  .. revealjs:: Slide Title
     :title-heading: h3


subtitle
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can set subtitle text.

::

  .. revealjs:: Slide Title
     :subtitle:: Subtitle Text


subtitle-heading
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can change the size of the subtitle tag. h1〜h2

::

  .. revealjs:: Slide Title
     :subtitle: Subtitle Text
     :subtitle-heading: h4

data-autoslide
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Number of milliseconds between automatically proceeding to the next slide

::

  .. revealjs:: Slide Title
     :data-autoslide: 4000


data-markdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can write in Markdown syntax to use the data-markdown option.

::

  .. revealjs:: Slide Title
     :data-markdown:

     ## Page title

     A paragraph with some text and a [link](http://hakim.se).

You can read the external Markdown.


::

  .. revealjs:: External Markdown
     :data-markdown: _static/external.md
     :data-separator: ^\n\n\n
     :data-vertical: ^\n\n
     :data-notes: ^Note:


data-transition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Change transition style by the following pattern.

* default
* cube
* page
* concave
* zoom
* linear
* fade
* none

::

  .. revealjs:: Slide Title
     :data-transition: zoom


data-transition-speed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Change transition speed by the following pattern.

* default
* fast
* slow

::

  .. revealjs:: Slide Title
     :data-transition-speed: fast


data-background
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Change background settings.

::

  .. revealjs:: Slide Title
     :data-background: "http://example.com/image.png"
     :data-background-size: 100px
     :data-background-repeat: repeat
     :data-background-transition: page


data-state
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you set data-state on a slide, "somestate" will be applied as a class on the document element when that slide is opened.
This allows you to apply broad style changes to the page based on the active slide.

::

  .. revealjs:: Slide Title
     :data-state: somestate

Furthermore you can also listen to these changes in state via JavaScript

::

  Reveal.addEventListener('somestate', function() {
      // TODO: Sprinkle magic
  }, false );


rv_code
---------------------

::

 .. revealjs:: Pretty Code

  .. rv_code::

   function linkify( selector ) {
     if( supports3DTransforms ) {

       var nodes = document.querySelectorAll( selector );

       for( var i = 0, len = nodes.length; i &lt; len; i++ ) {
         var node = nodes[i];

         if( !node.className ) ) {
           node.className += ' roll';
         }
       };
     }
   }


rv_small
---------------------

This directive can be used when writing the text smaller.

::

 .. revealjs:: rv_small smaple

  .. rv_small::

   Created by `tell-k <http://github.com/tell-k>`_ / `@tell-k <http://twitter.com/tell_k>`_

rv_note
---------------------

This directive can be used when creating some notes for presenter. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard).

::

 .. revealjs:: Heads Up

  reveal.js is a framework for easily creating beautiful presentations using HTML. You'll need a browser with support for CSS 3D transforms to see it in its full glory.

  .. rv_note::

   Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard).

Customize Config
=============================

By changing html_theme_options, you can change the settings for the whole.

::

  html_theme_options = {

   # Set the lang attribute of the html tag. Defaults to "ja"
   "lang": "ja",

   # The "normal" size of the presentation, aspect ratio will be preserved
   # when the presentation is scaled to fit different resolutions
   "width": 960,
   "height": 700,

   # Factor of the display size that should remain empty around the content
   "margin": 0.1,

   # Bounds for smallest/largest possible scale to apply to content
   "min_scale": 0.2,
   "max_scale": 1.0,

   # Display controls in the bottom right corner
   "controls": True,

   # Display a presentation progress bar
   "progress": True,

   # Push each slide change to the browser history
   "history": True,

   # Enable keyboard shortcuts for navigation
   "keyboard": True,

   # Enable the slide overview mode
   "overview": True,

   # Vertical centring of slides
   "center": True,

   # Enables touch navigation on devices with touch input
   "touch": True,

   # Loop the presentation
   "loop": False,

   # Change the presentation direction to be RTL
   "rtl": False,

   # Turns fragments on and off globally
   "fragments": True,

   # Number of milliseconds between automatically proceeding to the
   # next slide, disabled when set to 0, this value can be overwritten
   # by using a data-autoslide attribute on your slides
   "auto_slide": 0,

   # Enable slide navigation via mouse wheel
   "mouse_wheel": False,

   # Apply a 3D roll to links on hover
   "rolling_links": True,

   # Opens links in an iframe preview overlay
   "preview_links": False,

   # Theme (default/blood/beige/moon/night/serif/simple/sky/solarized)
   "theme": "blood",

   # Transition style (default/cube/page/concave/zoom/linear/fade/none)
   "transition": "default",

   # Transition speed (default/fast/slow)
   "transition_speed": "default",

   # Transition style for full page slide backgrounds (default/linear)
   "background_transition": "default",

   # Display the page number of the current slide
   "slide_number": False,

   # Flags if the presentation is running in an embedded mode,
   # i.e. contained within a limited portion of the screen
   "embedded": False,

   # Stop auto-sliding after user input
   "auto_slide_stoppable": True,

   # Hides the address bar on mobile devices
   "hide_address_bar": True,

   # Parallax background image
   # CSS syntax, e.g. "a.jpg"
   "parallax_background_image": 'a.jpg',

   # Parallax background size
   # CSS syntax, e.g. "3000px 2000px"
   "parallax_background_size": '3000px 2000px',

   # Focuses body when page changes visibility to ensure keyboard shortcuts work
   "focus_body_on_page_visibility_change": True,

   # Number of slides away from the current that are visible
   "view_distance": 3,

   # Enable plguin javascript for reveal.js
   "plugin_list": [
     "_static/plugin/leap/leap.js",
     "_static/plugin/multiplex/master.js",
     "_static/plugin/search/search.js",
     "_static/plugin/remotes/remotes.js"
     "_static/plugin/notes-server/client.js",
   ],

  }

Multiplexing
--------------------

https://github.com/hakimel/reveal.js#multiplexing

::

 html_theme_options = {

  "multiplex": {
      "secret": None, # null so the clients do not have control of the master presentation
      "id": '1ea875674b17ca76', # id, obtained from socket.io server
      "url": 'example.com:80' # Location of your socket.io server
  },

  "plugin_list": [
    "//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js",
    "_static/plugin/multiplex/master.js",

    # and if you want speaker notes
    "_static/plugin/notes-server/client.js",
  ],

 }

Leap Motion
--------------------

https://github.com/hakimel/reveal.js#leap-motion

::

 html_theme_options = {

  "leap": {
     "autoCenter": True,
     "gestureDelay": 500,
     "naturalSwipe": False,
     "pointerOpacity": 0.5,
     "pointerColor": '#d80000',
     "pointerSize": 15,
     "pointerTolerance": 120,
  },

  "plugin_list": [
    "_static/plugin/leap/leap.js",
  ],

 }

MathJax
--------------------

https://github.com/hakimel/reveal.js#mathjax

::

 html_theme_options = {

  "math": {
      "mathjax": 'http://cdn.mathjax.org/mathjax/latest/MathJax.js',
      # See http://docs.mathjax.org/en/latest/config-files.html
      "config": 'TeX-AMS_HTML-full'
  },

  "plugin_list": [
    "_static/plugin/math/math.js",
  ],

 }


Setting with  Javascript
--------------------------

It is also possible to change the settings by using the Javascript.

1. create 'mysettings.js'.

  ::

   // Turn autoSlide off
   Reveal.configure({ autoSlide: 0 });

2. change conf.py

  ::

   html_static_path = ['_static']

   html_theme_options = {
    # loading custom js after RevealJs.initialize.
    "customjs": "mysettings.js",
   }


Requirement
=============
* Python 2.6, 2.7, 3.3, 3.4, or later
* Sphinx 1.2.x or later.

Using
=============
* `Reveal.js 2.6.2 <http://lab.hakim.se/reveal-js/#/>`_
* `jQuery 1.11.2 <http://jquery.com/>`_

License
=======

* sphinxjp.themes.revealjs Licensed under the `MIT license <http://www.opensource.org/licenses/mit-license.php>`_ .
* `reveal.js is licensed under the MIT licence <https://github.com/hakimel/reveal.js/blob/master/LICENSE>`_.

See the LICENSE file for specific terms.

.. |travis| image:: https://travis-ci.org/tell-k/sphinxjp.themes.revealjs.svg?branch=master
    :target: https://travis-ci.org/tell-k/sphinxjp.themes.revealjs


.. |coveralls| image:: https://coveralls.io/repos/tell-k/sphinxjp.themes.revealjs/badge.png
    :target: https://coveralls.io/r/tell-k/sphinxjp.themes.revealjs/
    :alt: coveralls.io

.. |downloads| image:: https://pypip.in/d/sphinxjp.themes.revealjs/badge.png
    :target: http://pypi.python.org/pypi/sphinxjp.themes.revealjs/
    :alt: downloads

.. |version| image:: https://pypip.in/v/sphinxjp.themes.revealjs/badge.png
    :target: http://pypi.python.org/pypi/sphinxjp.themes.revealjs/
    :alt: latest version

.. |license| image:: https://pypip.in/license/sphinxjp.themes.revealjs/badge.png
    :target: http://pypi.python.org/pypi/sphinxjp.themes.revealjs/
    :alt: license

AUTHORS
=======

Sphinx template, css, packaging
-------------------------------
* tell-k <ffk2005 at gmail.com>

History
=======

0.3.0(May 5, 2015)
---------------------
* Upgrade Reveal.js version to 3.0.0

0.2.3(Jan 1, 2015)
---------------------
* Exclude test code from installed packages

0.2.2 (Dec 31, 2014)
---------------------
* Drop Python-3.2 support #3
* Remove bootstrap.py and buildout.cfg.
* Support wheel format.
* Change test runner(nose -> py.test).

0.2.1 (Sep 20, 2014)
---------------------
* Fixed bug. "default theme.conf can't work.#1"

0.2.0 (Jun 8, 2014)
---------------------
* Upgrade Reveal.js version to 2.6.2
* Upgrade JQuery version to v1.11.1
* Improved unittest.
* Enrich the document.

0.1.1 (Jan 1, 2014)
---------------------
* Add html_theme_options['plugin_list'].
* Add tox test.
* Python3 support.

0.1.0 (Aug 25, 2013)
---------------------
* First release


