$lang['tuto'] = "opplæringsprogrammer"; ?>$lang['tuto'] = "opplæringsprogrammer"; ?>$lang['tuto'] = "opplæringsprogrammer"; ?> Slik legger du til Utskrivbar versjon til

Slik legger du til "Utskrivbar versjon" til MediaWiki-navigasjonsmenyen

Mia Chevalier
Torsdag 26. desember 2024 17:28:28
Sidebar

Forbedre MediaWiki-navigasjonsmenyen

Tilpassing av MediaWiki-navigasjonsmenyen kan forbedre brukeropplevelsen betraktelig, noe som gir mer tilgjengelige og funksjonelle verktøy. Hvis du kjører MediaWiki 1.39 med Timeless-temaet, kan det hende du synes det er utfordrende å legge til spesifikke alternativer som "Utskrivbar versjon." Denne oppgaven er ikke enkel på grunn av de unike konfigurasjonene til sidefeltmenyen.

Et vanlig mål blant administratorer er å gi brukerne en rask måte å få tilgang til utskriftsbare sider. Denne funksjonen er viktig for miljøer der det ofte refereres til offline- eller papirmateriale, for eksempel akademiske eller bedriftswikier. Imidlertid opplever mange at prosessen er mindre intuitiv enn forventet. 🖨️

I denne veiledningen vil vi utforske hvordan du kan inkludere koblingen "Utskrivbar versjon" i navigasjonsmenyen, spesielt under alternativet "Tilfeldig side". Bruk av MediaWiki:Sidebar for modifikasjoner krever en solid forståelse av syntaksen og virkemåten innenfor Timeless-temaet.

Hvis du står fast eller støter på problemer, ikke bekymre deg! Mot slutten av denne gjennomgangen vil du ikke bare vite hvordan du implementerer endringen, men også få innsikt i hvordan MediaWiki-sidepanelet fungerer. La oss dykke ned i denne praktiske forbedringen. 🌟

Kommando Eksempel på bruk
$wgHooks['SkinBuildSidebar'][] Denne kommandoen registrerer en tilpasset krok i MediaWiki som gjør det mulig å endre sidefeltstrukturen under gjengivelsen. Det er spesifikt for å tilpasse navigasjonsmenyer dynamisk.
$skin->$skin->msg() Henter lokaliserte meldinger eller lenker i MediaWiki. I denne sammenhengen henter den dynamisk URL-en til funksjonen "Utskrivbar versjon" ved hjelp av innebygde språkinnstillinger.
document.addEventListener('DOMContentLoaded') Sikrer at JavaScript-logikken bare kjøres etter at DOM-en er fulllastet, noe som er avgjørende for dynamisk endring av en eksisterende navigasjonsmeny.
document.createElement() Oppretter nye HTML-elementer, som li og a-tagger, som legges til navigasjonsmenyen dynamisk i front-end-løsningen.
arrayHasKey Brukes i enhetstester for å verifisere om en bestemt nøkkel finnes i en matrise, for å sikre at alternativet "Utskrivbar versjon" ble lagt til i sidefeltstrukturen på riktig måte.
if (!defined('MEDIAWIKI')) Sikrer at skriptet kjøres innenfor MediaWiki-rammeverket, og forhindrer uautorisert eller frittstående kjøring.
$GLOBALS['wgHooks'] Får tilgang til globale kroker i MediaWiki, som gjør det mulig for utviklere å legge til eller endre funksjonalitet dynamisk på bestemte punkter i applikasjonens livssyklus.
link.href Angir URL-en til en nyopprettet hyperkobling dynamisk i JavaScript, og legger til søkeparametere som ?printable=yes for å aktivere den utskrivbare versjonen.
SkinBuildSidebar En spesifikk MediaWiki-krok som tillater direkte manipulering av sidefeltelementene, noe som gjør den svært relevant for å legge til nye lenker eller menyelementer.
TestCase::createMock() Oppretter falske objekter for enhetstesting, og simulerer MediaWikis Skin-klasse for å validere sidefeltmodifikasjoner uten å kreve en full MediaWiki-forekomst.

Slik tilpasser du MediaWiki-navigasjonsmenyen

Skriptene ovenfor fokuserer på å forbedre MediaWiki-navigasjonsmenyen ved å legge til et "Utskrivbar versjon"-alternativ under koblingen "Tilfeldig side". Denne modifikasjonen kan oppnås gjennom backend-tilpasning ved å bruke kroker eller frontend-skripting med JavaScript. For eksempel utnytter PHP-skriptet array og "SkinBuildSidebar"-kroken for å dynamisk sette inn et nytt navigasjonselement. Denne tilnærmingen sikrer at tillegget integreres sømløst med den eksisterende sidefeltstrukturen, og tilpasser seg forskjellige skinn som Timeless-temaet. 🖥️

Frontend JavaScript-løsningen gir et mer dynamisk alternativ, og retter seg mot navigasjonsmenyen etter at DOM-en er fulllastet. Ved å bruke kommandoer som og ved å legge til nyopprettede listeelementer til navigasjonsmenyen, krever denne metoden ikke å endre backend-koden. For eksempel kan en universitetswiki raskt implementere funksjonen "Utskrivbar versjon" for studenter som får tilgang til kursmateriell, og sikre minimal forstyrrelse av live-nettstedet. Denne fleksibiliteten gjør den ideell for situasjoner der backend-tilgang er begrenset eller utilgjengelig. 📄

Et annet viktig aspekt ved de medfølgende skriptene er deres modularitet og fokus på beste praksis. PHP-skriptet inkluderer feilhåndtering for å sikre at det bare kjører innenfor MediaWiki-rammeverket. På samme måte validerer JavaScript-logikken tilstedeværelsen av navigasjonsmenyen før du forsøker å endre den, noe som reduserer risikoen for kjøretidsfeil. For eksempel, i en bedriftswiki, er det avgjørende å sikre pålitelighet, siden sidefeltet ofte er et sentralt navigasjonssenter for ansatte som får tilgang til prosjektdokumenter eller rapporter.

Enhetstestene utfyller skriptene ved å verifisere at koblingen "Utskrivbar versjon" er riktig lagt til i forskjellige scenarier. Ved å simulere MediaWiki-miljøet ved hjelp av falske objekter, sikrer disse testene at løsningen fungerer på tvers av ulike konfigurasjoner. Denne testprosessen er spesielt verdifull for utviklere som administrerer flere wikier, siden den gir en beskyttelse mot distribusjonsproblemer. Til syvende og sist, enten gjennom PHP backend-hooks, frontend JavaScript eller robust enhetstesting, tilbyr skriptene allsidige metoder for å forbedre MediaWiki-navigasjonen med optimal ytelse og pålitelighet. 🌟

Legge til et "Utskrivbar versjon"-alternativ i MediaWiki Navigation

Server-side script for å endre MediaWiki Sidebar-konfigurasjonen ved hjelp av PHP.

//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
//

Bruke MediaWiki Sidebar-konfigurasjon for å legge til nye lenker

Manuell metode for å redigere MediaWiki:Sidebar-siden i Timeless-temaet.

* 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.

Dynamisk front-end JavaScript-løsning

Skript på klientsiden som bruker JavaScript for dynamisk å legge til alternativet "Utskrivbar versjon".

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);
    }
});

Enhetstester for modifikasjoner av sidefelt

PHP Unit tester for å validere "Utskriftbar versjon"-integrasjon på backend.

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.

Forbedre MediaWiki med avanserte tilpasninger

Å legge til egendefinerte funksjoner i en MediaWiki-forekomst kan gå utover enkle endringer i navigasjonsmenyen. For eksempel søker administratorer ofte måter å forbedre funksjonaliteten for spesifikke brukerbehov, for eksempel å integrere eksportalternativer eller tilpasse oppsett basert på brukerroller. Disse forbedringene, inkludert å legge til en "utskrivbar versjon", er avgjørende for å gjøre wikier mer dynamiske og brukervennlige. Integreringen av nye lenker i kan skreddersys for å matche de unike kravene til en universitetsportal eller intern bedriftsdokumentasjon.

Et område som er verdt å utforske er lokaliseringen av nylig lagt til menyalternativer. For eksempel, å sikre at "Utskriftbar versjon"-etiketten oversettes dynamisk basert på brukerens språkpreferanser, legger til et lag med inkluderende. Ved å bruke MediaWikis innebygde lokaliseringsmetoder, som f.eks , lar utviklere tilpasse tilpasningene sine til MediaWikis globale standarder. Dette er spesielt nyttig i multinasjonale organisasjoner der ansatte eller bidragsytere får tilgang til wikien på flere språk. 🌍

En annen viktig faktor er samspillet mellom tilpasninger og det valgte MediaWiki-temaet. De , for eksempel, bruker en unik struktur som krever testing av eventuelle endringer grundig for å sikre kompatibilitet. For eksempel kan et visuelt fremtredende navigasjonselement som "Utskrivbar versjon" trenge ytterligere CSS-justeringer for å opprettholde utseendet på tvers av enheter. Disse nyanserte modifikasjonene sikrer at grensesnittet forblir intuitivt og profesjonelt uavhengig av brukerens enhet eller skjermstørrelse. 📱

  1. Hvordan kan jeg redigere MediaWiki-sidefeltet?
  2. Du kan redigere sidefeltet ved å endre MediaWiki:Sidefeltsiden. Bruk kommandoer som og for å definere nye lenker.
  3. Hva er "Tidløs"-temaet, og hvordan påvirker det tilpasning?
  4. The Timeless-temaet er et moderne MediaWiki-skall med responsiv design. Tilpasninger som endringer i sidefeltet kan kreve ytterligere testing for å sikre at de vises riktig.
  5. Er det mulig å legge til lokalisering for nye sidefeltalternativer?
  6. Ja, du kan bruke for å hente lokaliserte etiketter for menyelementene dine, noe som sikrer kompatibilitet med flerspråklige wikier.
  7. Kan jeg legge til nye funksjoner uten å endre backend-koden?
  8. Ja, frontend JavaScript-løsninger som å bruke lar deg legge til lenker eller funksjoner dynamisk uten endringer i backend.
  9. Hvordan tester jeg nye sidefeltfunksjoner?
  10. Ved å bruke PHP-enhetstester eller et testrammeverk som PHPUnit, simuler sidefeltmodifikasjoner for å sikre at de fungerer som forventet.

Å legge til alternativet "Utskrivbar versjon" i MediaWiki-navigasjonen gir større brukervennlighet og organisering til wikien din. Med tilnærmingene beskrevet her, fra PHP-skripting til JavaScript, er tilpasning tilgjengelig og effektiv for alle administratorer.

Ved å prioritere lokalisering og temakompatibilitet, blir wikien din en pålitelig ressurs for ulike målgrupper. Disse forbedringene forbedrer ikke bare funksjonaliteten, men gir også en brukervennlig opplevelse, som gjenspeiler en godt vedlikeholdt og tilgjengelig plattform. 🌟

  1. Offisiell MediaWiki-dokumentasjon om tilpasning av sidefelt: Manual for MediaWiki Sidebar
  2. Samfunnsdiskusjon og eksempler på tidløse temakonfigurasjoner: MediaWiki tidløst tema
  3. Eksempelbilde som illustrerer navigasjonsmenyoppsettet: Eksempel på navigasjonsmeny
  4. PHP-dokumentasjon for kroker og utvidelser: PHP-håndbok