sideshow 0.4.1

data/package.json

@@ -0,0 +1,56 @@
+{
+    "name": "sideshow",
+    "version": "0.4.1",
+    "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": {
+        "test": " "
+    },
+    "repository": {
+        "type": "git",
+        "url": "http://github.com/fortesinformatica/Sideshow.git"
+    },
+    "keywords": [
+        "interactive",
+        "help",
+        "tour",
+        "tutorial",
+        "library",
+        "step-by-step"
+    ],
+    "author": "Alcides Queiroz",
+    "license": "Apache 2",
+    "devDependencies": {
+        "bower-installer": "^1.0.0",
+        "del": "^0.1.2",
+        "ecstatic": "^0.5.4",
+        "gift": "^0.5.0",
+        "gulp": "^3.8.7",
+        "gulp-autoprefixer": "0.0.10",
+        "gulp-beautify": "^1.1.1",
+        "gulp-bower": "0.0.7",
+        "gulp-cache": "^0.2.2",
+        "gulp-concat": "^2.4.2",
+        "gulp-csslint": "^0.1.5",
+        "gulp-gzip": "0.0.8",
+        "gulp-include": "^1.1.0",
+        "gulp-jshint": "^1.8.4",
+        "gulp-livereload": "^2.1.1",
+        "gulp-minify-css": "^0.3.8",
+        "gulp-notify": "^1.5.1",
+        "gulp-prettify": "^0.3.0",
+        "gulp-prompt": "^0.1.1",
+        "gulp-rename": "^1.2.0",
+        "gulp-run": "^1.6.4",
+        "gulp-stylus": "^1.3.4",
+        "gulp-tar": "^1.3.1",
+        "gulp-uglify": "^1.0.1",
+        "gulp-util": "^3.0.1",
+        "gulp-yuidoc": "^0.1.2",
+        "gulp-zip": "^2.0.2",
+        "ini": "^1.2.1",
+        "install": "^0.1.7",
+        "npm": "^1.4.26",
+        "open": "0.0.5"
+    }
+}

data/sideshow.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+$:.push File.expand_path('distr', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'sideshow'
+  s.version     = '0.4.1'
+  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.license     = 'Apache 2.0'
+  s.description = s.summary
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['distr']
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('sass')
+  s.add_development_dependency('bundler')
+end

data/sideshow.nuspec

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
+    <metadata>
+        <id>sideshow</id>
+        <version>0.4.1</version>
+        <title>Sideshow</title>
+        <authors>Alcides Queiroz</authors>
+        <owners>Fortes Informática</owners>
+        <licenseUrl>http://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
+        <projectUrl>https://github.com/fortesinformatica/Sideshow</projectUrl>
+        <iconUrl>http://fortesinformatica.github.io/Sideshow/favicon.png</iconUrl>
+        <requireLicenseAcceptance>false</requireLicenseAcceptance>
+        <developmentDependency>true</developmentDependency>
+        <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.</description>
+        <summary>An incredible Javascript interactive help Library</summary>
+        <copyright>Copyright 2013-2015 Alcides Queiroz [alcidesqueiroz(at)gmail(dot)com]</copyright>
+        <tags>sideshow, interactive, tutorial, tour, help, wizard, step-by-step, library, script, javascript</tags>
+    </metadata>
+    <files>
+        <file src="distr\fonts\open-sans-family\opensans-bold.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-bold.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-bold.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-bold.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-bold.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-bold.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-bold.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-bold.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-bolditalic.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-bolditalic.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-bolditalic.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-bolditalic.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-bolditalic.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-bolditalic.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-bolditalic.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-bolditalic.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabold.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabold.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabold.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabold.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabold.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabold.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabold.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabold.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabolditalic.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabolditalic.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabolditalic.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabolditalic.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabolditalic.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabolditalic.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-extrabolditalic.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-extrabolditalic.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-italic.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-italic.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-italic.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-italic.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-italic.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-italic.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-italic.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-italic.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-light.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-light.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-light.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-light.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-light.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-light.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-light.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-light.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-lightitalic.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-lightitalic.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-lightitalic.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-lightitalic.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-lightitalic.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-lightitalic.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-lightitalic.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-lightitalic.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-regular.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-regular.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-regular.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-regular.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-regular.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-regular.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-regular.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-regular.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-semibold.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibold.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-semibold.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibold.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-semibold.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibold.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-semibold.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibold.woff" />
+        <file src="distr\fonts\open-sans-family\opensans-semibolditalic.eot" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibolditalic.eot" />
+        <file src="distr\fonts\open-sans-family\opensans-semibolditalic.svg" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibolditalic.svg" />
+        <file src="distr\fonts\open-sans-family\opensans-semibolditalic.ttf" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibolditalic.ttf" />
+        <file src="distr\fonts\open-sans-family\opensans-semibolditalic.woff" target="content\Content\sideshow\fonts\open-sans-family\opensans-semibolditalic.woff" />
+        <file src="distr\fonts\sideshow-icons\sideshow-icons.eot" target="content\Content\sideshow\fonts\sideshow-icons\sideshow-icons.eot" />
+        <file src="distr\fonts\sideshow-icons\sideshow-icons.svg" target="content\Content\sideshow\fonts\sideshow-icons\sideshow-icons.svg" />
+        <file src="distr\fonts\sideshow-icons\sideshow-icons.ttf" target="content\Content\sideshow\fonts\sideshow-icons\sideshow-icons.ttf" />
+        <file src="distr\fonts\sideshow-icons\sideshow-icons.woff" target="content\Content\sideshow\fonts\sideshow-icons\sideshow-icons.woff" />
+        <file src="distr\fonts\sideshow-fontface.min.css" target="content\Content\sideshow\fonts\sideshow-fontface.min.css" />
+        <file src="distr\stylesheets\sideshow.min.css" target="content\Content\sideshow\sideshow.min.css" />
+        <file src="distr\dependencies\jazz.min.js" target="content\Scripts\dependencies\jazz.min.js" />
+        <file src="distr\dependencies\jquery.min.js" target="content\Scripts\dependencies\jquery.min.js" />
+        <file src="distr\dependencies\pagedown.min.js" target="content\Scripts\dependencies\pagedown.min.js" />
+        <file src="distr\sideshow.js" target="content\Scripts\sideshow.js" />
+        <file src="distr\sideshow.min.js" target="content\Scripts\sideshow.min.js" />
+    </files>
+</package>

data/sideshow.sublime-project

@@ -0,0 +1,22 @@
+{
+	"folders":
+	[
+		{
+			"folder_exclude_patterns":
+			[
+                "node_modules",
+				"bower_components"
+			],
+			"follow_symlinks": true,
+			"path": "."
+		}
+	],
+    "build_systems":
+    [
+        {
+            "name": "Gulp",
+            "cmd": ["gulp"],
+            "shell": true
+        }
+    ]
+}

data/src/copyright_info.js

@@ -0,0 +1,8 @@
+/**
+ @license
+ Sideshow - An incredible Javascript interactive help Library
+ Version: 0.4.1
+ Date: 2014-11-27
+ 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/config.js

@@ -0,0 +1,42 @@
+	/**
+	Sideshow Settings
+
+	@@object config
+	**/
+	SS.config = {};
+
+	/**
+	Application route to persists user preferences
+
+	@@field userPreferencesRoute
+	@type String
+	@@unused
+	@@todo Implement persistence logic
+	**/
+	SS.config.userPreferencesRoute = null;
+
+	/**
+	Logged in user
+
+	@@field loggedInUser
+	@type String
+	@@unused
+	**/
+	SS.config.loggedInUser = null;
+
+	/**
+	Chosen language for sideshow interface
+
+	@@field language
+	@type String
+	**/
+	SS.config.language = "en";
+
+	/**
+	Defines if the intro screen (the tutorial list) will be	skipped when there's just one 
+	tutorial available. This way, when Sideshow is invoked, the first step is directly shown.
+
+	@@field autoSkipIntro
+	@type boolean
+	**/
+	SS.config.autoSkipIntro = false;

data/src/general/dictionary.js

@@ -0,0 +1,42 @@
+    /**
+    Strings Dictionary
+
+    @@object strings
+    **/
+    var strings = {
+        availableWizards: {
+            "en": "Available Tutorials",
+            "pt-br": "Tutoriais Disponíveis",
+            "es": "Tutoriales Disponibles"
+        },
+        relatedWizards: {
+            "en": "Related Wizards",
+            "pt-br": "Tutoriais Relacionados",
+            "es": "Tutoriales Relacionados"
+        },
+        noAvailableWizards: {
+            "en": "There's no tutorials available.",
+            "pt-br": "Não há tutoriais disponíveis para esta tela.",
+            "es": "No hay tutoriales disponibles."
+        },
+        close: {
+            "en": "Close",
+            "pt-br": "Fechar",
+            "es": "Cerrar"
+        },
+        estimatedTime: {
+            "en": "Estimated Time",
+            "pt-br": "Tempo Estimado",
+            "es": "Tiempo Estimado"
+        },
+        next: {
+            "en": "Next",
+            "pt-br": "Continuar",
+            "es": "Continuar"
+        },
+        finishWizard: {
+            "en": "Finish Wizard",
+            "pt-br": "Concluir Tutorial",
+            "es": "Concluir Tutorial"
+        }
+    };

data/src/general/exception.js

@@ -0,0 +1,15 @@
+	/**
+	A custom exception class for Sideshow
+
+	@class SSException
+	@extends Error
+	@param {String} code                                  The error code
+	@param {String} message                               The error message
+	**/
+	function SSException(code, message) {
+	    this.name = "SSException";
+	    this.message = "[SIDESHOW_E#" + ("00000000" + code).substr(-8) + "] " + message;
+	}
+
+	SSException.prototype = new Error();
+	SSException.prototype.constructor = SSException;

data/src/general/global_object.js

@@ -0,0 +1,287 @@
+    /**
+    Initializes Sideshow
+
+    @method init
+    @static
+    **/
+    SS.init = function() {
+        $window = $(global);
+        $document = $(global.document);
+        $body = $("body", global.document);
+        registerGlobalHotkeys();
+        Polling.start();
+        Mask.CompositeMask.singleInstance.init();
+        flags.lockMaskUpdate = true;
+        Mask.CompositeMask.singleInstance.render();
+    };
+
+    /**
+    Receives a function with just a multiline comment as body and converts to a here-document string
+
+    @method heredoc
+    @param {Function}                                     A function without body but a multiline comment
+    @return {String}                                      A multiline string
+    @static
+    **/
+    SS.heredoc = function(fn) {
+        return fn.toString().match(/[^]*\/\*([^]*)\*\/\}$/)[1];
+    }
+
+    /**
+    Stops and Closes Sideshow
+
+    @method closes
+    @static
+    **/
+    SS.close = function() {
+        if (!currentWizard) WizardMenu.hide();
+
+        DetailsPanel.singleInstance.fadeOut();
+
+        this.CloseButton.singleInstance.fadeOut();
+        Arrows.fadeOut();
+
+        setTimeout(function() {
+            if (Mask.CompositeMask.singleInstance.status === AnimationStatus.VISIBLE ||
+                Mask.CompositeMask.singleInstance.status === AnimationStatus.FADING_IN)
+                Mask.CompositeMask.singleInstance.fadeOut();
+
+            Mask.SubjectMask.singleInstance.fadeOut();
+
+        }, longAnimationDuration);
+
+        removeDOMGarbage();
+        Polling.clear();
+        SS.ControlVariables.clear();
+        unregisterInnerHotkeys();
+        currentWizard = null;
+        flags.running = false;
+    };
+
+    SS.runWizard = function(name) {
+        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() {
+                    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 + ".");
+    };
+
+    SS.gotoStep = function() {
+        var firstArg = arguments[0],
+            steps = currentWizard._storyline.steps,
+            destination;
+
+        flags.skippingStep = true;
+
+        //First argument is the step position (1-based)
+        if (typeof firstArg == "number") {
+            if (firstArg <= steps.length)
+                destination = steps[firstArg - 1];
+            else
+                throw new SSException("401", "There's no step in the storyline with position " + firstArg + ".");
+        } //First argument is the step name
+        else if (typeof firstArg == "string") {
+            destination = steps.filter(function(i) {
+                return i.name === firstArg;
+            })[0];
+
+            if (!destination) throw new SSException("401", "There's no step in the storyline with name " + firstArg + ".");
+        }
+        setTimeout(function() {
+            currentWizard.next(null, destination);
+        }, 100);
+    };
+
+    /**
+    A trick to use the composite mask to simulate the behavior of a solid mask, setting an empty subject
+
+    @method setEmptySubject
+    @static
+    **/
+    SS.setEmptySubject = function() {
+        flags.lockMaskUpdate = true;
+        Subject.obj = null;
+        Subject.updateInfo({
+            dimension: {
+                width: 0,
+                height: 0
+            },
+            position: {
+                x: 0,
+                y: 0
+            },
+            borderRadius: {
+                leftTop: 0,
+                rightTop: 0,
+                leftBottom: 0,
+                rightBottom: 0
+            }
+        });
+    };
+
+    /**
+    Sets the current subject
+
+    @method setSubject
+    @param {Object} subj
+    @static
+    **/
+    SS.setSubject = function(subj, subjectChanged) {
+        if (subj.constructor === String) subj = $(subj);
+
+        if (subj instanceof $ && subj.length > 0) {
+            if (subj.length === 1) {
+                Subject.obj = subj;
+                Subject.updateInfo();
+                flags.lockMaskUpdate = false;
+            } else
+                throw new SSException("101", "A subject must have only one element. Multiple elements by step will be supported in future versions of Sideshow.");
+        } 
+        else if (subjectChanged) 
+            SS.setEmptySubject();
+        else
+            throw new SSException("100", "Invalid subject.");
+    };
+
+    /**
+    Registers a wizard
+
+    @method registerWizard
+    @param {Object} wizardConfig                          
+    @return {Object}                                      The wizard instance
+    @static
+    **/
+    SS.registerWizard = function(wizardConfig) {
+        var wiz = Wizard.build(wizardConfig);
+        wizards.push(wiz);
+        return wiz;
+    };
+
+    /**
+    Registers a wizard
+
+    @method registerWizard
+    @param {boolean} onlyNew                              Checks only recently added wizards
+    @return {Array}                                       The eligible wizards list
+    @static
+    **/
+    SS.getElegibleWizards = function(onlyNew) {
+        var eligibleWizards = [];
+        var somethingNew = false;
+        for (var w = 0; w < wizards.length; w++) {
+            var wiz = wizards[w];
+            if (wiz.isEligible()) {
+                if (!wiz.isAlreadyWatched()) somethingNew = true;
+                eligibleWizards.push(wiz);
+            }
+        }
+
+        return !onlyNew || somethingNew ? eligibleWizards : [];
+    };
+
+    /**
+    Checks if there are eligible wizards, if exists, shows the wizard menu   
+
+    @method showWizardsList
+    @param {boolean} onlyNew                              Checks only recently added wizards
+    @return {boolean}                                     Returns a boolean indicating whether there is some wizard available
+    @static
+    **/
+    SS.showWizardsList = function() {
+        var firstArg = arguments[0];
+        var title = arguments[1];
+        var onlyNew = typeof firstArg == "boolean" ? false : firstArg;
+        var wizards = firstArg instanceof Array ? firstArg : this.getElegibleWizards(onlyNew);
+
+        WizardMenu.show(wizards, title);
+
+        return wizards.length > 0;
+    };
+
+    /**
+    Shows a list with the related wizards  
+
+    @method showRelatedWizardsList
+    @param {Object} completedWizard                       The recently completed wizard
+    @return {boolean}                                     Returns a boolean indicating whether there is some related wizard available
+    @static
+    **/
+    SS.showRelatedWizardsList = function(completedWizard) {
+        var relatedWizardsNames = completedWizard.relatedWizards;
+        if (!relatedWizardsNames) return false;
+
+        //Gets only related tutorials which are eligible or have a preparation function
+        var relatedWizards = wizards.filter(function(w) {
+            return relatedWizardsNames.indexOf(w.name) > -1 && (w.isEligible() || w.preparation);
+        });
+        if (relatedWizards.length == 0) return false;
+
+        Polling.clear();
+        SS.ControlVariables.clear();
+        SS.showWizardsList(relatedWizards, getString(strings.relatedWizards));
+
+        return true;
+    };
+
+    /**
+    The close button for the wizard
+
+    @class CloseButton
+    @@singleton
+    @extends FadableItem
+    **/
+    SS.CloseButton = jazz.Class().extending(FadableItem).singleton;
+
+    /**
+    Renders the close button
+
+    @method render
+    **/
+    SS.CloseButton.method("render", function() {
+        this.$el = $("<button>")
+            .addClass("sideshow-close-button")
+            .text(getString(strings.close));
+        this.$el.click(function() {
+            SS.close();
+        });
+        this.callSuper("render");
+    });
+
+    /**
+    Starts Sideshow
+
+    @method start
+    @param {Object} config                                The config object for Sideshow
+    **/
+    SS.start = function(config) {
+        config = config || {};
+        if (!flags.running) {
+            var onlyNew = "onlyNew" in config && !! config.onlyNew;
+            var listAll = "listAll" in config && !! config.listAll;
+
+            if (listAll)
+                SS.showWizardsList(wizards.filter(function(w) {
+                    return w.isEligible() || w.preparation;
+                }));
+            else
+                SS.showWizardsList(onlyNew);
+
+            this.CloseButton.singleInstance.render();
+            this.CloseButton.singleInstance.fadeIn();
+
+            registerInnerHotkeys();
+            flags.running = true;
+
+            Polling.enqueue("check_composite_mask_screen_changes", function() {
+                Mask.CompositeMask.singleInstance.pollForScreenChanges();
+            });
+        }
+    };