Comment ajouter une « version imprimable » au menu de navigation MediaWiki

Améliorer votre menu de navigation MediaWiki

La personnalisation de votre menu de navigation MediaWiki peut améliorer considérablement l'expérience utilisateur, permettant des outils plus accessibles et fonctionnels. Si vous utilisez MediaWiki 1.39 avec le thème Timeless, vous aurez peut-être du mal à ajouter des options spécifiques telles que la « Version imprimable ». Cette tâche n'est pas simple en raison des configurations uniques du menu de la barre latérale.

L'un des objectifs communs des administrateurs est de fournir aux utilisateurs un moyen rapide d'accéder aux pages imprimables. Cette fonctionnalité est essentielle pour les environnements dans lesquels des documents hors ligne ou sur papier sont souvent référencés, tels que les wikis universitaires ou d'entreprise. Cependant, nombreux sont ceux qui trouvent le processus moins intuitif que prévu. 🖨️

Dans ce guide, nous explorerons comment intégrer le lien « Version imprimable » dans le menu de navigation, en particulier sous l'option « Page aléatoire ». L'utilisation de MediaWiki:Sidebar pour des modifications nécessite une solide compréhension de sa syntaxe et de son comportement dans le thème Timeless.

Si vous êtes bloqué ou rencontrez des problèmes, ne vous inquiétez pas ! À la fin de cette procédure pas à pas, vous saurez non seulement comment implémenter le changement, mais vous aurez également un aperçu du fonctionnement de la barre latérale MediaWiki. Passons à cette amélioration pratique. 🌟

Comment personnaliser le menu de navigation MediaWiki

Les scripts fournis ci-dessus se concentrent sur l'amélioration du menu de navigation MediaWiki en ajoutant une option « Version imprimable » sous le lien « Page aléatoire ». Cette modification peut être réalisée via une personnalisation du backend à l'aide de hooks ou de scripts frontend avec JavaScript. Par exemple, le script PHP exploite le $wgHooks array et le hook "SkinBuildSidebar" pour insérer dynamiquement un nouvel élément de navigation. Cette approche garantit que l'ajout s'intègre parfaitement à la structure de la barre latérale existante, s'adaptant à différents skins comme le thème Timeless. 🖥️

La solution JavaScript frontend offre une alternative plus dynamique, ciblant le menu de navigation une fois le DOM complètement chargé. En utilisant des commandes comme document.createElement et en ajoutant des éléments de liste nouvellement créés au menu de navigation, cette méthode ne nécessite pas de modifier le code backend. Par exemple, un wiki universitaire pourrait déployer rapidement la fonctionnalité « Version imprimable » pour les étudiants accédant au matériel de cours, garantissant ainsi une perturbation minimale du site en direct. Cette flexibilité le rend idéal pour les situations où l'accès au backend est limité ou indisponible. 📄

Un autre aspect clé des scripts fournis est leur modularité et leur concentration sur les meilleures pratiques. Le script PHP inclut une gestion des erreurs pour garantir qu'il s'exécute uniquement dans le cadre MediaWiki. De même, la logique JavaScript valide la présence du menu de navigation avant de tenter de le modifier, réduisant ainsi les risques d'erreurs d'exécution. Par exemple, dans un wiki d'entreprise, garantir la fiabilité est crucial car la barre latérale est souvent une plate-forme de navigation centrale pour les employés accédant aux documents ou aux rapports du projet.

Les tests unitaires complètent les scripts en vérifiant que le lien "Version imprimable" est correctement ajouté dans différents scénarios. En simulant l'environnement MediaWiki à l'aide d'objets fictifs, ces tests garantissent que la solution fonctionne dans diverses configurations. Ce processus de test est particulièrement utile pour les développeurs gérant plusieurs wikis, car il fournit une protection contre les problèmes de déploiement. En fin de compte, que ce soit via des hooks backend PHP, du JavaScript frontend ou des tests unitaires robustes, les scripts offrent des méthodes polyvalentes pour améliorer la navigation MediaWiki avec des performances et une fiabilité optimales. 🌟

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

Améliorer MediaWiki avec des personnalisations avancées

L'ajout de fonctionnalités personnalisées à une instance MediaWiki peut aller au-delà de simples modifications du menu de navigation. Par exemple, les administrateurs recherchent souvent des moyens d'améliorer les fonctionnalités pour répondre aux besoins spécifiques des utilisateurs, comme l'intégration d'options d'exportation ou la personnalisation des présentations en fonction des rôles des utilisateurs. Ces améliorations, notamment l'ajout d'une « version imprimable », sont essentielles pour rendre les wikis plus dynamiques et plus conviviaux. L'intégration de nouveaux liens dans le Barre latérale MediaWiki peut être adapté pour répondre aux exigences uniques d’un portail universitaire ou de la documentation interne d’une entreprise.

Un domaine qui mérite d’être exploré est la localisation des options de menu nouvellement ajoutées. Par exemple, garantir que l'étiquette « Version imprimable » est traduite dynamiquement en fonction des préférences linguistiques de l'utilisateur ajoute une couche d'inclusivité. En utilisant les méthodes de localisation intégrées de MediaWiki, telles que $skin->msg(), permet aux développeurs d'aligner leurs personnalisations sur les normes mondiales de MediaWiki. Ceci est particulièrement utile dans les organisations multinationales où les employés ou les contributeurs accèdent au wiki dans plusieurs langues. 🌍

Une autre considération importante est l'interaction entre les personnalisations et le thème MediaWiki sélectionné. Le Thème intemporel, par exemple, utilise une structure unique qui nécessite de tester minutieusement toutes les modifications pour garantir la compatibilité. Par exemple, un élément de navigation visuellement important tel que « Version imprimable » peut nécessiter des ajustements CSS supplémentaires pour conserver son apparence sur tous les appareils. Ces modifications nuancées garantissent que l’interface reste intuitive et professionnelle quel que soit l’appareil ou la taille de l’écran de l’utilisateur. 📱