").parent().html();
- $element.popover({
- placement: step.placement,
- trigger: "manual",
- title: step.title,
- content: step.content,
- html: true,
- animation: step.animation,
- container: step.container,
- template: step.template,
- selector: step.element
- }).popover("show");
- $tip = $element.data("bs.popover") ? $element.data("bs.popover").tip() : $element.data("popover").tip();
- $tip.attr("id", step.id);
- this._scrollIntoView($tip);
- this._reposition($tip, step);
- if (isOrphan) {
- return this._center($tip);
- }
- };
-
- Tour.prototype._reposition = function($tip, step) {
- var offsetBottom, offsetHeight, offsetRight, offsetWidth, originalLeft, originalTop, tipOffset;
- offsetWidth = $tip[0].offsetWidth;
- offsetHeight = $tip[0].offsetHeight;
- tipOffset = $tip.offset();
- originalLeft = tipOffset.left;
- originalTop = tipOffset.top;
- offsetBottom = $(document).outerHeight() - tipOffset.top - $tip.outerHeight();
- if (offsetBottom < 0) {
- tipOffset.top = tipOffset.top + offsetBottom;
- }
- offsetRight = $("html").outerWidth() - tipOffset.left - $tip.outerWidth();
- if (offsetRight < 0) {
- tipOffset.left = tipOffset.left + offsetRight;
- }
- if (tipOffset.top < 0) {
- tipOffset.top = 0;
- }
- if (tipOffset.left < 0) {
- tipOffset.left = 0;
- }
- $tip.offset(tipOffset);
- if (step.placement === "bottom" || step.placement === "top") {
- if (originalLeft !== tipOffset.left) {
- return this._replaceArrow($tip, (tipOffset.left - originalLeft) * 2, offsetWidth, "left");
- }
- } else {
- if (originalTop !== tipOffset.top) {
- return this._replaceArrow($tip, (tipOffset.top - originalTop) * 2, offsetHeight, "top");
- }
- }
- };
-
- Tour.prototype._center = function($tip) {
- return $tip.css("top", $(window).outerHeight() / 2 - $tip.outerHeight() / 2);
- };
-
- Tour.prototype._replaceArrow = function($tip, delta, dimension, position) {
- return $tip.find(".arrow").css(position, delta ? 50 * (1 - delta / dimension) + "%" : "");
- };
-
- Tour.prototype._scrollIntoView = function(tip) {
- return $("html, body").stop().animate({
- scrollTop: Math.ceil(tip.offset().top - ($(window).height() / 2))
- });
- };
-
- Tour.prototype._onResize = function(callback, timeout) {
- return $(window).on("resize.tour-" + this._options.name, function() {
- clearTimeout(timeout);
- return timeout = setTimeout(callback, 100);
- });
- };
-
- Tour.prototype._setupKeyboardNavigation = function() {
- var _this = this;
- if (this._options.keyboard) {
- return $(document).on("keyup.tour-" + this._options.name, function(e) {
- if (!e.which) {
- return;
- }
- switch (e.which) {
- case 39:
- e.preventDefault();
- if (_this._current < _this._steps.length - 1) {
- return _this.next();
- } else {
- return _this.end();
- }
- break;
- case 37:
- e.preventDefault();
- if (_this._current > 0) {
- return _this.prev();
- }
- break;
- case 27:
- e.preventDefault();
- return _this.end();
- }
- });
- }
- };
-
- Tour.prototype._makePromise = function(result) {
- if (result && $.isFunction(result.then)) {
- return result;
- } else {
- return null;
- }
- };
-
- Tour.prototype._callOnPromiseDone = function(promise, cb, arg) {
- var _this = this;
- if (promise) {
- return promise.then(function(e) {
- return cb.call(_this, arg);
- });
- } else {
- return cb.call(this, arg);
- }
- };
-
- Tour.prototype._showBackdrop = function(element) {
- if (this.backdrop.overlay !== null) {
- return;
- }
- this._showOverlay();
- if (element != null) {
- return this._showOverlayElement(element);
- }
- };
-
- Tour.prototype._hideBackdrop = function() {
- if (this.backdrop.overlay === null) {
- return;
- }
- if (this.backdrop.$element) {
- this._hideOverlayElement();
- }
- return this._hideOverlay();
- };
-
- Tour.prototype._showOverlay = function() {
- this.backdrop = $("
", {
- "class": "tour-backdrop"
- });
- return $("body").append(this.backdrop);
- };
-
- Tour.prototype._hideOverlay = function() {
- this.backdrop.remove();
- return this.backdrop.overlay = null;
- };
-
- Tour.prototype._showOverlayElement = function(element) {
- var $background, $element, offset;
- $element = $(element);
- $background = $("
");
- offset = $element.offset();
- offset.top = offset.top;
- offset.left = offset.left;
- $background.width($element.innerWidth()).height($element.innerHeight()).addClass("tour-step-background").offset(offset);
- $element.addClass("tour-step-backdrop");
- $("body").append($background);
- this.backdrop.$element = $element;
- return this.backdrop.$background = $background;
- };
-
- Tour.prototype._hideOverlayElement = function() {
- this.backdrop.$element.removeClass("tour-step-backdrop");
- this.backdrop.$background.remove();
- this.backdrop.$element = null;
- return this.backdrop.$background = null;
- };
-
- return Tour;
-
- })();
- return window.Tour = Tour;
- })(jQuery, window);
-
-}).call(this);
diff --git a/addons/website/static/src/css/editor.css b/addons/website/static/src/css/editor.css
index 4e9038837f3..7d8b1e609e8 100644
--- a/addons/website/static/src/css/editor.css
+++ b/addons/website/static/src/css/editor.css
@@ -518,10 +518,30 @@ div.tour-backdrop {
z-index: 2009;
}
-.popover.tour {
- z-index: 2010;
+.popover.tour.orphan .arrow {
+ display: none;
+}
+.popover.tour .popover-navigation {
+ padding: 9px 14px;
+}
+.popover.tour .popover-navigation *[data-role="end"] {
+ float: right;
+}
+.popover.tour .popover-navigation *[data-role="next"], .popover.tour .popover-navigation *[data-role="end"] {
+ cursor: pointer;
}
.popover.fixed {
position: fixed;
}
+
+.tour-backdrop {
+ position: fixed;
+ top: 0;
+ right: 0;
+ bottom: 0;
+ left: 0;
+ z-index: 1100;
+ background-color: black;
+ opacity: 0.8;
+}
diff --git a/addons/website/static/src/css/editor.sass b/addons/website/static/src/css/editor.sass
index 53eb89a4341..d39b6abd453 100644
--- a/addons/website/static/src/css/editor.sass
+++ b/addons/website/static/src/css/editor.sass
@@ -451,9 +451,26 @@ $editorbar_height: 30px
div.tour-backdrop
z-index: 2009
.popover.tour
- z-index: 2010
+ &.orphan .arrow
+ display: none
+ .popover-navigation
+ padding: 9px 14px
+ *[data-role="end"]
+ float: right
+ *[data-role="next"],*[data-role="end"]
+ cursor: pointer
.popover.fixed
position: fixed
+.tour-backdrop
+ position: fixed
+ top: 0
+ right: 0
+ bottom: 0
+ left: 0
+ z-index: 1100
+ background-color: #000
+ opacity: 0.8
+
// }}}
diff --git a/addons/website/static/src/js/website.editor.js b/addons/website/static/src/js/website.editor.js
index 2119d05f650..be69c66b615 100644
--- a/addons/website/static/src/js/website.editor.js
+++ b/addons/website/static/src/js/website.editor.js
@@ -545,7 +545,7 @@
observer.disconnect();
var editor = this.rte.editor;
- var root = editor.element.$;
+ var root = editor.element && editor.element.$;
editor.destroy();
// FIXME: select editables then filter by dirty?
var defs = this.rte.fetch_editables(root)
diff --git a/addons/website/static/src/js/website.snippets.editor.js b/addons/website/static/src/js/website.snippets.editor.js
index 0177e8b8b64..8f49409924d 100644
--- a/addons/website/static/src/js/website.snippets.editor.js
+++ b/addons/website/static/src/js/website.snippets.editor.js
@@ -362,7 +362,6 @@
},
clean_for_save: function () {
var self = this;
-
$("*[contentEditable], *[attributeEditable]")
.removeAttr('contentEditable')
.removeAttr('attributeEditable');
diff --git a/addons/website/static/src/js/website.tour.banner.js b/addons/website/static/src/js/website.tour.banner.js
index d401cc40128..3d55220084e 100644
--- a/addons/website/static/src/js/website.tour.banner.js
+++ b/addons/website/static/src/js/website.tour.banner.js
@@ -4,127 +4,116 @@
var website = openerp.website;
var _t = openerp._t;
- website.EditorBar.include({
- start: function () {
- this.registerTour(new website.Tour.Banner(this));
- return this._super();
- },
- });
-
- website.Tour.Banner = website.Tour.extend({
+ website.Tour.register({
id: 'banner',
- name: "Build a page",
+ name: _t("Build a page"),
path: '/page/website.homepage',
- init: function () {
- var self = this;
- self.steps = [
- {
- title: _t("Welcome to your website!"),
- content: _t("This tutorial will guide you to build your home page. We will start by adding a banner."),
- popover: { next: _t("Start Tutorial"), end: _t("Skip It") },
- },
- {
- waitNot: '.popover.tour',
- element: 'button[data-action=edit]',
- placement: 'bottom',
- title: _t("Edit this page"),
- content: _t("Every page of your website can be modified through the
Edit button."),
- popover: { fixed: true },
- },
- {
- element: 'button[data-action=snippet]',
- placement: 'bottom',
- title: _t("Insert building blocks"),
- content: _t("Click here to insert blocks of content in the page."),
- popover: { fixed: true },
- },
- {
- snippet: '#snippet_structure .oe_snippet:first',
- placement: 'bottom',
- title: _t("Drag & Drop a Banner"),
- content: _t("Drag the Banner block and drop it in your page."),
- popover: { fixed: true },
- },
- {
- waitFor: '.oe_overlay_options .oe_options:visible',
- element: '#wrap .carousel:first div.carousel-content',
- placement: 'top',
- title: _t("Customize banner's text"),
- content: _t("Click in the text and start editing it."),
- sampleText: 'Here, a customized text',
- },
- {
- waitNot: '#wrap .carousel:first div.carousel-content:has(h2:'+
- 'containsExact('+_t('Your Banner Title')+')):has(h3:'+
- 'containsExact('+_t('Click to customize this text')+'))',
- element: '.oe_snippet_parent:visible',
- placement: 'bottom',
- title: _t("Get banner properties"),
- content: _t("Select the parent container to get the global options of the banner."),
- popover: { fixed: true },
- },
- {
- element: '.oe_overlay_options .oe_options:visible',
- placement: 'left',
- title: _t("Customize the banner"),
- content: _t("Customize any block through this menu. Try to change the background of the banner."),
- popover: { next: _t("Continue") },
- },
- {
- waitNot: '.popover.tour',
- element: 'button[data-action=snippet]',
- placement: 'bottom',
- title: _t("Add Another Block"),
- content: _t("Let's add another building block to your page."),
- popover: { fixed: true },
- },
- {
- snippet: '#snippet_structure .oe_snippet:eq(6)',
- placement: 'bottom',
- title: _t("Drag & Drop This Block"),
- content: _t("Drag the
'Features' block and drop it below the banner."),
- popover: { fixed: true },
- },
- {
- waitFor: '.oe_overlay_options .oe_options:visible',
- element: 'button[data-action=save]',
- placement: 'right',
- title: _t("Save your modifications"),
- content: _t("Publish your page by clicking on the
'Save' button."),
- popover: { fixed: true },
- },
- {
- waitFor: 'button[data-action=edit]:visible',
- title: _t("Good Job!"),
- content: _t("Well done, you created your homepage."),
- popover: { next: _t("Continue") },
- },
- {
- waitNot: '.popover.tour',
- element: 'a[data-action=show-mobile-preview]',
- placement: 'bottom',
- title: _t("Test Your Mobile Version"),
- content: _t("Let's check how your homepage looks like on mobile devices."),
- popover: { fixed: true },
- },
- {
- element: '.modal:has(#mobile-viewport) button[data-dismiss=modal]',
- placement: 'right',
- title: _t("Check Mobile Preview"),
- content: _t("Scroll to check rendering and then close the mobile preview."),
- popover: { next: _t("Continue") },
- },
- {
- waitNot: '.modal',
- element: '#content-menu-button',
- placement: 'left',
- title: _t("Add new pages and menus"),
- content: _t("The 'Content' menu allows you to add pages or add the top menu."),
- popover: { next: _t("Close Tutorial") },
- },
- ];
- return this._super();
- },
+ steps: [
+ {
+ title: _t("Welcome to your website!"),
+ content: _t("This tutorial will guide you to build your home page. We will start by adding a banner."),
+ popover: { next: _t("Start Tutorial"), end: _t("Skip It") },
+ },
+ {
+ waitNot: '.popover.tour',
+ element: 'button[data-action=edit]',
+ placement: 'bottom',
+ title: _t("Edit this page"),
+ content: _t("Every page of your website can be modified through the
Edit button."),
+ popover: { fixed: true },
+ },
+ {
+ element: 'button[data-action=snippet]',
+ placement: 'bottom',
+ title: _t("Insert building blocks"),
+ content: _t("Click here to insert blocks of content in the page."),
+ popover: { fixed: true },
+ },
+ {
+ snippet: '#snippet_structure .oe_snippet:first',
+ placement: 'bottom',
+ title: _t("Drag & Drop a Banner"),
+ content: _t("Drag the Banner block and drop it in your page."),
+ popover: { fixed: true },
+ },
+ {
+ waitFor: '.oe_overlay_options .oe_options:visible',
+ element: '#wrap .carousel:first div.carousel-content',
+ placement: 'top',
+ title: _t("Customize banner's text"),
+ content: _t("Click in the text and start editing it."),
+ sampleText: 'Here, a customized text',
+ },
+ {
+ waitNot: '#wrap .carousel:first div.carousel-content:has(h2:'+
+ 'containsExact('+_t('Your Banner Title')+')):has(h3:'+
+ 'containsExact('+_t('Click to customize this text')+'))',
+ element: '.oe_snippet_parent:visible',
+ placement: 'bottom',
+ title: _t("Get banner properties"),
+ content: _t("Select the parent container to get the global options of the banner."),
+ popover: { fixed: true },
+ },
+ {
+ element: '.oe_overlay_options .oe_options:visible',
+ placement: 'left',
+ title: _t("Customize the banner"),
+ content: _t("Customize any block through this menu. Try to change the background of the banner."),
+ popover: { next: _t("Continue") },
+ },
+ {
+ waitNot: '.popover.tour',
+ element: 'button[data-action=snippet]',
+ placement: 'bottom',
+ title: _t("Add Another Block"),
+ content: _t("Let's add another building block to your page."),
+ popover: { fixed: true },
+ },
+ {
+ snippet: '#snippet_structure .oe_snippet:eq(6)',
+ placement: 'bottom',
+ title: _t("Drag & Drop This Block"),
+ content: _t("Drag the
'Features' block and drop it below the banner."),
+ popover: { fixed: true },
+ },
+ {
+ waitFor: '.oe_overlay_options .oe_options:visible',
+ element: 'button[data-action=save]',
+ placement: 'right',
+ title: _t("Save your modifications"),
+ content: _t("Publish your page by clicking on the
'Save' button."),
+ popover: { fixed: true },
+ },
+ {
+ waitFor: 'button[data-action=edit]:visible',
+ title: _t("Good Job!"),
+ content: _t("Well done, you created your homepage."),
+ popover: { next: _t("Continue") },
+ },
+ {
+ waitNot: '.popover.tour',
+ element: 'a[data-action=show-mobile-preview]',
+ placement: 'bottom',
+ title: _t("Test Your Mobile Version"),
+ content: _t("Let's check how your homepage looks like on mobile devices."),
+ popover: { fixed: true },
+ },
+ {
+ element: '.modal:has(#mobile-viewport) button[data-dismiss=modal]',
+ placement: 'right',
+ title: _t("Check Mobile Preview"),
+ content: _t("Scroll to check rendering and then close the mobile preview."),
+ popover: { next: _t("Continue") },
+ },
+ {
+ waitNot: '.modal',
+ element: '#content-menu-button',
+ placement: 'left',
+ title: _t("Add new pages and menus"),
+ content: _t("The 'Content' menu allows you to add pages or add the top menu."),
+ popover: { next: _t("Close Tutorial") },
+ },
+ ]
});
}());
diff --git a/addons/website/static/src/js/website.tour.js b/addons/website/static/src/js/website.tour.js
index 911b6c7431a..2a661b4cc9b 100644
--- a/addons/website/static/src/js/website.tour.js
+++ b/addons/website/static/src/js/website.tour.js
@@ -6,7 +6,7 @@ if (typeof openerp === "undefined") {
var error = "openerp is undefined"
+ "\nhref: " + window.location.href
+ "\nreferrer: " + document.referrer
- + "\nlocalStorage: " + JSON.stringify(window.localStorage);
+ + "\nlocalStorage: " + window.localStorage.getItem("tour");
if (typeof $ !== "undefined") {
error += '\n\n' + $("body").html();
}
@@ -15,7 +15,7 @@ if (typeof openerp === "undefined") {
var website = window.openerp.website;
-// don't rewrite website.Tour in test mode
+// don't rewrite T in test mode
if (typeof website.Tour !== "undefined") {
return;
}
@@ -23,40 +23,26 @@ if (typeof website.Tour !== "undefined") {
// don't need template to use bootstrap Tour in automatic mode
if (typeof QWeb2 !== "undefined") {
website.add_template_file('/website/static/src/xml/website.tour.xml');
-
}
-// don't need to use bootstrap Tour to launch an automatic tour
-function bootstrap_tour_stub () {
- if (typeof Tour === "undefined") {
- window.Tour = function Tour() {};
- Tour.prototype.addSteps = function () {};
- Tour.prototype.end = function () {};
- Tour.prototype.goto = function () {};
- }
-}
-
-
-
if (website.EditorBar) {
website.EditorBar.include({
tours: [],
start: function () {
var self = this;
var menu = $('#help-menu');
- _.each(this.tours, function (tour) {
+ _.each(T.tours, function (tour) {
+ if (tour.mode === "test") {
+ return;
+ }
var $menuItem = $($.parseHTML('
'+tour.name+''));
$menuItem.click(function () {
- tour.reset();
- tour.run();
+ T.reset();
+ T.run(tour.id);
});
menu.append($menuItem);
});
return this._super();
- },
- registerTour: function (tour) {
- website.Tour.add(tour);
- this.tours.push(tour);
}
});
}
@@ -94,351 +80,401 @@ $.ajaxSetup({
}
});
-website.Tour = openerp.Class.extend({
- steps: [],
- defaultDelay: 50, //ms
- defaultOverLaps: 5000, //ms
- localStorage: window.localStorage,
- init: function () {},
+/////////////////////////////////////////////////
- run: function (automatic) {
- this.reset();
+var localStorage = window.localStorage;
- for (var k in this.localStorage) {
- if (!k.indexOf("tour-") && k.indexOf("-test") > -1) return;
- }
-
- website.Tour.busy = true;
-
- if (automatic) {
- this.localStorage.setItem("tour-"+this.id+"-test-automatic", true);
+var T = website.Tour = {
+ tours: {},
+ defaultDelay: 50,
+ retryRunningDelay: 1000,
+ errorDelay: 5000,
+ state: null,
+ $element: null,
+ timer: null,
+ testtimer: null,
+ currentTimer: null,
+ register: function (tour) {
+ if (tour.mode !== "test") tour.mode = "tutorial";
+ T.tours[tour.id] = tour;
+ },
+ run: function (tour_id, mode) {
+ var tour = T.tours[tour_id];
+ this.time = new Date().getTime();
+ if (tour.path && !window.location.href.match(new RegExp("("+T.getLang()+")?"+tour.path+"#?$", "i"))) {
+ var href = "/"+T.getLang()+tour.path;
+ console.log("Tour Begin from run method (redirection to "+href+")");
+ T.saveState(tour.id, mode || tour.mode, -1);
+ window.location.href = href;
} else {
- this.localStorage.removeItem("tour-"+this.id+"-test-automatic");
+ console.log("Tour Begin from run method");
+ T.saveState(tour.id, mode || tour.mode, 0);
+ T.running();
}
- this.automatic = automatic;
-
- if (this.path) {
- // redirect to begin of the tour in function of the language
- if (!this.testUrl(this.path+"(#.*)?$")) {
- var path = this.path.split('#');
- window.location.href = "/"+this.getLang()+path[0] + "#tutorial."+this.id+"=true&" + path.slice(1, path.length).join("#");
- return;
- }
- }
-
- var self = this;
- this.localStorage.setItem("tour-"+this.id+"-test", 0);
- website.Tour.waitReady.call(this, function () {self._running();});
},
- running: function () {
- var self = this;
- if (+this.localStorage.getItem("tour-"+this.id+"-test") >= this.steps.length-1) {
- this.endTour();
+ registerSteps: function (tour) {
+ if (tour.register) {
return;
}
+ tour.register = true;
- if (website.Tour.is_busy()) return;
+ for (var index=0, len=tour.steps.length; index
0 && tour.steps[index-1] &&
+ tour.steps[index-1].popover && tour.steps[index-1].popover.next) {
+ step.waitNot = '.popover.tour.fade.in:visible';
}
- return;
- }
-
- var self = this;
- website.Tour.waitReady.call(this, function () {self._running();});
- },
- _running: function () {
- var stepId = this.localStorage.getItem("tour-"+this.id+"-test");
-
- if (stepId != null) {
- this.registerTour();
- this.nextStep(stepId, this.automatic ? this.autoNextStep : null, this.automatic ? this.defaultOverLaps : null);
- }
- },
-
- reset: function () {
- website.Tour.busy = false;
- for (var k in this.steps) {
- this.steps[k].busy = false;
- }
- clearTimeout(self.timer);
- clearTimeout(self.testtimer);
-
- for (var k in this.localStorage) {
- if (!k.indexOf("tour-") || !k.indexOf(this.id)) {
- this.localStorage.removeItem(k);
- }
- }
-
- $('.popover.tour').remove();
- },
-
- getLang: function () {
- return $("html").attr("lang").replace(/-/, '_');
- },
- testUrl: function (url) {
- return new RegExp("(/"+this.getLang()+")?"+url, "i").test(window.location.href);
- },
- testPathUrl: function () {
- if (!this.testPath || this.testUrl(this.testPath)) return true;
- },
- checkRunningUrl: function () {
- if (window.location.hash.indexOf("tutorial."+this.id+"=true") > -1) {
- this.localStorage.setItem("tour-"+this.id+"-test", 0);
- window.location.hash = window.location.hash.replace(/tutorial.+=true&?/, '');
- }
- },
-
- registerTour: function () {
- if (this.automatic) {
- bootstrap_tour_stub();
- }
- this.tour = new Tour({
- name: this.id,
- storage: this.tourStorage,
- keyboard: false,
- template: this.popover(),
- onHide: function () {
- window.scrollTo(0, 0);
- }
- });
- this.registerSteps();
- },
- registerSteps: function () {
- for (var index=0, len=this.steps.length; index 0 && this.steps[index-1] &&
- this.steps[index-1].popover && this.steps[index-1].popover.next) {
- step.waitNot = '.popover.tour:visible';
- }
- if (!step.waitFor && index > 0 && this.steps[index-1].snippet) {
+ if (!step.waitFor && index > 0 && tour.steps[index-1].snippet) {
step.waitFor = '.oe_overlay_options .oe_options:visible';
}
- step._title = step._title || step.title;
- step.title = this.popoverTitle({ title: step._title });
- step.template = step.template || this.popover( step.popover );
- if (!step.element) step.orphan = true;
- if (step.snippet) {
+ var snippet = step.element && step.element.match(/#oe_snippets (.*) \.oe_snippet_thumbnail/);
+ if (snippet) {
+ step.snippet = snippet[1];
+ } else if (step.snippet) {
step.element = '#oe_snippets '+step.snippet+' .oe_snippet_thumbnail';
}
+ if (!step.element) {
+ step.element = "body";
+ step.orphan = true;
+ step.backdrop = true;
+ }
}
-
- if (this.steps[index-1] &&
- this.steps[index-1].popover && this.steps[index-1].popover.next) {
+ if (tour.steps[index-1] &&
+ tour.steps[index-1].popover && tour.steps[index-1].popover.next) {
var step = {
- stepId: ""+index,
- waitNot: '.popover.tour:visible'
+ _title: "",
+ id: index,
+ waitNot: '.popover.tour.fade.in:visible'
};
- this.steps.push(step);
+ tour.steps.push(step);
}
- this.tour.addSteps(this.steps);
+ // rendering bootstrap tour and popover
+ if (tour.mode !== "test") {
+ for (var index=0, len=tour.steps.length; index