MediaWiki

Gadget-breadcrumbs.js

From Dogcraft Wiki

m (space >> underscore)
(rework: proper html element creation and handling, better functions and now adds "Main page > Special pages > pagename" in the Special namespace)
Line 1: Line 1:
$(document).ready(function() {
$(document).ready(function() {
var config =  mw.config.get([
"wgIsArticle",
"wgNamespaceNumber",
"wgCategories",
"wgTitle"
]);
function worldCat( pageCats ) {
function worldCat( pageCats ) {
var world;
for (var i = 0; i < pageCats.length; i++) {
for (var i = 0; i < pageCats.length; i++) {
if ( pageCats[i].indexOf('Survival ') > -1) {
if ( pageCats[i].indexOf('Survival ') > -1) {
    world = pageCats[i] + '';
    return pageCats[i].toString();
        return world;
}
}
}
}
return "";
return '';
}
}
var config = mw.config.get([
function simpleAddCat( categories, breadcrumb ) {
"wgIsArticle",
if (categories.includes( breadcrumb )) {
"wgNamespaceNumber",
links.push( breadcrumb );
"wgCategories",
}
"wgTitle"
}
]);
function htmlElementBuilder( type, config = {}) {
var elem = document.createElement( type.toString() );
if (typeof config.id !== 'undefined') { elem.id = config.id; }
if (typeof config.classList !== 'undefined') { elem.classList = config.classList; }
if (typeof config.textContent !== 'undefined') { elem.textContent = config.textContent; }
if (type === 'a' && typeof config.href !== 'undefined') { elem.href = config.href; }
return elem;
}
/* creates a single breadcrumb link */
function crumbBuilder( target, name ) {
var crumb = htmlElementBuilder('a', { href: '/wiki/' + target });
crumb.appendChild( htmlElementBuilder('span', { textContent: name.toString() }) );
return crumb;
}
function breadcrumbsBuilder( crumbs, fullcrumbs = false ) {
var container = htmlElementBuilder('div', {id: 'breadcrumbs'});
container.appendChild( htmlElementBuilder('a', { href: '/wiki/Main_Page' })
.appendChild( htmlElementBuilder('span', { textContent: 'Main Page' }) )
);
if ( fullcrumbs ) {
crumbs.forEach( function( elem ) { container.appendChild( elem ); });
}
else {
// creates <a> elements from the links list
crumbs.forEach( function( elem ) {
var crumb = crumbBuilder( 'Category:' + elem, elem.toString() );
container.appendChild( crumb );
});
}
container.appendChild( htmlElementBuilder('span', {textContent: config.wgTitle}) );
return container;
}
/* special pages */
if ( config.wgNamespaceNumber == -1) {
$('.top .indicators').prepend( breadcrumbsBuilder( [crumbBuilder( 'Special:SpecialPages', 'Special pages')], true ) );
}
/* articles */
if ( config.wgIsArticle && ( config.wgNamespaceNumber == 0 && config.wgTitle !== "Main Page")) {
if ( config.wgIsArticle && ( config.wgNamespaceNumber == 0 && config.wgTitle !== "Main Page")) {
//var namespace = mw.config.get('wgFormattedNamespaces')[mw.config.get('wgNamespaceNumber')];
/* creates and fills links[] based on page categories */
var serverInfo = "",
var serverInfo = "",
siteContent = "",
siteContent = "",
Line 34: Line 86:
],
],
pageCategories = config.wgCategories,
pageCategories = config.wgCategories,
links = [],
links = [];
crumbs = "<a href='/wiki/Main_Page'><span>Main Page</span></a>";
if (pageCategories.includes('Site Content')) {
simpleAddCat( pageCategories, "Site Content");
links.push( "Site Content" );
simpleAddCat( pageCategories, "Server Information");
}
if (pageCategories.includes('Server Information')) {
links.push( "Server Information" );
}
var world = '';
if ( worldCat( pageCategories ) !== "") {
if ( worldCat( pageCategories ) !== "") {
links.push( worldCat( pageCategories ) );
links.push( worldCat( pageCategories ) );
Line 67: Line 112:
}
}
}
}
}
}
else
else
Line 81: Line 125:
}
}
if (pageCategories.includes('Lists')) {
simpleAddCat( pageCategories, "Lists");
links.push( "Lists" );
}
links.forEach( function( elem ) {
/* creates the breadcrumbs and adds them to the page */
crumbs += '<a href="/wiki/Category:' + elem + '">' + '<span>' + elem + '</span>' + '</a>';
if ( links !== "undefined") {
});
var breadcrumbs = breadcrumbsBuilder( links );
if( links !== "undefined") {
$('.top .indicators').prepend( breadcrumbs );
$('.top .indicators').prepend('<div id="breadcrumbs"></div>');
$('#breadcrumbs').html('' + crumbs + '<span>' + config.wgTitle + '</span>' );
}
}
else { console.log(' Breadcrumbs: links is undefined '); }
else { console.log(' Breadcrumbs: links is undefined '); }
Line 99: Line 137:
}
}
/* this probably should be in Common.js or the Helppage gadget (if thats still a thing) */
if (mw.config.get('wgPageName') === "Rules" || mw.config.get('wgPageName') === "Help_Resources")
if (mw.config.get('wgPageName') === "Rules" || mw.config.get('wgPageName') === "Help_Resources")
{
{
Line 106: Line 145:
$('#breadcrumbs a:first-child').text('Dogcraft.net');
$('#breadcrumbs a:first-child').text('Dogcraft.net');
}
}
 
});
});

Revision as of 23:16, 12 July 2022

$(document).ready(function() {
	var config =  mw.config.get([
		"wgIsArticle",
		"wgNamespaceNumber",
		"wgCategories",
		"wgTitle"
		]);
	
	
	function worldCat( pageCats ) {
		for (var i = 0; i < pageCats.length; i++) {
			if ( pageCats[i].indexOf('Survival ') > -1) {
	    		return pageCats[i].toString();
			}
		}
		return '';
	}
	
	function simpleAddCat( categories, breadcrumb ) {
		if (categories.includes( breadcrumb )) {
			links.push( breadcrumb );
		}		
	}
	
	function htmlElementBuilder( type, config = {}) {
		var elem = document.createElement( type.toString() );
		
		if (typeof config.id !== 'undefined') { elem.id = config.id; }
		if (typeof config.classList !== 'undefined') { elem.classList = config.classList; }
		if (typeof config.textContent !== 'undefined') { elem.textContent = config.textContent; }
		if (type === 'a' && typeof config.href !== 'undefined') { elem.href = config.href; }
		
		return elem;
	}
	
	/* creates a single breadcrumb link */
	function crumbBuilder( target, name ) {
		var crumb = htmlElementBuilder('a', { href: '/wiki/' + target });
		crumb.appendChild( htmlElementBuilder('span', { textContent: name.toString() }) );
		
		return crumb;
	}
	
	function breadcrumbsBuilder( crumbs, fullcrumbs = false ) {
		var container = htmlElementBuilder('div', {id: 'breadcrumbs'});
			
			container.appendChild( htmlElementBuilder('a', { href: '/wiki/Main_Page' })
									 .appendChild( htmlElementBuilder('span', { textContent: 'Main Page' }) ) 
									);
			
			if ( fullcrumbs ) {
				crumbs.forEach( function( elem ) { container.appendChild( elem ); });
			} 
			else {
				// creates <a> elements from the links list 
				crumbs.forEach( function( elem ) {
					var crumb = crumbBuilder( 'Category:' + elem, elem.toString() );
					container.appendChild( crumb );
				});
			}
			
			container.appendChild( htmlElementBuilder('span', {textContent: config.wgTitle}) );
				
			return container;
	}
		
	/* special pages */	
	if ( config.wgNamespaceNumber == -1) {
		$('.top .indicators').prepend( breadcrumbsBuilder( [crumbBuilder( 'Special:SpecialPages', 'Special pages')], true ) );
	}
	
	/* articles */
	if ( config.wgIsArticle && ( config.wgNamespaceNumber == 0 && config.wgTitle !== "Main Page")) {
		/* creates and fills links[] based on page categories */
		var serverInfo = "",
			siteContent = "",
			type = "",
			list = "",
			typeCategories = [
				"Events",
				"Settlements",
				"Groups",
				"Phenomenon",
				"Projects",
				"Worlds"
				],
			pageCategories = config.wgCategories,
			links = [];
		
		simpleAddCat( pageCategories, "Site Content");
		simpleAddCat( pageCategories, "Server Information");
		
		if ( worldCat( pageCategories ) !== "") {
			links.push( worldCat( pageCategories ) );
		}
		
		if (pageCategories.includes('Builds')) {
			links.push( "Builds" );
			for (var i = 0; i < pageCategories.length; i++) {
				switch (pageCategories[i]) {
					case 'Bases':
						links.push( "Bases" );
						break;
					case 'Stations':
						links.push( "Stations" );
						break;
					case 'Shelters':
						links.push( "Shelters" );
						break;
					default:
						break;
				}
			}
		}
		else
		{
			var typesOnPage = pageCategories.filter(function(x){ return typeCategories.includes(x) });
			if ( typesOnPage.length == 1) {
				links.push( typesOnPage[0] + "" );
			}
			else if (typesOnPage.length > 1) {
				console.log('Breadcrumbs: Page has more than one type category');
				links.push( typesOnPage[0] + "" );
			}
		}
		
		simpleAddCat( pageCategories, "Lists");
		
		/* creates the breadcrumbs and adds them to the page */
		if ( links !== "undefined") {
			var breadcrumbs = breadcrumbsBuilder( links );
				
			$('.top .indicators').prepend( breadcrumbs );
		}
		else { console.log(' Breadcrumbs: links is undefined '); }
	
	}
	
	/* this probably should be in Common.js or the Helppage gadget (if thats still a thing) */
	if (mw.config.get('wgPageName') === "Rules" || mw.config.get('wgPageName') === "Help_Resources")
	{
		$('#tagline').hide();
		$('#breadcrumbs > a').slice(1).hide();
		$('#breadcrumbs a:first-child').attr('href', '//dogcraft.net');
		$('#breadcrumbs a:first-child').text('Dogcraft.net');
	}
	
});
This page was last modified on 12 July 2022, at 23:16. (3 months ago)
Background Takeshi by Edo