MediaWiki:Guidedtour-tour-wwiiarchtour.js: Difference between revisions

From WWII Archives

No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 11: Line 11:
return ( mw.config.get( 'wgCanonicalNamespace' ) === '' && mw.config.get( 'wgIsProbablyEditable' ) );
return ( mw.config.get( 'wgCanonicalNamespace' ) === '' && mw.config.get( 'wgIsProbablyEditable' ) );
}
}


tour = new gt.TourBuilder( {
tour = new gt.TourBuilder( {
Line 26: Line 28:
name: 'firstmsg',
name: 'firstmsg',
title: 'Welcome to the WWII Archives!',
title: 'Welcome to the WWII Archives!',
description: 'Here you will be able to do a great many things!',
description: 'Here you will be able to contribute to writing the most detailed articles on any subject from the WWII era. You will be able to digitize documents, interview survivors and vets, among other things. On this tour we will show you how to easily contribute and use the site.',
overlay: true
overlay: true
} )
} )
.next( 'callout' );
.next( 'letsgetstarted' );


tour.step( {
tour.step( {
Line 35: Line 37:
* Callout of left menu
* Callout of left menu
*/
*/
name: 'callout',
name: 'letsgetstarted',
titlemsg: 'guidedtour-tour-test-callouts',
title: 'Let\'s get started!',
descriptionmsg: 'guidedtour-tour-test-portal-description',
description: 'Click the continue button to start',
// attachment
// attachment
attachTo: '#n-portal a',
attachTo: '#n-portal a',
position: '3'
position: '3'
} )
} )
.next( 'descriptionwikitext' )
.next( 'warning' )
.back( 'overlay' );
.back( 'firstmsg' );


tour.step( {
tour.step( {
name: 'descriptionwikitext',
name: 'warning',
titlemsg: 'guidedtour-tour-test-mediawiki-parse',
title: 'Feel like leaving?',
// This deliberately does not use descriptionmsg in order to demonstrate
description: 'If you would like to exit out of the tour, click the x. Warning, if you do and would like to come back, you would have to restart the tour. If you need to come back to the tour page, find it under tools here',
// API-based parsing as used by some on-wiki tours.
attachTo: '#menu-item_3',
// Normal Extension tours should use descriptionmsg.
description: new gt.WikitextDescription( mw.message( 'guidedtour-tour-test-wikitext-description' ).plain() ),
attachTo: '#searchInput',
// try descriptive position (5'oclock) and use skin-specific value
// try descriptive position (5'oclock) and use skin-specific value
position: {
position: 'left'
fallback: 'bottomRight',
monobook: 'right'
}
} )
} )
.next( pageName ? 'descriptionpage' : 'launchtour' )
.next( 'skip' )
.back( 'callout' );
.back( 'letsgetstarted' );
 
if ( pageName ) {
tour.step( {
tour.step( {
name: 'skip',
/*
title: 'Want to skip to editing and uploading?',
* Test out mediawiki description pages
description: 'If you want to skip the basic intro to the site and instead want to learn to start editing, you may start by clicking on the link for the editing part of the tour below.',
*/
attachTo: '#n-portal a',
name: 'descriptionpage',
position: '3'
titlemsg: 'guidedtour-tour-test-description-page',
})
description: new mw.Title( pageName ),
.next( 'gotomainpage' )
 
.back( 'warning' );
overlay: true,
 
buttons: [ {
action: 'wikiLink',
page: pageName,
namemsg: 'guidedtour-tour-test-go-description-page',
type: 'progressive'
} ]
} )
.next( 'launchtour' )
.back( 'descriptionwikitext' );
}
 
launchTourButtons = [ {
action: 'end'
} ];
 
if ( shouldShowFirstEdit() ) {
launchTourButtons.unshift( {
namemsg: 'guidedtour-tour-test-launch-editing',
onclick: function () {
gt.endTour();
gt.launchTour( 'firstedit' );
}
} );
}
 
/*
* Test out tour launching
*/
tour.step( {
tour.step( {
name: 'launchtour',
name: 'gotomainpage',
titlemsg: 'guidedtour-tour-test-launch-tour',
title: 'Go to the Main Page',
descriptionmsg: 'guidedtour-tour-test-launch-tour-description',
description: 'First, go to the Main Archives Page by clicking on it under "Navigation"',
 
attachTo: '#menu-item_1',
// attachment
position: 'top',
overlay: true,
buttons: [ {
 
// This makes a button which acts like a wikilink to 'Help:Guided tours/guider'
buttons: launchTourButtons
action: 'wikiLink',
page: 'WWII_Archives:Home',
name: 'Go to Main Page',
// This specifies that the button takes you to the next step of a process,
// which affects its appearance.
type: 'progressive'
} ]
} )
.back( 'warning' );
tour.step ( {
name: 'mainpage',
title: 'Welcome to the Main Page!',
} )
} )
.back( pageName ? 'descriptionpage' : 'descriptionwikitext' );
.next( '' )
.back( 'gotomainpage' );
/*.next( pageName ? 'descriptionpage' : 'launchtour' )
.back( 'callout' );*/
}( mw.guidedTour ) );
}( mw.guidedTour ) );

Latest revision as of 13:48, 12 February 2024

/*
 * Guided Tour to test guided tour features.
 */
( function ( gt ) {
	// XXX (mattflaschen, 2012-01-02): See GuidedTourHooks.php
	var tour, launchTourButtons,
		pageName = mw.config.get( 'wgGuidedTourHelpGuiderUrl' );

	// Should match shouldShowForPage from firstedit.js
	function shouldShowFirstEdit() {
		return ( mw.config.get( 'wgCanonicalNamespace' ) === '' && mw.config.get( 'wgIsProbablyEditable' ) );
	}
	
	

	tour = new gt.TourBuilder( {
		/*
		 * This is the name of the tour.  It must be lowercase, without any hyphen (-) or
		 * period (.) characters.
		 *
		 * If this is an on-wiki tour, it should match the MediaWiki page.  For instance,
		 * if this were on-wiki, it would be MediaWiki:Guidedtour-tour-test.js
		 */
		name: 'wwiiarchtour'
	} );

	tour.firstStep( {
		name: 'firstmsg',
		title: 'Welcome to the WWII Archives!',
		description: 'Here you will be able to contribute to writing the most detailed articles on any subject from the WWII era. You will be able to digitize documents, interview survivors and vets, among other things. On this tour we will show you how to easily contribute and use the site.',
		overlay: true
	} )
		.next( 'letsgetstarted' );

	tour.step( {
		/*
		 * Callout of left menu
		 */
		name: 'letsgetstarted',
		title: 'Let\'s get started!',
		description: 'Click the continue button to start',
		// attachment
		attachTo: '#n-portal a',
		position: '3'
	} )
		.next( 'warning' )
		.back( 'firstmsg' );

	tour.step( {
		name: 'warning',
		title: 'Feel like leaving?',
		description: 'If you would like to exit out of the tour, click the x. Warning, if you do and would like to come back, you would have to restart the tour. If you need to come back to the tour page, find it under tools here',
		attachTo: '#menu-item_3',
		// try descriptive position (5'oclock) and use skin-specific value
		position: 'left'
	} )
		.next( 'skip' )
		.back( 'letsgetstarted' );
		
	tour.step( {
		name: 'skip',
		title: 'Want to skip to editing and uploading?',
		description: 'If you want to skip the basic intro to the site and instead want to learn to start editing, you may start by clicking on the link for the editing part of the tour below.',
		attachTo: '#n-portal a',
		position: '3'
	})
		.next( 'gotomainpage' )
		.back( 'warning' );
		
	tour.step( {
		name: 'gotomainpage',
		title: 'Go to the Main Page',
		description: 'First, go to the Main Archives Page by clicking on it under "Navigation"',
		attachTo: '#menu-item_1',
		position: 'top',
		buttons: [ {
			// This makes a button which acts like a wikilink to 'Help:Guided tours/guider'
			action: 'wikiLink',
			page: 'WWII_Archives:Home',
			name: 'Go to Main Page',
			// This specifies that the button takes you to the next step of a process,
			// which affects its appearance.
			type: 'progressive'
		} ]
		
	} )
	
		.back( 'warning' );
		
		
	tour.step ( {
		name: 'mainpage',
		title: 'Welcome to the Main Page!',
		
	} )
	.next( '' )
	.back( 'gotomainpage' );
	
	
		/*.next( pageName ? 'descriptionpage' : 'launchtour' )
		.back( 'callout' );*/
}( mw.guidedTour ) );