Come aggiungere la "Versione stampabile" al menu di navigazione di MediaWiki

Migliorare il menu di navigazione di MediaWiki

La personalizzazione del menu di navigazione MediaWiki può migliorare significativamente l'esperienza dell'utente, consentendo strumenti più accessibili e funzionali. Se utilizzi MediaWiki 1.39 con il tema Timeless, potresti trovare difficile aggiungere opzioni specifiche come la "Versione stampabile". Questa attività non è semplice a causa delle configurazioni uniche del menu della barra laterale.

Un obiettivo comune tra gli amministratori è fornire agli utenti un modo rapido per accedere alle pagine stampabili. Questa funzionalità è essenziale per gli ambienti in cui si fa spesso riferimento a materiali offline o cartacei, come i wiki accademici o aziendali. Tuttavia, molti trovano il processo meno intuitivo del previsto. 🖨️

In questa guida esploreremo come incorporare il collegamento "Versione stampabile" nel menu di navigazione, in particolare sotto l'opzione "Pagina casuale". L'utilizzo di MediaWiki:Sidebar per le modifiche richiede una solida conoscenza della sua sintassi e del suo comportamento all'interno del tema Timeless.

Se sei bloccato o riscontri problemi, non preoccuparti! Alla fine di questa procedura dettagliata, non solo saprai come implementare la modifica, ma acquisirai anche informazioni dettagliate su come funziona la barra laterale di MediaWiki. Immergiamoci in questo miglioramento pratico. 🌟

Comando	Esempio di utilizzo
$wgHooks['SkinBuildSidebar'][]	Questo comando registra un hook personalizzato in MediaWiki che consente di modificare la struttura della barra laterale durante il suo rendering. È specifico per personalizzare dinamicamente i menu di navigazione.
$skin->$skin->msg()	Recupera messaggi o collegamenti localizzati in MediaWiki. In questo contesto, recupera dinamicamente l'URL per la funzione "Versione stampabile" utilizzando le impostazioni della lingua integrate.
document.addEventListener('DOMContentLoaded')	Garantisce che la logica JavaScript venga eseguita solo dopo che il DOM è stato completamente caricato, il che è fondamentale per modificare dinamicamente un menu di navigazione esistente.
document.createElement()	Crea nuovi elementi HTML, come li e tag a, che vengono aggiunti dinamicamente al menu di navigazione nella soluzione front-end.
arrayHasKey	Utilizzato negli unit test per verificare se esiste una particolare chiave in un array, assicurando che l'opzione "Versione stampabile" sia stata aggiunta correttamente alla struttura della barra laterale.
if (!defined('MEDIAWIKI'))	Garantisce che lo script venga eseguito all'interno del framework MediaWiki, impedendo l'esecuzione non autorizzata o autonoma.
$GLOBALS['wgHooks']	Accede agli hook globali all'interno di MediaWiki, consentendo agli sviluppatori di aggiungere o modificare funzionalità dinamicamente in punti specifici del ciclo di vita dell'applicazione.
link.href	Imposta dinamicamente l'URL di un collegamento ipertestuale appena creato in JavaScript, aggiungendo parametri di query come ?printable=yes per attivare la versione stampabile.
SkinBuildSidebar	Uno specifico hook MediaWiki che consente la manipolazione diretta degli elementi della barra laterale, rendendolo estremamente rilevante per l'aggiunta di nuovi collegamenti o voci di menu.
TestCase::createMock()	Crea oggetti fittizi per test unitari, simulando la classe Skin di MediaWiki per convalidare le modifiche della barra laterale senza richiedere un'istanza MediaWiki completa.

Come personalizzare il menu di navigazione di MediaWiki

Gli script forniti sopra si concentrano sul miglioramento del menu di navigazione MediaWiki aggiungendo un'opzione "Versione stampabile" sotto il collegamento "Pagina casuale". Questa modifica può essere ottenuta tramite la personalizzazione del backend utilizzando hook o scripting frontend con JavaScript. Ad esempio, lo script PHP sfrutta il file array e l'hook "SkinBuildSidebar" per inserire dinamicamente un nuovo elemento di navigazione. Questo approccio garantisce che l'aggiunta si integri perfettamente con la struttura della barra laterale esistente, adattandosi a skin diverse come il tema Timeless. 🖥️

La soluzione JavaScript frontend fornisce un'alternativa più dinamica, indirizzandosi al menu di navigazione dopo che il DOM è stato completamente caricato. Utilizzando comandi come e aggiungendo elementi di elenco appena creati al menu di navigazione, questo metodo non richiede la modifica del codice backend. Ad esempio, un wiki universitario potrebbe implementare rapidamente la funzione "Versione stampabile" per gli studenti che accedono ai materiali del corso, garantendo interruzioni minime al sito live. Questa flessibilità lo rende ideale per situazioni in cui l'accesso al backend è limitato o non disponibile. 📄

Un altro aspetto chiave degli script forniti è la loro modularità e l'attenzione alle migliori pratiche. Lo script PHP include la gestione degli errori per garantire che venga eseguito solo all'interno del framework MediaWiki. Allo stesso modo, la logica JavaScript convalida la presenza del menu di navigazione prima di tentare di modificarlo, riducendo il rischio di errori di runtime. Ad esempio, in un wiki aziendale, garantire l'affidabilità è fondamentale poiché la barra laterale è spesso un hub di navigazione centrale per i dipendenti che accedono a documenti o report di progetto.

Gli unit test completano gli script verificando che il collegamento "Versione stampabile" sia aggiunto correttamente in diversi scenari. Simulando l'ambiente MediaWiki utilizzando oggetti fittizi, questi test garantiscono che la soluzione funzioni su varie configurazioni. Questo processo di test è particolarmente utile per gli sviluppatori che gestiscono più wiki, poiché fornisce una protezione contro i problemi di distribuzione. In definitiva, tramite hook backend PHP, JavaScript frontend o robusti test unitari, gli script offrono metodi versatili per migliorare la navigazione MediaWiki con prestazioni e affidabilità ottimali. 🌟

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

Miglioramento di MediaWiki con personalizzazioni avanzate

L'aggiunta di funzionalità personalizzate a un'istanza MediaWiki può andare oltre le semplici modifiche al menu di navigazione. Ad esempio, gli amministratori spesso cercano modi per migliorare la funzionalità per esigenze specifiche degli utenti, come l'integrazione di opzioni di esportazione o la personalizzazione dei layout in base ai ruoli utente. Questi miglioramenti, inclusa l'aggiunta di una "versione stampabile", sono vitali per rendere i wiki più dinamici e facili da usare. L'integrazione di nuovi collegamenti nel file può essere personalizzato per soddisfare i requisiti specifici di un portale universitario o di documentazione aziendale interna.

Un'area che vale la pena esplorare è la localizzazione delle opzioni di menu appena aggiunte. Ad esempio, garantire che l'etichetta "Versione stampabile" venga tradotta dinamicamente in base alle preferenze linguistiche dell'utente aggiunge un livello di inclusività. Utilizzando i metodi di localizzazione integrati di MediaWiki, come , consente agli sviluppatori di allineare le proprie personalizzazioni agli standard globali di MediaWiki. Ciò è particolarmente utile nelle organizzazioni multinazionali in cui dipendenti o collaboratori accedono al wiki in più lingue. 🌍

Un'altra considerazione importante è l'interazione tra le personalizzazioni e il tema MediaWiki selezionato. IL , ad esempio, utilizza una struttura unica che richiede di testare accuratamente qualsiasi modifica per garantirne la compatibilità. Ad esempio, un elemento di navigazione visivamente prominente come "Versione stampabile" potrebbe richiedere ulteriori modifiche CSS per mantenere il suo aspetto su tutti i dispositivi. Queste modifiche sfumate assicurano che l'interfaccia rimanga intuitiva e professionale indipendentemente dal dispositivo dell'utente o dalle dimensioni dello schermo. 📱

1. Come posso modificare la barra laterale di MediaWiki?
2. Puoi modificare la barra laterale modificando la pagina MediaWiki:Sidebar. Usa comandi come E per definire nuovi collegamenti.
3. Cos'è il tema "Senza tempo" e che impatto ha sulla personalizzazione?
4. Il tema Timeless è una skin MediaWiki moderna con un design reattivo. Personalizzazioni come le modifiche alla barra laterale potrebbero richiedere ulteriori test per garantire che vengano visualizzate correttamente.
5. È possibile aggiungere la localizzazione per le nuove opzioni della barra laterale?
6. Sì, puoi usare per recuperare etichette localizzate per le voci del menu, garantendo la compatibilità con wiki multilingue.
7. Posso aggiungere nuove funzionalità senza modificare il codice backend?
8. Sì, soluzioni JavaScript frontend come using ti consentono di aggiungere dinamicamente collegamenti o funzionalità senza modifiche al backend.
9. Come posso testare le nuove funzionalità della barra laterale?
10. Utilizzando gli unit test PHP o un framework di test come PHPUnit, simula le modifiche della barra laterale per assicurarti che funzionino come previsto.

L'aggiunta dell'opzione "Versione stampabile" alla navigazione MediaWiki offre maggiore usabilità e organizzazione alla tua wiki. Con gli approcci descritti qui, dallo scripting PHP a JavaScript, la personalizzazione è accessibile ed efficace per tutti gli amministratori.

Dando priorità alla localizzazione e alla compatibilità dei temi, la tua wiki diventa una risorsa affidabile per un pubblico diversificato. Questi miglioramenti non solo migliorano la funzionalità ma forniscono anche un'esperienza user-friendly, riflettendo una piattaforma ben mantenuta e accessibile. 🌟