sms_feed/base/static/js/tour.js

'use strict';

var feed_content_tour = new Tour({
	name: "feed_content_tour",
	steps: [
		{
			path: "/",
			element: "#navbar-link-feed-content",
			title: "Managing feed content",
			content: "To manage the content of the SMS feeds, click on the 'Feed Content' link on the navigation bar.",
			reflex: true,
		},
		{
			path: "/feed_content/",
			element: ".table-container",
			title: "Categories",
			content: "The feed content page displays a list of the available feed categories. Each category contains a list of SMS messages to be sent, one for each day of the year.",
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "th.name",
			title: "Category name",
			content: "The category name column contains the name of the category. This name is used as the title of the RSS feed. No two categories can have the same name.",
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "th.description",
			title: "Description",
			content: "The description column contains an optional category description, which can be used to store notes about the category.",
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "th.rss_url",
			title: "RSS URL",
			content: "The RSS URL column contains the url that is used to retrieve the daily SMS message details for this category.<br><br>This URL should be given to the SMS provider along with the category name.",
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "th.days_required",
			title: "Days required",
			content: "The days required column specifies the number of messages that are needed for this category. It is usually 366&mdash;one for each day of a leap year.",
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "th.status",
			title: "Status",
			content: "The status column show whether or not a category contains the required number of messages. If there aren't enough, it will display how many and which days are missing.",
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "th.delete",
			title: "Deleting a category",
			content: 'Clicking on an <span class="glyphicon glyphicon-remove"></span> button in this column will delete the corresponding category.<br><br><b>WARNING:</b> This will also delete all messages in the category.',
			placement: "top",
		},
		{
			path: "/feed_content/",
			element: "#id_d0-search_expr",
			title: "Filtering categories",
			content: "You can filter the category list by typing some text into the 'Search' box and clicking on the 'Filter' button. Only categories containing this text in their name or description fields will be shown.",
		},
		{
			path: "/feed_content/",
			element: "#d0-create_button",
			title: "Creating categories",
			content: "You can add a new category by clicking on the 'Create' button.",
			reflex: true,
		},
		{
			path: "/feed_content/create/",
			element: "#id_name",
			title: "Category name",
			content: "Type in a unique category name.",
		},
		{
			path: "/feed_content/create/",
			element: "#id_description",
			title: "Description",
			content: "The description is optional. You can use it to add notes about the category.",
		},
		{
			path: "/feed_content/create/",
			element: "#id_days_required",
			title: "Days required",
			content: "Days required specifies the number of messages that are required inside this category. It is used to warn you if you haven't provided enough messages. The default value is 366&mdash;one for each day of a leap year. It is very unlikely that you will need to change this value.",
		},
		{
			path: "/feed_content/create/",
			element: "#id_create_button",
			title: "Create the category",
			content: "Once you have typed in the required information, click on the 'Create' button to create the new category (you don't have to do this now).<br><br>If there are any errors, the form will be displayed again with instructions on what needs fixing, otherwise you will be taken back to the category list.",
		},
		{
			path: "/feed_content/",
			element: ".clickable-row:first-child",
			title: "View category contents",
			content: "To view or edit a category, or the messages inside a category, click on one of the rows in the category list.",
		},
		{
			path: "/feed_content/1/",
			element: "#id_edit_button",
			title: "Edit category",
			content: "To edit the category details, click on the 'Edit' button. The process for editing a category is exactly the same as the process for creating a category.",
		},
		{
			path: "/feed_content/1/",
			element: "#id_delete_button",
			title: "Delete category",
			content: "To delete the category and all the messages it contains, click on the 'Delete' button.",
		},
		{
			path: "/feed_content/1/",
			element: "#t0 .table-container",
			title: "Messages",
			content: "The message list displays all the messages in the category.",
			placement: "top",
		},
		{
			path: "/feed_content/1/",
			element: "#t0 th.day_number",
			title: "Day number",
			content: "The day number column contains the day of the year on which the message will be sent. Day number 1 is the 1<sup>st</sup> of January, day number 32 is the 1<sup>st</sup> of February, etc. No two messages in a category can have the same day number.",
			placement: "top",
		},
		{
			path: "/feed_content/1/",
			element: "#t0 th.message_text",
			title: "Message text",
			content: "The message text column contains the text of the message that will be sent to subscibers.",
			placement: "top",
		},
		{
			path: "/feed_content/1/",
			element: "#t0 th.delete",
			title: "Deleting a message",
			content: 'Clicking on an <span class="glyphicon glyphicon-remove"></span> button in this column will delete the corresponding message.',
			placement: "top",
		},
		{
			path: "/feed_content/1/",
			element: "#id_d1-0-day_number",
			title: "Filtering messages",
			content: "You can search for a particular day number by typing it into the 'Day' box and clicking on Filter.",
		},
		{
			path: "/feed_content/1/",
			element: "#id_d1-0-message_text",
			title: "Filtering messages",
			content: "You can search for messages containing a particular piece of text by typing it into 'Text' box and clicking on Filter.",
		},
		{
			path: "/feed_content/1/",
			element: "#d1-0-create_button",
			title: "Creating messages",
			content: "You can create a new message by clicking on the 'Create' button.",
			reflex: true,
		},
		{
			path: "/feed_content/1/items/create/",
			element: "#id_day_number",
			title: "Day number",
			content: "You can optionally type in a day number for the message. If you leave the day number blank, the next available day number in the category will be automatically assigned. No two messages in a category can have the same day number.",
		},
		{
			path: "/feed_content/1/items/create/",
			element: "#id_message_text",
			title: "Message text",
			content: "Type in the text of the message.",
		},
		{
			path: "/feed_content/1/items/create/",
			element: "#id_create_button",
			title: "Create the message",
			content: "Once you have typed in the required information, click on the 'Create' button to create the new message (you don't have to do this now).<br><br>If there are any errors, the form will be displayed again with instructions on what needs fixing, otherwise you will be taken back to the message list for the category.",
		},
		{
			path: "/feed_content/1/",
			element: "#t0 .clickable-row:first-child",
			title: "Editing messages",
			content: "You can edit a message by clicking on the corresponding row in the message list.<br><br>The process is exactly the same as for creating a new message.",
			reflex: true,
		},
		{
			path: "/feed_content/1/",
			orphan: true,
			title: "Tutorial complete",
			content: "That's it as far as managing categories and messages goes.<br><br>You can click on the 'End tour' button to complete the tutorial."
		},
	]
});

var feed_logs_tour = new Tour({
	name: "feed_logs_tour",
	steps: [
		{
			path: "/",
			element: "#navbar-link-feed-logs",
			title: "Viewing feed logs",
			content: "To view the feed logs, click on the 'Feed Logs' link on the navigation bar.",
			reflex: true,
		},
		{
			path: "/rss/daily/logs/",
			element: ".table-container",
			title: "Feed logs",
			content: "The feed logs show you how many times the message for each category was downloaded on a particular day.<br><br>If you don't see an entry for a particular category on a particular day, then the message for that category was not sent on that day.",
			placement: "top",
		},
		{
			path: "/rss/daily/logs/",
			element: "#id_d0-from_date",
			title: "Filtering logs",
			content: "You can search for log entries that occur on or <b>after</b> a specific date by entering a value into the 'From' box. Dates should be enterred in the form YYYY-MM-DD.",
		},
		{
			path: "/rss/daily/logs/",
			element: "#id_d0-to_date",
			title: "Filtering logs",
			content: "You can search for log entries that occur on or <b>before</b> a specific date by entering a value into the 'To' box. Dates should be enterred in the form YYYY-MM-DD.",
		},
		{
			path: "/rss/daily/logs/",
			element: "#id_d0-category_name",
			title: "Filtering logs",
			content: "You can search for log entries whose category name contains a particular piece of text by typing it into the 'Category' box.",
		},
		{
			path: "/rss/daily/logs/",
			element: "#id_d0-message_text",
			title: "Filtering logs",
			content: "You can search for log entries whose message contains a particular piece of text by typing it into the 'Message' box.",
		},
		{
			path: "/rss/daily/logs/",
			element: ".filter-button",
			title: "Filtering logs",
			content: "You can perform more complicated searches using combinations of the various filter fields.<br><br>When you are ready to perform the search, click on the 'Filter' button.",
		},
		{
			path: "/rss/daily/logs/",
			element: ".filter-button",
			title: "Tutorial complete",
			content: "That's it as far as viewing the feed logs goes.<br><br>Click on the 'End tour' button to complete the tutorial.",
		},
	]
});

if (! String.prototype.startsWith) {
  String.prototype.startsWith = function(searchString, position) {
    position = position || 0;
    return this.indexOf(searchString, position) === position;
  };
}

if (document.location.pathname.startsWith('/feed_content/')) {
	feed_content_tour.init();
}
else if (document.location.pathname.startsWith('/rss/daily/logs/')) {
	feed_logs_tour.init();
}