Sådan tilføjes "Printbar version" til MediaWiki-navigationsmenuen

Forbedring af din MediaWiki-navigationsmenu

Tilpasning af din MediaWiki-navigationsmenu kan forbedre brugeroplevelsen betydeligt, hvilket giver mulighed for mere tilgængelige og funktionelle værktøjer. Hvis du kører MediaWiki 1.39 med Timeless-temaet, kan du finde det udfordrende at tilføje specifikke muligheder som "Udskrivbar version." Denne opgave er ikke ligetil på grund af de unikke konfigurationer af sidebjælkemenuen.

Et fælles mål blandt administratorer er at give brugerne en hurtig måde at få adgang til udskrivbare sider. Denne funktion er vigtig for miljøer, hvor der ofte refereres til offline- eller papirmaterialer, såsom akademiske eller virksomhedswikier. Mange finder dog processen mindre intuitiv end forventet. 🖨️

I denne vejledning vil vi undersøge, hvordan du inkorporerer linket "Udskrivbar version" i navigationsmenuen, specifikt under indstillingen "Tilfældig side". Brug af MediaWiki:Sidebjælken til ændringer kræver en solid forståelse af dens syntaks og adfærd inden for Timeless-temaet.

Hvis du sidder fast eller støder på problemer, så fortvivl ikke! Ved slutningen af ​​denne gennemgang vil du ikke kun vide, hvordan du implementerer ændringen, men også få indsigt i, hvordan MediaWiki-sidebjælken fungerer. Lad os dykke ned i denne praktiske forbedring. 🌟

Sådan tilpasser du MediaWiki-navigationsmenuen

De scripts, der er angivet ovenfor, fokuserer på at forbedre MediaWiki-navigationsmenuen ved at tilføje en "Udskrivbar version"-mulighed under linket "Tilfældig side". Denne modifikation kan opnås gennem backend-tilpasning ved hjælp af hooks eller frontend-scripting med JavaScript. For eksempel udnytter PHP-scriptet $wgHooks array og "SkinBuildSidebar"-krogen for dynamisk at indsætte et nyt navigationselement. Denne tilgang sikrer, at tilføjelsen integreres problemfrit med den eksisterende sidebjælkestruktur og tilpasser sig forskellige skins som Timeless-temaet. 🖥️

Frontend JavaScript-løsningen giver et mere dynamisk alternativ, målrettet mod navigationsmenuen, efter at DOM er fuldt indlæst. Ved at bruge kommandoer som document.createElement og tilføjelse af nyoprettede listeelementer til navigationsmenuen, kræver denne metode ikke ændring af backend-koden. For eksempel kunne en universitetswiki hurtigt implementere funktionen "Udskrivbar version" for studerende, der får adgang til kursusmaterialer, hvilket sikrer minimal forstyrrelse af live-webstedet. Denne fleksibilitet gør den ideel til situationer, hvor backend-adgang er begrænset eller utilgængelig. 📄

Et andet nøgleaspekt af de leverede scripts er deres modularitet og fokus på bedste praksis. PHP-scriptet inkluderer fejlhåndtering for at sikre, at det kun kører inden for MediaWiki-rammen. På samme måde validerer JavaScript-logikken tilstedeværelsen af ​​navigationsmenuen, før den forsøger at ændre den, hvilket reducerer risikoen for runtime-fejl. For eksempel i en virksomhedswiki er det afgørende at sikre pålidelighed, da sidebjælken ofte er en central navigationshub for medarbejdere, der får adgang til projektdokumenter eller -rapporter.

Enhedstestene supplerer scripts ved at verificere, at linket "Printbar version" er korrekt tilføjet i forskellige scenarier. Ved at simulere MediaWiki-miljøet ved hjælp af falske objekter sikrer disse test, at løsningen fungerer på tværs af forskellige konfigurationer. Denne testproces er især værdifuld for udviklere, der administrerer flere wikier, da den giver en beskyttelse mod implementeringsproblemer. I sidste ende, uanset om det er gennem PHP-backend-hooks, frontend JavaScript eller robust enhedstest, tilbyder scripts alsidige metoder til at forbedre MediaWiki-navigation med optimal ydeevne og pålidelighed. 🌟

<?php
// Load MediaWiki's core files
if ( !defined( 'MEDIAWIKI' ) ) {
    die( 'This script must be run from within MediaWiki.' );
}

// Hook into the Sidebar generation
$wgHooks['SkinBuildSidebar'][] = function ( &$sidebar, $skin ) {
    // Add the "Printable version" link below "Random page"
    $sidebar['navigation'][] = [
        'text' => 'Printable version',
        'href' => $skin->msg( 'printable' )->inContentLanguage()->text(),
        'id' => 'n-printable-version'
    ];
    return true;
};

// Save this script in a custom extension or LocalSettings.php
?>

* navigation
 mainpage|mainpage-description
 recentchanges-url|recentchanges
 randompage-url|randompage
 printable-version|Printable version
* SEARCH
* TOOLBOX
// Save changes in the MediaWiki:Sidebar special page.
// Ensure "printable-version" message key is properly defined.

document.addEventListener('DOMContentLoaded', function () {
    const navList = document.querySelector('.mw-portlet-navigation ul');
    if (navList) {
        const printableItem = document.createElement('li');
        printableItem.id = 'n-printable-version';
        const link = document.createElement('a');
        link.href = window.location.href + '?printable=yes';
        link.textContent = 'Printable version';
        printableItem.appendChild(link);
        navList.appendChild(printableItem);
    }
});

use PHPUnit\Framework\TestCase;

class SidebarTest extends TestCase {
    public function testPrintableVersionLinkExists() {
        $sidebar = []; // Simulate Sidebar data structure
        $skinMock = $this->createMock(Skin::class);
        $callback = $GLOBALS['wgHooks']['SkinBuildSidebar'][0];
        $this->assertTrue($callback($sidebar, $skinMock));
        $this->assertArrayHasKey('Printable version', $sidebar['navigation']);
    }
}
// Run using PHPUnit to ensure robust testing.

Forbedring af MediaWiki med avancerede tilpasninger

Tilføjelse af brugerdefinerede funktioner til en MediaWiki-instans kan gå ud over simple navigationsmenuændringer. For eksempel søger administratorer ofte måder at forbedre funktionaliteten til specifikke brugerbehov, såsom at integrere eksportmuligheder eller tilpasse layout baseret på brugerroller. Disse forbedringer, herunder tilføjelse af en "udskrivbar version", er afgørende for at gøre wikier mere dynamiske og brugervenlige. Integrationen af ​​nye links i MediaWiki Sidebar kan skræddersyes til at matche de unikke krav til en universitetsportal eller intern virksomhedsdokumentation.

Et område, der er værd at udforske, er lokaliseringen af ​​nyligt tilføjede menuindstillinger. For eksempel, at sikre, at etiketten "Udskrivbar version" er oversat dynamisk baseret på brugerens sprogpræferencer, tilføjer et lag af inklusivitet. Brug af MediaWikis indbyggede lokaliseringsmetoder, som f.eks $skin->msg(), giver udviklere mulighed for at tilpasse deres tilpasninger til MediaWikis globale standarder. Dette er især nyttigt i multinationale organisationer, hvor medarbejdere eller bidragydere får adgang til wikien på flere sprog. 🌍

En anden vigtig overvejelse er samspillet mellem tilpasninger og det valgte MediaWiki-tema. De Tidløst temabruger for eksempel en unik struktur, der kræver, at alle ændringer testes grundigt for at sikre kompatibilitet. For eksempel kan et visuelt fremtrædende navigationselement som "Printbar version" muligvis have brug for yderligere CSS-justeringer for at bevare dets udseende på tværs af enheder. Disse nuancerede modifikationer sikrer, at grænsefladen forbliver intuitiv og professionel uanset brugerens enhed eller skærmstørrelse. 📱