Difference between revisions of "MediaWiki:Guidedtour-tour-gettingStarted.js"

From GATE
 
(54 intermediate revisions by 2 users not shown)
Line 17: Line 17:
 
* MediaWiki:Guidedtour-tour-{name}.js , in this example MediaWiki:Guidedtour-tour-mytest.js
 
* MediaWiki:Guidedtour-tour-{name}.js , in this example MediaWiki:Guidedtour-tour-mytest.js
 
*/
 
*/
name: 'gettingStarted'
+
name: 'gettingStarted',
 +
shouldLog: false
 +
 
 
} );
 
} );
  
Line 28: Line 30:
 
name: 'Step01',
 
name: 'Step01',
 
title: 'GATE getting started tour',
 
title: 'GATE getting started tour',
description: 'Dear user, <br>thanks for visiting us! GATE is a very wide portal where users can do a lot of wonderful stuff. Some of these are pretty easy, others are more complicated. To become familiar with GATE contents and functions, we strongly suggest to any new user to get this tour. It will take just two minutes!',
+
description: 'Dear user, <br>thanks for visiting us! GATE is a very wide portal where users can do a lot of wonderful stuff. Some of these are pretty easy, others are more complex. To become familiar with GATE contents and functions, we strongly suggest to any new user to get this tour. It will take just two minutes!',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 
overlay: true
 
overlay: true
 
} )
 
} )
Line 36: Line 40:
 
name: 'Step02',
 
name: 'Step02',
 
title: 'Tour tips',
 
title: 'Tour tips',
description: 'Before starting, just few tips about the tour. You can move among the steps using the Previous and Next buttons at the bottom of each card. You can also quit the tour using the X button on the top-right. <br> Now let\'s start the tour!',
+
description: 'Before starting, just a few tips about the tour.<br> You can move among the steps using the <b>Previous</b> (<b><</b>) and <b>Next</b> (<b>></b>) buttons at the bottom of each box.<br> Please, before clicking on any link and exploring GATE, we ask you to continue the tour until the last step. Anyway, if you want, you can quit the tour using the <b>X</b> button on the top-right of the box; it\'s possible to restart the tour whenever you want by clicking on the same link. <br> Now let\'s start the tour!',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 
overlay: true
 
overlay: true
  
Line 45: Line 51:
 
tour.step( {
 
tour.step( {
 
name: 'Step03',
 
name: 'Step03',
title: 'GATE sections',
+
title: 'Homepage',
description: 'GATE hosts several projects distributed in three main sections: Monumenta, Collections and Publications always accessible on the top of the page.',
+
description: 'This is the GATE homepage. Welcome again! ',
attachTo: '#mw-navigation-collapse',
+
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: true
 +
 
 +
} )
 +
.next( 'Step04' )
 +
.back( 'Step02' );
 +
 +
tour.step( {
 +
name: 'Step04',
 +
title: 'Homepage main box',
 +
description: 'In this box - we will refer to it as the <b>Main box</b> - you have a preview of some of the projects hosted on GATE: <i>Monumenta</i> and <i>Collections</i> are two sections which contain several projects dedicated to the transcription, edition and annotation of documents preserved by the Historical Archives of the Pontifical Gregorian University; the <i>Lexicon of Modernity</i> is an editorial initiative connected to the concepts traceable in the documents published on GATE. You can access and find more information about all these projects by clicking on the Main box sections. ',
 +
attachTo: '#home-sections',
 +
position: 'topLeft',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: false
 +
 
 +
} )
 +
.next( 'Step05' )
 +
.back( 'Step03' );
 +
 
 +
tour.step( {
 +
name: 'Step05',
 +
title: 'Projects description',
 +
description: 'Each project has its own homepage and the larger ones, like the projects in the <i>Monumenta</i> section, can have several sub-sections. E.g. the <i>Monumenta Kircheri</i>, dedicated to the jesuit Athanasius Kircher, is divided in three sections: Correspondence, Works and <i>Bibliographia Kircheriana</i>, each one preceded by a specific introduction.',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: true
 +
 
 +
} )
 +
.next( 'Step06' )
 +
.back( 'Step04' );
 +
 
 +
tour.step( {
 +
name: 'Step06',
 +
title: 'Continue the tour',
 +
description: 'Now to continue your tour, please scroll down the page below the Main box and then click next. ',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: true
 +
} )
 +
.next( 'Step07' )
 +
.back( 'Step05' );
 +
 
 +
tour.step( {
 +
name: 'Step07',
 +
title: 'Homepage board',
 +
description: 'Below the Main box, you can look at what we call the GATE board, a space where there is a preview of some of the GATE contents. ',
 +
attachTo: '#board-title',
 +
position: 'topRight',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: false
 +
 
 +
} )
 +
.next( 'Step08' )
 +
.back( 'Step06' );
 +
 +
tour.step( {
 +
name: 'Step08',
 +
title: 'Homepage board',
 +
description: 'The board has four sections: <b>Featured Page</b>; <b>Focus on</b>; <b>News</b>; <b>Collaborate with us</b>. Scroll the page to the bottom to give a look to each one of them; a basic introduction about their content is provided for each section.',
 +
attachTo: '#featured-page-title',
 +
position: 'topRight',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: false
 +
 
 +
} )
 +
.next( 'Step09' )
 +
.back( 'Step07' );
 +
 
 +
tour.step( {
 +
name: 'Step09',
 +
title: 'Last steps',
 +
description: 'We are almost done! To continue with the last steps of the tour, please scroll the page to the top and then click Next.',
 +
closeOnClickOutside: false,
 +
overlay: false
 +
 
 +
} )
 +
.next( 'Step10' )
 +
.back( 'Step08' );
 +
 
 +
tour.step( {
 +
name: 'Step10',
 +
title: 'Top-bar menu',
 +
description: 'As you probably already noted, on the top of the page there is a bar-menu, that follows the page scrolling and will be always visible on all the pages visited during your navigation. This top-bar menu gives access to all the projects available on GATE, so when you will leave the homepage you will be able to navigate through all the sections using this menu.',
 +
attachTo: '#mw-navigation',
 +
position: 'bottomLeft',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: false
 +
 
 +
} )
 +
.next( 'Step11' )
 +
.back( 'Step09' );
 +
 +
tour.step( {
 +
name: 'Step11',
 +
title: 'Top-bar search',
 +
description: 'The top-bar also allows to launch a query on the whole GATE database by using this search form. Search is performed in the full-text transcriptions of the documents, in their metadata and in the pages about people, subjects etc. created by GATE users. Other search forms are also available within some of the projects, to restrict the search only to their specific content. ',
 +
attachTo: '#searchform',
 
position: 'bottomLeft',
 
position: 'bottomLeft',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 
overlay: false
 
overlay: false
  
 
} )
 
} )
.back( 'Step02' );
+
.next( 'Step12' )
 +
.back( 'Step10' );
 +
 +
tour.step( {
 +
name: 'Step12',
 +
title: 'GATE policy',
 +
description: 'We are at the end of our tour and we want to spend the last words to explain our policy.<br> Everyone can use GATE for her/his own research and read all the available documents and content pages. However GATE is a collaborative project, which benefits from the contribution of <i>active</i> users, who decide to spend some of their time and competence to enrich and improve data available to the whole research community. So we would be very glad if you are willing to give your contribution and collaborate with GATE, helping us in the transcription and edition of our documents.<br> To do so, you will need an account that you can ask by clicking on the <b>Ask for an account</b> button and filling the form - the same form is also accessible in the <b>About</b> section of the top-bar menu by clicking on <b>Contact us</b>.<br> Now to finish your tour, please click on the <b>✓</b> button and start exploring GATE! ',
 +
closeOnClickOutside: false,
 +
autoFocus: false,
 +
overlay: true,
 +
buttons: [ {
 +
// This makes a button which acts like a wikilink to 'Help:Guided tours/guider'
 +
action: 'wikiLink',
 +
page: 'Special:Contact',
 +
name: 'Ask for an account',
 +
// This specifies that the button takes you to the next step of a process,
 +
// which affects its appearance.
 +
type: 'progressive'
 +
}, /*{
 +
// Aggiungere questo bottone quando ci saranno più tour, modificando anche il testo di questo box aggiungendo '<br> By clicking on the <b>More tours</b> button, you can access to other GATE tours and help pages.'
 +
action: 'wikiLink',
 +
page: pageName,
 +
name: 'More tours',
 +
// This specifies that the button takes you to the next step of a process,
 +
// which affects its appearance.
 +
type: 'progressive'
 +
},*/ {
 +
// This makes the okay button on this step end the tour.
 +
action: 'end'
 +
} ] } )
 +
.back( 'Step11' );
 +
// aggiungere tast che linka al form, poi un altro box finale
  
 
// The following should be the last line of your tour.
 
// The following should be the last line of your tour.
 
} ( window, document, jQuery, mediaWiki, mediaWiki.guidedTour ) );
 
} ( window, document, jQuery, mediaWiki, mediaWiki.guidedTour ) );

Latest revision as of 12:49, 28 April 2020

/*
 * Guided Tour to test guided tour features.
 */
// Copy the next line into the start of your tour.
( function ( window, document, $, mw, gt ) {

	// Declare a variable for use later
	var pageName = 'Help:Guided tours',
		tour;

	tour = new gt.TourBuilder( {
		/*
		 * This is the name of the tour.  It must be lowercase, without any hyphen (-) or
		 * period (.) characters.
		 *
		 * The page where you save an on-wiki tour must be named
		 * MediaWiki:Guidedtour-tour-{name}.js , in this example MediaWiki:Guidedtour-tour-mytest.js
		 */
		name: 'gettingStarted',
		shouldLog: false

	} );

	// Information defining each tour step

	// This tour shows a central overlay at the start of the tour.
	// Guiders appear in the center if another position is not specified.
	// To specify the first step of the tour, use .firstStep instead of .step
	tour.firstStep( {
		name: 'Step01',
		title: 'GATE getting started tour',
		description: 'Dear user, <br>thanks for visiting us! GATE is a very wide portal where users can do a lot of wonderful stuff. Some of these are pretty easy, others are more complex. To become familiar with GATE contents and functions, we strongly suggest to any new user to get this tour. It will take just two minutes!',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: true
	} )
	.next( 'Step02' );

	tour.step( {
		name: 'Step02',
		title: 'Tour tips',
		description: 'Before starting, just a few tips about the tour.<br> You can move among the steps using the <b>Previous</b> (<b><</b>) and <b>Next</b> (<b>></b>) buttons at the bottom of each box.<br> Please, before clicking on any link and exploring GATE, we ask you to continue the tour until the last step. Anyway, if you want, you can quit the tour using the <b>X</b> button on the top-right of the box; it\'s possible to restart the tour whenever you want by clicking on the same link. <br> Now let\'s start the tour!',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: true

	} )
	.next( 'Step03' )
	.back( 'Step01' );

	tour.step( {
		name: 'Step03',
		title: 'Homepage',
		description: 'This is the GATE homepage. Welcome again! ',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: true

	} )
	.next( 'Step04' )
	.back( 'Step02' );
	
	tour.step( {
		name: 'Step04',
		title: 'Homepage main box',
		description: 'In this box - we will refer to it as the <b>Main box</b> - you have a preview of some of the projects hosted on GATE: <i>Monumenta</i> and <i>Collections</i> are two sections which contain several projects dedicated to the transcription, edition and annotation of documents preserved by the Historical Archives of the Pontifical Gregorian University; the <i>Lexicon of Modernity</i> is an editorial initiative connected to the concepts traceable in the documents published on GATE. You can access and find more information about all these projects by clicking on the Main box sections. ',
		attachTo: '#home-sections',
		position: 'topLeft',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: false

	} )
	.next( 'Step05' )
	.back( 'Step03' );

	tour.step( {
		name: 'Step05',
		title: 'Projects description',
		description: 'Each project has its own homepage and the larger ones, like the projects in the <i>Monumenta</i> section, can have several sub-sections. E.g. the <i>Monumenta Kircheri</i>, dedicated to the jesuit Athanasius Kircher, is divided in three sections: Correspondence, Works and <i>Bibliographia Kircheriana</i>, each one preceded by a specific introduction.',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: true

	} )
	.next( 'Step06' )
	.back( 'Step04' );

	tour.step( {
		name: 'Step06',
		title: 'Continue the tour',
		description: 'Now to continue your tour, please scroll down the page below the Main box and then click next. ',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: true
	} )
	.next( 'Step07' )
	.back( 'Step05' );

	tour.step( {
		name: 'Step07',
		title: 'Homepage board',
		description: 'Below the Main box, you can look at what we call the GATE board, a space where there is a preview of some of the GATE contents. ',
		attachTo: '#board-title',
		position: 'topRight',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: false

	} )
	.next( 'Step08' )
	.back( 'Step06' );
	
	tour.step( {
		name: 'Step08',
		title: 'Homepage board',
		description: 'The board has four sections: <b>Featured Page</b>; <b>Focus on</b>; <b>News</b>; <b>Collaborate with us</b>. Scroll the page to the bottom to give a look to each one of them; a basic introduction about their content is provided for each section.',
		attachTo: '#featured-page-title',
		position: 'topRight',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: false

	} )
	.next( 'Step09' )
	.back( 'Step07' );

	tour.step( {
		name: 'Step09',
		title: 'Last steps',
		description: 'We are almost done! To continue with the last steps of the tour, please scroll the page to the top and then click Next.',
		closeOnClickOutside: false,
		overlay: false

	} )
	.next( 'Step10' )
	.back( 'Step08' );

	tour.step( {
		name: 'Step10',
		title: 'Top-bar menu',
		description: 'As you probably already noted, on the top of the page there is a bar-menu, that follows the page scrolling and will be always visible on all the pages visited during your navigation. This top-bar menu gives access to all the projects available on GATE, so when you will leave the homepage you will be able to navigate through all the sections using this menu.',
		attachTo: '#mw-navigation',
		position: 'bottomLeft',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: false

	} )
	.next( 'Step11' )
	.back( 'Step09' );
	
	tour.step( {
		name: 'Step11',
		title: 'Top-bar search',
		description: 'The top-bar also allows to launch a query on the whole GATE database by using this search form. Search is performed in the full-text transcriptions of the documents, in their metadata and in the pages about people, subjects etc. created by GATE users. Other search forms are also available within some of the projects, to restrict the search only to their specific content. ',
		attachTo: '#searchform',
		position: 'bottomLeft',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: false

	} )
	.next( 'Step12' )
	.back( 'Step10' );
	
	tour.step( {
		name: 'Step12',
		title: 'GATE policy',
		description: 'We are at the end of our tour and we want to spend the last words to explain our policy.<br> Everyone can use GATE for her/his own research and read all the available documents and content pages. However GATE is a collaborative project, which benefits from the contribution of <i>active</i> users, who decide to spend some of their time and competence to enrich and improve data available to the whole research community. So we would be very glad if you are willing to give your contribution and collaborate with GATE, helping us in the transcription and edition of our documents.<br> To do so, you will need an account that you can ask by clicking on the <b>Ask for an account</b> button and filling the form - the same form is also accessible in the <b>About</b> section of the top-bar menu by clicking on <b>Contact us</b>.<br> Now to finish your tour, please click on the <b>✓</b> button and start exploring GATE! ',
		closeOnClickOutside: false,
		autoFocus: false,
		overlay: true,
		buttons: [ {
			// This makes a button which acts like a wikilink to 'Help:Guided tours/guider'
			action: 'wikiLink',
			page: 'Special:Contact',
			name: 'Ask for an account',
			// This specifies that the button takes you to the next step of a process,
			// which affects its appearance.
			type: 'progressive'
		}, /*{
			// Aggiungere questo bottone quando ci saranno più tour, modificando anche il testo di questo box aggiungendo '<br> By clicking on the <b>More tours</b> button, you can access to other GATE tours and help pages.'
			action: 'wikiLink',
			page: pageName,
			name: 'More tours',
			// This specifies that the button takes you to the next step of a process,
			// which affects its appearance.
			type: 'progressive'
		},*/ {
			// This makes the okay button on this step end the tour.
			action: 'end'
		} ]	} )
	.back( 'Step11' );
// aggiungere tast che linka al form, poi un altro box finale

// The following should be the last line of your tour.
} ( window, document, jQuery, mediaWiki, mediaWiki.guidedTour ) );