shining 1.1.2 → 1.1.3

data/README.markdown

@@ -1,107 +1,8 @@
 # Shining
 
-A presentation framework to be used with Webkit. Yeah, it's all in-browser.
+A framework for creating in-browser presentations.
 
-# Installation
-
-    $ sudo gem install shining
-
-# How to use
-
-Create a new presentation by
-
-    $ shine mypreso
-    
-Where "mypreso" is the directory name you'll use for it. A base presentation has the
-following base structure.
-
-* ROOT
-  * config.json
-  * slides
-  * index.html
-  
-Which leads us to...
-
-# Configuration
-
-Presentation-wide configuration happens through the **config.json** file. Existing
-parameters are:
-
-* slides: an array containing the name of the presentation's slides. If you're using
-the generator to add slides, don't worry about editing it.
-* transitions: See next section.
-
-# Transitions
-
-Transitions take effect when you navigate back or forward your slides. Valid options are:
-
-* "fade": Fades slides out/in.
-* "slide": Slides them horizontally.
-* "slice": Cool horizontal slicing effect.
-* false: Setting to false disables transitions altogether.
-
-For anything not false, make sure you're passing a proper string.
-
-# Slides
-
-Easy way first. Change the directory to the presentation's directory first. Then
-
-    $ shine slide mynewslide
-    
-Where "mynewslide" is the name of the slide. This will create a slide in
-**ROOT/slides/mynewslide.html**, and a slide script in **ROOT/slides/mynewslide.js**.
-It will also automagically edit the **config.json** file for you, adding the new slide.
-
-You can also create slides manually by adding an HTML file to **ROOT/slides**, and then
-adding the file name (minus the extension) to **config.json**. Though really, just use 
-the generator.
-
-# Slide templates
-
-Shining supports Haml and ERb templates. For now, you can use it by manually dropping
-a template file or either of those formats in **ROOT/slides**, and then running (from
-inside the presentation's directory)
-
-    $ shine compile
-    
-Say you have a slide template named **ROOT/slides/test.haml**. Running the aforementioned
-command will generate a new **test.html** from it. Note that this will _overwrite_ an
-existing **test.html** slide if one exists.
-
-# Slide scripts
-
-Slides can have an associated script which you can use to trigger certain actions
-(e.g.: effects) at a predetermined time. If you used the generator to create a slide,
-you'll notice a .js file got created along with it. That's the script we're talking
-about. So for instance, say you have 2 hidden paragraphs in your slide, and you intent 
-to show one after another. Open that .js file and do
-
-    1, $('p:first').effect('fades-in')
-    3, $('p:eq(1)').effect('fades-in')
-    
-The above translates to: 1 second into this slide, fade in the first
-paragraph. 3 seconds in, fade in the second paragraph.
-
-This is handy if you want to schedule things you'd like to see happening at certain
-stages during a presentation.
-
-# Steps to winning
-
-Quickly outline of things I'm going to do with this project:
-
-* More effects, because there's no such thing as visually appealing enough. Some
-fine tuning of the existing ones is in order as well.
-* More themes.
-* Add a CSS parser, so I can build jQuery queues with the effects and order them
-without the end-user needing to make sure things happen when they expect.
-* Better generators. For now the requirements are simple enough so they can stay
-as a single file, but I'm confident that will change.
-* Better DSL for slide scripts. I know it's awesome already, but there's always
-room for improvement.
-* Macros, or configurable shortcuts for adding things like audio and video
-without having to know how to use the tags.
-* Did I say I wanna add macros, so you'll need to know next to zero HTML in order
-to create *really* awesome presentations?
+Please refer to the project webpage (http://shining.heroku.com) for docs.
 
 # License
 

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.1.3

data/lib/jquery.shining.js

@@ -123,7 +123,7 @@
       $(window).resize(function() { $('#stage').centralize() });
       loadConfig(function() {
         var startAt = document.location.hash.replace('#', '');
-        loadSlide(startAt ? startAt : $.shining.slides.current());
+        loadSlide(startAt ? startAt : $.shining.slides.current(), true);
         setTitle($.shining.config.title);
         setTheme($.shining.config.theme);
         parseEffects();
@@ -143,7 +143,9 @@
       if (!name) return false;
       applyTransition(
         function() { loadSlide(name) },
-        function() { $.shining.scripts.run($.shining.currentScript) }
+        function() {
+          $.shining.scripts.run($.shining.currentScript) 
+        }
       )
     }
 
@@ -167,7 +169,7 @@
       return $('script:first').attr('src').match(/^vendor/);
     }
 
-    function loadSlide(name) {
+    function loadSlide(name, runScript) {
       $('#stage .contents').load(
         slide(name).markup(),
         function(data) {
@@ -178,16 +180,17 @@
           $.shining.scripts.reap();
           updateControlAnchors();
           if (data) {
-            loadSlideScript(name);
+            loadSlideScript(name, runScript);
             loadSlideStyle(name);
           }
         }
       );
     }
 
-    function loadSlideScript(name) {
+    function loadSlideScript(name, run) {
       $.get(slide(name).script(), function(script) {
         $.shining.currentScript = script;
+        if (run) $.shining.scripts.run($.shining.currentScript);
       })
     }
 

data/shining.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shining}
-  s.version = "1.1.2"
+  s.version = "1.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julio Cesar Ody"]
-  s.date = %q{2010-04-08}
+  s.date = %q{2010-04-12}
   s.description = %q{Webkit + CSS + Javascript = awesome presos}
   s.email = %q{julio.ody@gmail.com}
   s.executables = ["console", "shine"]

data/spec/javascripts/unit/spec.helper.js

@@ -1,2 +1 @@
 JSpec.modules[0].utilities.mockRequest('config.json').and_return('{"transitions": false, "slides": ["welcome", "slide1", "slide2"]}');
-

data/spec/javascripts/unit/spec.js

@@ -1,7 +1,8 @@
 describe 'Shining'
   before_each
     window.$ = jQuery;
-    $.fn.offset = function() { return 0 };
+    $.fn.offset = function() { return 0 }
+    $.fn.centralize = function() { return false }
     if (!$('#hidden').length) {
       var hidden = $('<div id="hidden"></div>').css({height: 0, width: 0, opacity: 0, marginLeft: -10000}).appendTo('body');
       var stage = $($(fixture('index.html')).get(0)),
@@ -53,6 +54,6 @@ describe 'Shining'
       mockRequest().and_return('<h1>Slide2</h1>');
       $.shining.nextSlide();
       $('#stage .contents h1').text().should.be 'Slide2'
-    end
+    end    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shining
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors: 
 - Julio Cesar Ody
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 +10:00
+date: 2010-04-12 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency