reveal-ck 0.1.8 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2M2YWMyN2IyODhkYTljMmFhZmNiYmZhM2I5YjBhZTNhN2I2ZjE2Zg==
+    MzEyM2QwYjU3YTliMGZkYzJmYzdlMjUxNDI2NzA3ZmI0MjAyNzBjMw==
   data.tar.gz: !binary |-
-    YTQzNzBkODE4MjU3NjcyNWM5ZGU5MjEzYzE2NzZiODlmYTczNzQyMA==
+    NDQwNWUwYmI3YzUyMTA4NzAwMDg2YmEzYWIxYWM0M2E5YzQxMjYxNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjgwYzZiZGJlNGNkNmFiNWJiMzk2ZTA0MDhhY2NiYTA1NWFiN2ViNDI3ZDQ1
-    ZjRkYzJlNThjOTkzOWY2MjIwZTcwZDE3NmE1NWZlZTgxY2FjMThhNjExM2Iw
-    MGMwM2VjMmRiOTI4YTI2MTcwYWYwY2FlNDk4NDBlNmEwMDc1NWQ=
+    YWJmODY1YjNhNTZlZmNhMTZlMmY5YTA5M2JiMzFlZWE1ZGZlN2EyODMzZDU0
+    MDU3Y2NhNTBkYzk3NWJiNWFlZGZkNGQ5YTVlMTVkMjE3OTJmNzFlM2FlMmEw
+    NTE0ZjAwY2QzMjk4MDAyYzQ1N2U2MDZiYWY3NGI3ZTRmYWZkNWY=
   data.tar.gz: !binary |-
-    ZmY3MDc5MTNmZjRkY2ZmMTc5YmU1NzAwNzY2N2Y4Yzg3MDJiZjliNzE2NWI3
-    YjJlY2VlYjBmMDExNzg1YTdmYzUwZmZhZDU5OGEyYjNiNDY1MGZhMDM1YzFj
-    YTg2NGY3ODYyYzVhZTI3ODYwYjA5NDZhNGUyMjRiN2YyNjM4NzQ=
+    YjYzMWU5MWE1NjU5ZDZiMjlkYzJiNTM5ODQ2MmQ4OTFiOWIyYWQ4MDA4NGE1
+    ZGM5YmQ5NDIxOTBiMjQ4NjFhOTk4MzJjNDRmZGVhMjFmZTYxMDM5YWFhZDM0
+    ZmNiYjVmMmZiZTk1NzkyNTk4MmU4MTY5NDRlM2I0ZjAzMDEwMTA=

data/README.md

@@ -1,18 +1,10 @@
 # reveal-ck: Make Slides with Ruby
 
-[![Build Status][travis]](https://travis-ci.org/jedcn/reveal-ck)
-[![Code Climate][code-climate]](https://codeclimate.com/github/jedcn/reveal-ck)
-
-## Overview
-
 This project lets you author slides with a Ruby toolset.
 
-You write in Haml or slim or Ruby, and you can easily make [slides that
-look like this][reveal.js].
-
+You write in Haml or Slim or Ruby. The end result
+[looks like this][reveal.js].
 
-An introduction is available at http://jedcn.github.io/reveal-ck.
+Introduction available at http://jedcn.github.io/reveal-ck.
 
-[code-climate]: https://codeclimate.com/github/jedcn/reveal-ck.png
-[travis]:       https://travis-ci.org/jedcn/reveal-ck.png
 [reveal.js]:    http://lab.hakim.se/reveal-js

data/bin/reveal-ck

@@ -12,9 +12,11 @@ desc 'Generate reveal.js slides'
 command :generate do |c|
 
   # Where is the slides file?
-  default_file = 'slides.haml' if File.exists? 'slides.haml'
-  default_file = 'slides.slim' if File.exists? 'slides.slim'
-  default_file = 'slides.rb'   if File.exists? 'slides.rb'
+  default_file = 'slides.md'      if File.exists? 'slides.md'
+  default_file = 'slides.textile' if File.exists? 'slides.textile'
+  default_file = 'slides.haml'    if File.exists? 'slides.haml'
+  default_file = 'slides.slim'    if File.exists? 'slides.slim'
+  default_file = 'slides.rb'      if File.exists? 'slides.rb'
   c.desc 'The file containing your slides'
   c.flag [:f, :file], default_value: default_file
 
@@ -31,6 +33,8 @@ command :generate do |c|
     presentation
       .merge_config({ file: 'config.yml' }) if File.exists?('config.yml')
 
+    puts "Generating slides for '#{slides_file}'.."
+
     builder =
       RevealCK::Builders::PackagedSlides.new({
                                                image_files: image_files,
@@ -41,6 +45,37 @@ command :generate do |c|
   end
 end
 
+desc 'Start webserver so slides are available via http'
+command :serve, :server do |c|
+
+  c.desc 'The directory to serve up'
+  c.flag [:d, :dir], default_value: 'slides'
+
+  c.desc 'The port to serve on'
+  c.flag [:p, :port], default_value: 10000
+
+  c.action do |global_options, options, args|
+    dir = options[:dir]
+    port = options[:port]
+
+    require 'webrick'
+    server = WEBrick::HTTPServer.new :Port => port, :DocumentRoot => dir
+    trap('INT') { server.shutdown }
+
+    puts ""
+    puts ""
+    puts "\tServing up slide content in '#{dir}/'."
+    puts ""
+    puts "\tOpen your browser to 'http://localhost:#{port}'."
+    puts ""
+    puts "\tPress CTRL-C to stop serving slides."
+    puts ""
+    puts ""
+    server.start
+  end
+
+end
+
 pre do |global, command, options, args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the

data/lib/reveal-ck.rb

@@ -6,6 +6,8 @@ require_relative 'reveal-ck/presentation_dsl'
 require_relative 'reveal-ck/templates'
 require_relative 'reveal-ck/changers'
 require_relative 'reveal-ck/builders'
+require_relative 'reveal-ck/markdown'
+require_relative 'reveal-ck/tilt/config'
 
 # RevealCK::LOCATION is the path where reveal-ck is residing on your
 # system as a gem.

data/lib/reveal-ck/markdown.rb

@@ -0,0 +1,2 @@
+require_relative 'markdown/slide_markdown'
+require_relative 'markdown/slide_markdown_template'

data/lib/reveal-ck/markdown/slide_markdown.rb

@@ -0,0 +1,22 @@
+require 'redcarpet'
+
+module RevealCK
+  module Markdown
+    class SlideMarkdown < Redcarpet::Render::HTML
+
+      HR = '<hr>'
+      HR_NEWLINE = "<hr>\n"
+
+      SLIDE_START = '<section>'
+      SLIDE_END = '</section>'
+      SLIDE_DIVIDER = "#{SLIDE_END}\n#{SLIDE_START}"
+
+      def postprocess(doc)
+        doc = doc[HR.size, doc.size-1] if doc.start_with?(HR)
+        doc = doc[0, doc.size-1-HR_NEWLINE.size] if doc.end_with?(HR_NEWLINE)
+        doc = doc.gsub(HR, SLIDE_DIVIDER)
+        "#{SLIDE_START}\n#{doc}\n#{SLIDE_END}"
+      end
+    end
+  end
+end

data/lib/reveal-ck/markdown/slide_markdown_template.rb

@@ -0,0 +1,22 @@
+require 'tilt/template'
+
+module RevealCK
+  module Markdown
+    #
+    # Public: This class allows SlideMarkdown to hook into Tilt 2.0. See
+    # https://github.com/rtomayko/tilt.
+    #
+    class SlideMarkdownTemplate < ::Tilt::Template
+
+      # Must be implemented by all subclasses of Tilt::Template
+      def prepare
+      end
+
+      def evaluate(scope, locals, &block)
+        markdown = Redcarpet::Markdown.new(SlideMarkdown, :fenced_code_blocks => true)
+        @output = markdown.render(data)
+      end
+
+    end
+  end
+end

data/lib/reveal-ck/tilt/config.rb

@@ -0,0 +1,2 @@
+# Direct Tilt to use SlideMarkdownTemplate for "md" files
+Tilt.register RevealCK::Markdown::SlideMarkdownTemplate, 'md'

data/lib/reveal-ck/version.rb

@@ -1,3 +1,3 @@
 module RevealCK
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

data/reveal.js/Gruntfile.js

@@ -15,7 +15,6 @@ module.exports = function(grunt) {
 				' */'
 		},
 
-		// Tests will be added soon
 		qunit: {
 			files: [ 'test/*.html' ]
 		},
@@ -48,7 +47,8 @@ module.exports = function(grunt) {
 					'css/theme/simple.css': 'css/theme/source/simple.scss',
 					'css/theme/sky.css': 'css/theme/source/sky.scss',
 					'css/theme/moon.css': 'css/theme/source/moon.scss',
-					'css/theme/solarized.css': 'css/theme/source/solarized.scss'
+					'css/theme/solarized.css': 'css/theme/source/solarized.scss',
+					'css/theme/blood.css': 'css/theme/source/blood.scss'
 				}
 			}
 		},
@@ -69,7 +69,8 @@ module.exports = function(grunt) {
 				globals: {
 					head: false,
 					module: false,
-					console: false
+					console: false,
+					unescape: false
 				}
 			},
 			files: [ 'Gruntfile.js', 'js/reveal.js' ]

data/reveal.js/README.md

@@ -11,7 +11,7 @@ reveal.js comes with a broad range of features including [nested slides](https:/
 - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
 - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
 
-## Slides
+## Online Editor
 
 Presentations are written using HTML or markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [http://slid.es](http://slid.es).
 
@@ -54,10 +54,44 @@ This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Iri
 
 You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file.
 
+When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
+
 ```html
-<section data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n" data-notes="^Note:" data-charset="iso-8859-15"></section>
+<section data-markdown="example.md"  
+         data-separator="^\n\n\n"  
+         data-vertical="^\n\n"  
+         data-notes="^Note:"  
+         data-charset="iso-8859-15">
+</section>
 ```
 
+#### Element Attributes
+
+Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
+
+```html
+<section data-markdown>
+	<script type="text/template">
+		- Item 1 <!-- .element: class="fragment" data-fragment-index="2" -->
+		- Item 2 <!-- .element: class="fragment" data-fragment-index="1" -->
+	</script>
+</section>
+```
+
+#### Slide Attributes
+
+Special syntax (in html comment) is available for adding attributes to the slide `<section>` elements generated by your Markdown.
+
+```html
+<section data-markdown>
+	<script type="text/template">
+	<!-- .slide: data-background="#ff0000" -->
+		Mardown content
+	</script>
+</section>
+```
+
+
 ### Configuration
 
 At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
@@ -71,43 +105,72 @@ Reveal.initialize({
 	// Display a presentation progress bar
 	progress: true,
 
+	// Display the page number of the current slide
+	slideNumber: false,
+
 	// Push each slide change to the browser history
 	history: false,
 
 	// Enable keyboard shortcuts for navigation
 	keyboard: true,
 
-	// Enable touch events for navigation
-	touch: true,
-
 	// Enable the slide overview mode
 	overview: true,
 
 	// Vertical centering 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,
+
+	// Flags if the presentation is running in an embedded mode,
+	// i.e. contained within a limited portion of the screen
+	embedded: false,
+
 	// 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
 	autoSlide: 0,
 
+	// Stop auto-sliding after user input
+	autoSlideStoppable: true,
+
 	// Enable slide navigation via mouse wheel
 	mouseWheel: false,
 
+	// Hides the address bar on mobile devices
+	hideAddressBar: true,
+
+	// Opens links in an iframe preview overlay
+	previewLinks: false,
+
 	// Transition style
 	transition: 'default', // default/cube/page/concave/zoom/linear/fade/none
 
 	// Transition speed
 	transitionSpeed: 'default', // default/fast/slow
 
-	// Transition style for full page backgrounds
-	backgroundTransition: 'default' // default/linear/none
+	// Transition style for full page slide backgrounds
+	backgroundTransition: 'default', // default/none/slide/concave/convex/zoom
+
+	// Number of slides away from the current that are visible
+	viewDistance: 3,
+
+	// Parallax background image
+	parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
+
+	// Parallax background size
+	parallaxBackgroundSize: '' // CSS syntax, e.g. "2100px 900px"
+
 
 });
 ```
@@ -192,6 +255,27 @@ Reveal.initialize({
 });
 ```
 
+
+### Auto-sliding
+
+Presentations can be configure to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides:
+
+```javascript
+// Slide every five seconds
+Reveal.configure({
+  autoSlide: 5000
+});
+```
+
+When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Sliding is also paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
+
+You can also override the slide duration for individual slides by using the ```data-autoslide``` attribute on individual sections:
+
+```html
+<section data-autoslide="10000">This will remain on screen for 10 seconds</section>
+```
+
+
 ### Keyboard Bindings
 
 If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option:
@@ -292,6 +376,29 @@ Slides are contained within a limited portion of the screen by default to allow
 Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'slide'``` to the ```Reveal.initialize()``` call. Alternatively you can set ```data-background-transition``` on any section with a background to override that specific transition.
 
 
+### Parallax Background
+
+If you want to use a parallax scrolling background, set the two following config properties when initializing reveal.js (the third one is optional).
+
+```javascript
+Reveal.initialize({
+
+	// Parallax background image
+	parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg"
+
+	// Parallax background size
+	parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
+
+	// This slide transition gives best results:
+	transition: linear
+
+});
+```
+
+Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://lab.hakim.se/reveal-js/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg&parallaxBackgroundSize=2100px%20900px).
+
+
+
 ### Slide Transitions
 The global presentation transition is set using the ```transition``` config value. You can override the global transition for a specific slide by using the ```data-transition``` attribute:
 
@@ -330,7 +437,7 @@ You can also add relative navigation links, similar to the built in reveal.js co
 
 
 ### Fragments
-Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/16
+Fragments are used to highlight individual elements on a slide. Every element with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/fragments
 
 The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:
 
@@ -340,6 +447,8 @@ The default fragment style is to start out invisible and fade in. This style can
 	<p class="fragment shrink">shrink</p>
 	<p class="fragment roll-in">roll-in</p>
 	<p class="fragment fade-out">fade-out</p>
+	<p class="fragment current-visible">visible only once</p>
+	<p class="fragment highlight-current-blue">blue only once</p>
 	<p class="fragment highlight-red">highlight-red</p>
 	<p class="fragment highlight-green">highlight-green</p>
 	<p class="fragment highlight-blue">highlight-blue</p>
@@ -397,6 +506,13 @@ By default, Reveal is configured with [highlight.js](http://softwaremaniacs.org/
 </section>
 ```
 
+### Slide number
+If you would like to display the page number of the current slide you can do so using the ```slideNumber``` configuration value.
+
+```javascript
+Reveal.configure({ slideNumber: true });
+```
+
 
 ### Overview mode
 
@@ -424,6 +540,8 @@ Add `data-autoplay` to your media element if you want it to automatically start
 <video data-autoplay src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
 ```
 
+Additionally the framework automatically pushes two [post messages](https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage) to all iframes, ```slide:start``` when the slide containing the iframe is made visible and ```slide:stop``` when it is hidden.
+
 
 ### Stretching elements
 Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide. This can be done by adding the ```.stretch``` class to an element as seen below:
@@ -464,6 +582,7 @@ The framework comes with a few different themes included:
 - night: Black background, thick white text, orange links
 - serif: Cappuccino background, gray text, brown links
 - simple: White background, black text, blue links
+- solarized: Cream-colored background, dark green text, blue links
 
 Each theme is available as a separate stylesheet. To change theme you will need to replace **default** below with your desired theme name in index.html:
 
@@ -480,6 +599,8 @@ reveal.js comes with a speaker notes plugin which can be used to present per-sli
 
 Notes are defined by appending an ```<aside>``` element to a slide as seen below. You can add the ```data-markdown``` attribute to the aside element if you prefer writing notes using Markdown.
 
+When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup).
+
 ```html
 <section>
 	<h2>Some Slide</h2>
@@ -750,29 +871,29 @@ The core of reveal.js is very easy to install. You'll simply need to download a
 
 ### Full setup
 
-Some reveal.js features, like external markdown, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
+Some reveal.js features, like external markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
 
 1. Install [Node.js](http://nodejs.org/)
 
 2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
 
 4. Clone the reveal.js repository
-```
+```sh
 $ git clone https://github.com/hakimel/reveal.js.git
 ```
 
 5. Navigate to the reveal.js folder
-```
+```sh
 $ cd reveal.js
 ```
 
 6. Install dependencies
-```
+```sh
 $ npm install
 ```
 
 7. Serve the presentation and monitor source files for changes
-```
+```sh
 $ grunt serve
 ```
 
@@ -802,6 +923,7 @@ If you have personal support questions use [StackOverflow](http://stackoverflow.
   - Single-quoted strings
 - Should be made towards the **dev branch**
 - Should be submitted from a feature/topic branch (not your master)
+- Should not include the minified **reveal.min.js** file
 
 
 ## License