You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 14, 2022. It is now read-only.
What?
Now that we've implemented an interactive tutorial to the homepage (#509, #550), the next steps will be to build upon this by using the framework we've build to add tutorials for other WebApp pages.
The existing implementation has been made to be extendable. To make a tour for a new pages, following the following steps:
Making a new tour
Create a <page name>_tour.js (e.g. run_queue_tour.js) in autoreduce_webapp/static/javascript/tours
Start the file with the following template code:
steps = [
{
element: "",
title: "",
content: "",
placement: ""
}, // Copy and paste this block to add steps to extend the tour
]
if (typeof tourSteps == 'undefined'){
tourSteps = steps
}
else{
tourSteps = tourSteps.concat(steps)
}
The conditional at the bottom handles whether this is the first tour file loaded onto the page or not
For each step of your tour, fill the element: attribute with the id of the html-element.
Fill the other attributes with the title and content of the tour step, and where you would like the step to appear in relation to the element
Add the following links and scripts to the page of the tour:
Add your new tour script, plus any additional tours you'd like to appear on the page (usually for example, the navbar_tour).
After all tours, add the create_tour.js script. This will initialise the tour, as well as a tour button on the right-hand-side of the "Auto-reduction" header.
Issue raised by: [developer]
What?
Now that we've implemented an interactive tutorial to the homepage (#509, #550), the next steps will be to build upon this by using the framework we've build to add tutorials for other WebApp pages.
The existing implementation has been made to be extendable. To make a tour for a new pages, following the following steps:
Making a new tour
<page name>_tour.js
(e.g. run_queue_tour.js) inautoreduce_webapp/static/javascript/tours
For each step of your tour, fill the
![image](https://user-images.githubusercontent.com/31534888/83245715-05f17580-a199-11ea-99b9-0a5939937eac.png)
![image](https://user-images.githubusercontent.com/31534888/83245969-608ad180-a199-11ea-85f2-a59f430ae05f.png)
element:
attribute with the id of the html-element.Fill the other attributes with the title and content of the tour step, and where you would like the step to appear in relation to the element
Add the following links and scripts to the page of the tour:
Add your new tour script, plus any additional tours you'd like to appear on the page (usually for example, the
![image](https://user-images.githubusercontent.com/31534888/83246414-ff173280-a199-11ea-882f-5d287aba825c.png)
navbar_tour
).After all tours, add the
create_tour.js
script. This will initialise the tour, as well as a tour button on the right-hand-side of the "Auto-reduction" header.Best of luck :slight_smile:
Where?
The WebApp
How to test the issue is resolved
The text was updated successfully, but these errors were encountered: