MediaWiki:Guidedtour-tour-newtour.js: Difference between revisions
From ChemWiki
(Added to the wiki via WikiImport-Script.) |
(Added to the wiki via WikiImport-Script.) |
||
Line 3: | Line 3: | ||
*/ | */ | ||
// Copy the next line into the start of your tour. | // Copy the next line into the start of your tour. | ||
( function ( window, document, $, mw, gt ) { | ( function ( window, document, $, mw, gt ) { | ||
var isnav_open = $('#ce-side-panel-content-collapsed')[0].attributes.style ; | |||
var navbarstate = '#ce-side-panel-content-collapsed'; | |||
if (isnav_open == "display:none") { | |||
navbarstate = "#ce-topic-element"; | |||
}; | |||
console.log(navbarstate) | |||
// Declare a variable for use later | // Declare a variable for use later | ||
var pageName = 'Help:Guided tours/newtour', | var pageName = 'Help:Guided tours/newtour', | ||
Line 76: | Line 83: | ||
description: 'Clicking this will bring you to the relevant molecule page. From here you can see experiments that use the selected molecule.', | description: 'Clicking this will bring you to the relevant molecule page. From here you can see experiments that use the selected molecule.', | ||
overlay: false, | overlay: false, | ||
attachTo: ' | attachTo: 'table tr:nth-child(2) td:nth-child(2)', | ||
position: 'left' | position: 'left' | ||
// '#mw-content-text.mw-parser-output.tbody.tr:nth-child(7)' | |||
// This means the wikitext for the description will be loaded from the | // This means the wikitext for the description will be loaded from the | ||
// page name in the description field. | // page name in the description field. | ||
Line 103: | Line 111: | ||
description:"Here is the main topic inside it are sub topics that organize papers on stricter criteria" , | description:"Here is the main topic inside it are sub topics that organize papers on stricter criteria" , | ||
overlay: true, | overlay: true, | ||
attachTo: 'table tr:nth-child(2) td:nth-child(1) div.CategoryTreeItem:first-child' , | |||
position: 'right' | |||
}) | }) | ||
Line 114: | Line 123: | ||
description:"Here is the level at which papers are stored" , | description:"Here is the level at which papers are stored" , | ||
overlay: true, | overlay: true, | ||
attachTo: 'table tr:nth-child(2) td:nth-child(1) div.CategoryTreeChildren div.CategoryTreeSection ' , | |||
position: 'right' | |||
}) | }) | ||
Line 123: | Line 133: | ||
name: "testa", | name: "testa", | ||
title: "test atttach", | title: "test atttach", | ||
description:" | description:"this is the highest level of the Organization" , | ||
// overlay: true, | // overlay: true, | ||
attachTo: "#ce-side-panel-content-collapsed" , | // attachTo: "#ce-side-panel-content-collapsed" , | ||
attachTo: navbarstate, | |||
position: 'right', | position: 'right', | ||
Revision as of 10:15, 8 February 2024
/*
* Guided Tour to test guided tour features.
*/
// Copy the next line into the start of your tour.
( function ( window, document, $, mw, gt ) {
var isnav_open = $('#ce-side-panel-content-collapsed')[0].attributes.style ;
var navbarstate = '#ce-side-panel-content-collapsed';
if (isnav_open == "display:none") {
navbarstate = "#ce-topic-element";
};
console.log(navbarstate)
// Declare a variable for use later
var pageName = 'Help:Guided tours/newtour',
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: 'newtour'
} );
// 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: 'intro',
// Note that for on-wiki tours, we use title and description with the actual text.
// The title appears in the title bar of the guider.
title: 'Welcome',
// The description appears in the body
description: 'Welcome to the Introduction tour for MediaWiki',
// This specifies that there is an overlay behind the guider.
overlay: true
} )
// This specifies the next step of the tour, and will automatically generate a next button.
// 'callout' refers to the name used in the step immediately below. Although putting the steps
// in a meaningful order is recommended, any step can be specified as next/back.
.next( 'homebutton' );
tour.step( {
/*
* Callout of left menu
*/
name: 'homebutton',
title: 'Home Button',
description: 'Here is the home buttton click here to return to the home page',
// This positions the guider next to a page element, in this
// case the portal link (which is "Community portal" on English
// Wikipedia, but varies by site).
// The string is a jQuery selector. "#n-portal" means the HTML
// element with this id attribute, and "a" means an a, or link,
// element inside that.
attachTo: '#mw-navigation a',
// This means the guider shows to the right of the Community Portal link
position: 'right',
} )
.next( 'feat_mol' )
// The 'back' property specifies that you can go back from this step, and where to go
// if the back button is clicked.
.back( 'intro' );
tour.step( {
/*
* Test out mediawiki description pages
*/
name: 'feat_mol',
title: 'Featured Molecule',
// Name of the page to parse
description: 'Clicking this will bring you to the relevant molecule page. From here you can see experiments that use the selected molecule.',
overlay: false,
attachTo: 'table tr:nth-child(2) td:nth-child(2)',
position: 'left'
// '#mw-content-text.mw-parser-output.tbody.tr:nth-child(7)'
// This means the wikitext for the description will be loaded from the
// page name in the description field.
// onShow: gt.getPageAsDescription,
// buttons: [ {
// // This makes a button which acts like a wikilink to 'Help:Guided tours/mytest'
// action: 'wikiLink',
// page: pageName,
// name: 'Go to description page',
// // 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'
// } ]
} )
.next("m_topic")
.back( 'homebutton' );
tour.step( {
name: "m_topic",
title: "Main Topic",
description:"Here is the main topic inside it are sub topics that organize papers on stricter criteria" ,
overlay: true,
attachTo: 'table tr:nth-child(2) td:nth-child(1) div.CategoryTreeItem:first-child' ,
position: 'right'
})
.next("pub")
.back("feat_mol");
tour.step( {
name: "pub",
title: "Publication",
description:"Here is the level at which papers are stored" ,
overlay: true,
attachTo: 'table tr:nth-child(2) td:nth-child(1) div.CategoryTreeChildren div.CategoryTreeSection ' ,
position: 'right'
})
.next("testa")
.back("m_topic");
tour.step( {
name: "testa",
title: "test atttach",
description:"this is the highest level of the Organization" ,
// overlay: true,
// attachTo: "#ce-side-panel-content-collapsed" ,
attachTo: navbarstate,
position: 'right',
})
// .next()
.back("pub");
// The following should be the last line of your tour.
} ( window, document, jQuery, mediaWiki, mediaWiki.guidedTour ) );