sideshow 0.4.1 → 0.4.2

data/docs/classes/VisualItem.html

@@ -130,7 +130,7 @@
 
     
         <div class="foundat">
-            Defined in: <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l412"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:412</code></a>
+            Defined in: <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l424"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:424</code></a>
         </div>
     
 
@@ -232,7 +232,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l446"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:446</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l458"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:458</code></a>
         
         </p>
 
@@ -287,7 +287,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l436"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:436</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l448"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:448</code></a>
         
         </p>
 

data/docs/classes/Wizard.html

@@ -130,7 +130,7 @@
 
     
         <div class="foundat">
-            Defined in: <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l542"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:542</code></a>
+            Defined in: <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l554"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:554</code></a>
         </div>
     
 
@@ -291,7 +291,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l839"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:839</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l851"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:851</code></a>
         
         </p>
 
@@ -380,7 +380,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l824"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:824</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l836"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:836</code></a>
         
         </p>
 
@@ -463,7 +463,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l884"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:884</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l896"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:896</code></a>
         
         </p>
 
@@ -536,7 +536,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l849"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:849</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l861"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:861</code></a>
         
         </p>
 
@@ -615,7 +615,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l793"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:793</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l805"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:805</code></a>
         
         </p>
 
@@ -694,7 +694,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l659"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:659</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l671"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:671</code></a>
         
         </p>
 
@@ -749,7 +749,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l896"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:896</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l908"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:908</code></a>
         
         </p>
 
@@ -820,7 +820,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l703"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:703</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l715"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:715</code></a>
         
         </p>
 
@@ -915,7 +915,7 @@
             
         
         
-        <a href="../files/c:_Fortes_Projetos_SideshowNew_distr_sideshow.js.html#l650"><code>c:\Fortes\Projetos\SideshowNew\distr\sideshow.js:650</code></a>
+        <a href="../files/c:_alcides_fortes_projetos_Sideshow_distr_sideshow.js.html#l662"><code>c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:662</code></a>
         
         </p>
 

data/example.html

@@ -1,81 +1,81 @@
 <!DOCTYPE html>
 <html>
 <head>
-	<meta charset="utf-8">
-	<title>Sideshow Interactive Help Example</title>
+    <meta charset="utf-8">
+    <title>Sideshow Interactive Help Example</title>
     <link rel="stylesheet" href="distr/fonts/sideshow-fontface.min.css">
-	<link rel="stylesheet" href="distr/stylesheets/sideshow.min.css">
-	<link rel="stylesheet" href="examples/stylesheets/example.min.css">
+    <link rel="stylesheet" href="distr/stylesheets/sideshow.min.css">
+    <link rel="stylesheet" href="examples/stylesheets/example.min.css">
 </head>
 <body>
     <!--[if lt IE 10]>
         <p class="browsehappy">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</p>
     <![endif]-->
     <header>
-    	<div id="header_content" class="main-content">
-    		<img src="examples/images/sideshow-logo.png">
-    		<button id="run_example">Run Example</button>
-    		<div id="introducing_sideshow">
-    			Sideshow is a powerful javascript library which aims to <em>reduce your user's learning curve</em> by providing a way to create <em>step-by-step interactive helps</em>. Explain the features of your application, control your end-user's interaction with your UI, emphasize what you're explaining in each step by masking it. 
-    			<br><!-- <<< Here, you can see a well applied br!! \o/ -->
-    			<em>Just think! The sky is the limit!</em>
-    		</div>
-    	</div>
-	</header>
-	<div id="wrapper" class="main-content">
-    	<div id="bttf">
-    		<h1>Keep Calm and Generate 1.21 Gigawatts</h1>
+        <div id="header_content" class="main-content">
+           <img src="examples/images/sideshow-logo.png">
+           <button id="run_example">Run Example</button>
+           <div id="introducing_sideshow">
+             Sideshow is a powerful javascript library which aims to <em>reduce your user's learning curve</em> by providing a way to create <em>step-by-step interactive helps</em>. Explain the features of your application, control your end-user's interaction with your UI, emphasize what you're explaining in each step by masking it. 
+             <br><!-- <<< Here, you can see a well applied br!! \o/ -->
+             <em>Just think! The sky is the limit!</em>
+           </div>
+        </div>
+    </header>
+    <div id="wrapper" class="main-content">
+        <div id="bttf">
+           <h1>Keep Calm and Generate 1.21 Gigawatts</h1>
             <figure>
                 <img src="examples/images/doc_brown.png" id="dr_brown" draggable="true">
             </figure>
-    		Bacon ipsum dolor sit amet biltong shankle flank ball tip drumstick jerky beef ribs tri-tip chicken boudin sausage. Turducken biltong meatball, doner pork beef tongue ground round drumstick kevin pork loin landjaeger pork belly andouille turkey. Jowl ground round ribeye capicola kielbasa, shoulder leberkas. Pork belly leberkas meatball, ribeye ball tip rump ham pig spare ribs ground round biltong capicola pork chop bresaola strip steak. Doner biltong tongue rump prosciutto venison sirloin ground round flank meatloaf pork loin shankle.
-    	</div>
-    	<div id="survey">
-    		<h1>A Form Example</h1>
-    		<fieldset>
-    			<ul>
-    				<li><label for="first_name">First Name</label><input type="text" id="first_name">
-    				<li><label for="last_name">Last Name</label><input type="text" id="last_name">
-    				<li><label for="email">E-mail</label><input type="text" id="email">
-    				<li><button>Do Nothing! =)</button>
-    			</ul>
-    		</fieldset>
-    	</div>
+           Bacon ipsum dolor sit amet biltong shankle flank ball tip drumstick jerky beef ribs tri-tip chicken boudin sausage. Turducken biltong meatball, doner pork beef tongue ground round drumstick kevin pork loin landjaeger pork belly andouille turkey. Jowl ground round ribeye capicola kielbasa, shoulder leberkas. Pork belly leberkas meatball, ribeye ball tip rump ham pig spare ribs ground round biltong capicola pork chop bresaola strip steak. Doner biltong tongue rump prosciutto venison sirloin ground round flank meatloaf pork loin shankle.
+        </div>
+        <div id="survey">
+           <h1>A Form Example</h1>
+           <fieldset>
+             <ul>
+              <li><label for="first_name">First Name</label><input type="text" id="first_name">
+              <li><label for="last_name">Last Name</label><input type="text" id="last_name">
+              <li><label for="email">E-mail</label><input type="text" id="email">
+              <li><button>Do Nothing! =)</button>
+             </ul>
+           </fieldset>
+        </div>
         <div id="red_square"></div>
-    	<hr>
-    	<div id="godfather1">
-    		<h1>Leave the Gun. Take the Cannoli.</h1>
-    		<img src="examples/images/clemenza.jpg">
-    		<div class="columns-text">
-	    		<p>
-	    			Swine hamburger flank drumstick, beef capicola tongue landjaeger. Andouille shankle turkey corned beef, ribeye meatball tri-tip t-bone pancetta. Pork tenderloin t-bone turducken tongue biltong shoulder corned beef. Pork loin bacon fatback kielbasa, tail venison tongue flank swine pancetta beef ribs pork chop boudin ground round doner.
-	    		</p>
-	    		<p>
-					Rump shankle short loin corned beef t-bone ham hock. Kevin ground round swine chuck jowl salami ham shankle fatback landjaeger beef shank. Sirloin prosciutto beef sausage flank. Shankle spare ribs tail pork loin shoulder hamburger bresaola filet mignon biltong. 
-				</p>
-			</div>
-    	</div>
-	</div>
-	<a href="https://github.com/fortesinformatica/sideshow">
-		<img class="forkme" src="examples/images/forkme.png" alt="Fork me on GitHub">
-	</a>
-	<footer>
-		Sideshow is available under <a href="https://raw2.github.com/fortesinformatica/sideshow/master/LICENSE">Apache License 2.0</a>. Copyright 2013-2014 <a href="http://www.twitter.com/alcidesqueiroz" target="_blank"> Alcides Queiroz</a>.
-	</footer>
+        <hr>
+        <div id="godfather1">
+           <h1>Leave the Gun. Take the Cannoli.</h1>
+           <img src="examples/images/clemenza.jpg">
+           <div class="columns-text">
+             <p>
+              Swine hamburger flank drumstick, beef capicola tongue landjaeger. Andouille shankle turkey corned beef, ribeye meatball tri-tip t-bone pancetta. Pork tenderloin t-bone turducken tongue biltong shoulder corned beef. Pork loin bacon fatback kielbasa, tail venison tongue flank swine pancetta beef ribs pork chop boudin ground round doner.
+             </p>
+             <p>
+              Rump shankle short loin corned beef t-bone ham hock. Kevin ground round swine chuck jowl salami ham shankle fatback landjaeger beef shank. Sirloin prosciutto beef sausage flank. Shankle spare ribs tail pork loin shoulder hamburger bresaola filet mignon biltong. 
+          </p>
+         </div>
+        </div>
+    </div>
+    <a href="https://github.com/fortesinformatica/sideshow">
+       <img class="forkme" src="examples/images/forkme.png" alt="Fork me on GitHub">
+    </a>
+    <footer>
+       Sideshow is available under <a href="https://raw2.github.com/fortesinformatica/sideshow/master/LICENSE">Apache License 2.0</a>. Copyright 2013-2014 <a href="http://www.twitter.com/alcidesqueiroz" target="_blank"> Alcides Queiroz</a>.
+    </footer>
     <!--Scripts required for Sideshow to work properly-->
-	<script src="distr/dependencies/jquery.min.js"></script>
-	<script src="distr/dependencies/jazz.min.js"></script>
-	<script src="distr/dependencies/pagedown.min.js"></script>
-	<script src="distr/sideshow.js"></script>
+    <script src="distr/dependencies/jquery.min.js"></script>
+    <script src="distr/dependencies/jazz.min.js"></script>
+    <script src="distr/dependencies/pagedown.min.js"></script>
+    <script src="distr/sideshow.js"></script>
 
     <!--Scripts for this page-->
-	<script src="examples/scripts/sideshow.config.js"></script>
+    <script src="examples/scripts/sideshow.config.js"></script>
     <script src="examples/scripts/tutorials/introducing_sideshow.js"></script>
-	<script src="http://localhost:35729/livereload.js?snipver=1"></script>
-	<script>
-		$("#run_example").click(function(){
-			Sideshow.start({ listAll: true });
-		});
-	</script>
+    <script src="http://localhost:35729/livereload.js?snipver=1"></script>
+    <script>
+       $("#run_example").click(function(){
+         Sideshow.start({ listAll: true });
+       });
+    </script>
 </body>
 </html>

data/examples/scripts/sideshow.config.js

@@ -1,2 +1,2 @@
 Sideshow.config.language = "en";
-Sideshow.init();
+Sideshow.init();

data/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sideshow",
-    "version": "0.4.1",
+    "version": "0.4.2",
     "description": "Sideshow is a powerful javascript library which aims to reduce your user's learning curve by providing a way to create step-by-step interactive helps.",
     "main": " ",
     "scripts": {
@@ -45,7 +45,9 @@
         "gulp-stylus": "^1.3.4",
         "gulp-tar": "^1.3.1",
         "gulp-uglify": "^1.0.1",
+        "gulp-unzip": "^0.1.2",
         "gulp-util": "^3.0.1",
+        "gulp-wait": "0.0.2",
         "gulp-yuidoc": "^0.1.2",
         "gulp-zip": "^2.0.2",
         "ini": "^1.2.1",

data/sideshow.gemspec

@@ -3,14 +3,14 @@ $:.push File.expand_path('distr', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'sideshow'
-  s.version     = '0.4.1'
+  s.version     = '0.4.2'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Alcides Queiroz']
   s.email       = ['alcidesqueiroz@gmail.com']
   s.homepage    = 'http://fortesinformatica.github.io/Sideshow'
-  s.summary     = 'Sideshow is a powerful javascript library which aims to reduce your user''s learning curve by providing a way to create step-by-step interactive helps.'
+  s.summary     = 'An incredible Javascript interactive help Library'
   s.license     = 'Apache 2.0'
-  s.description = s.summary
+  s.description = 'Sideshow is a powerful javascript library which aims to reduce your user''s learning curve by providing a way to create step-by-step interactive helps.'
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['distr']
 

data/sideshow.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
     <metadata>
         <id>sideshow</id>
-        <version>0.4.1</version>
+        <version>0.4.2</version>
         <title>Sideshow</title>
         <authors>Alcides Queiroz</authors>
         <owners>Fortes Informática</owners>

data/sideshow.sublime-project

@@ -1,16 +1,16 @@
 {
-	"folders":
-	[
-		{
-			"folder_exclude_patterns":
-			[
+    "folders":
+    [
+        {
+            "folder_exclude_patterns":
+            [
                 "node_modules",
-				"bower_components"
-			],
-			"follow_symlinks": true,
-			"path": "."
-		}
-	],
+                "bower_components"
+            ],
+            "follow_symlinks": true,
+            "path": "."
+        }
+    ],
     "build_systems":
     [
         {

data/src/copyright_info.js

@@ -1,8 +1,8 @@
 /**
  @license
  Sideshow - An incredible Javascript interactive help Library
- Version: 0.4.1
- Date: 2014-11-27
+ Version: 0.4.2
+ Date: 2015-03-10
  Author: Alcides Queiroz [alcidesqueiroz(at)gmail(dot)com]
  Available under Apache License 2.0 (https://raw2.github.com/fortesinformatica/sideshow/master/LICENSE)
  **/

data/src/general/global_object.js

@@ -58,20 +58,27 @@
         flags.running = false;
     };
 
-    SS.runWizard = function(name) {
-        var wiz = wizards.filter(function(w) {
+    /**
+    @deprecated
+    @method runWizard
+    @static
+    **/
+    SS.runWizard = function (name) {
+        showDeprecationWarning("This method is deprecated and will be removed until the next major version of Sideshow.");
+
+        var wiz = wizards.filter(function (w) {
             return w.name === name
         })[0];
         currentWizard = wiz;
         if (wiz) {
             if (wiz.isEligible()) wiz.play();
-            else if (wiz.preparation) wiz.preparation(function() {
-                setTimeout(function() {
+            else if (wiz.preparation) wiz.preparation(function () {
+                setTimeout(function () {
                     wiz.play();
                 }, 1000);
             });
             else throw new SSException("204", "This wizard hasn't preparation.");
-        } else throw new SSException("204", "There's no wizard with name " + name + ".");
+        } else throw new SSException("205", "There's no wizard with name " + name + ".");
     };
 
     SS.gotoStep = function() {
@@ -261,18 +268,27 @@
     @method start
     @param {Object} config                                The config object for Sideshow
     **/
-    SS.start = function(config) {
+    SS.start = function (config) {
         config = config || {};
+
         if (!flags.running) {
             var onlyNew = "onlyNew" in config && !! config.onlyNew;
             var listAll = "listAll" in config && !! config.listAll;
+            var wizardName = config.wizardName;
 
-            if (listAll)
-                SS.showWizardsList(wizards.filter(function(w) {
-                    return w.isEligible() || w.preparation;
-                }));
-            else
-                SS.showWizardsList(onlyNew);
+            if (listAll) SS.showWizardsList(wizards.filter(function (w) {
+                return w.isEligible() || w.preparation;
+            }));
+            else if(wizardName){
+                var wizard = wizards.filter(function (w) {
+                    return w.name === wizardName;
+                })[0];
+
+                if(!wizard) throw new SSException("205", "There's no wizard with name '" + wizardName + "'.");
+
+                wizard.prepareAndPlay();
+            } 
+            else SS.showWizardsList(onlyNew);
 
             this.CloseButton.singleInstance.render();
             this.CloseButton.singleInstance.fadeIn();
@@ -280,8 +296,9 @@
             registerInnerHotkeys();
             flags.running = true;
 
-            Polling.enqueue("check_composite_mask_screen_changes", function() {
+            Polling.enqueue("check_composite_mask_screen_changes", function () {
                 Mask.CompositeMask.singleInstance.pollForScreenChanges();
             });
         }
     };
+

data/src/general/utility_functions.js

@@ -9,6 +9,18 @@
         console.warn("[SIDESHOW_W#" + ("00000000" + code).substr(-8) + "] " + message);
     }
 
+    /**
+     Shows a deprecation warning in a pre-defined format
+     
+     @@function showDeprecationWarning
+     @param {String} message                               The warning message
+     **/
+
+    function showDeprecationWarning(message) {
+        console.warn("[DEPRECATION_WARNING] " + message);
+    }
+
+
     /**
     Parses a string in the format "#px" in a number