Cómo agregar una "versión imprimible" al menú de navegación de MediaWiki

Mejora de su menú de navegación de MediaWiki

Personalizar el menú de navegación de MediaWiki puede mejorar significativamente la experiencia del usuario, permitiendo herramientas más accesibles y funcionales. Si está ejecutando MediaWiki 1.39 con el tema Timeless, puede resultarle difícil agregar opciones específicas como la "Versión imprimible". Esta tarea no es sencilla debido a las configuraciones únicas del menú de la barra lateral.

Un objetivo común entre los administradores es proporcionar a los usuarios una forma rápida de acceder a páginas imprimibles. Esta característica es esencial para entornos donde a menudo se hace referencia a materiales impresos o sin conexión, como wikis académicos o corporativos. Sin embargo, muchos encuentran el proceso menos intuitivo de lo esperado. 🖨️

En esta guía, exploraremos cómo incorporar el enlace "Versión imprimible" en el menú de navegación, específicamente en la opción "Página aleatoria". El uso de MediaWiki: barra lateral para modificaciones requiere una comprensión sólida de su sintaxis y comportamiento dentro del tema Timeless.

Si estás atascado o tienes problemas, ¡no te preocupes! Al final de este tutorial, no sólo sabrá cómo implementar el cambio, sino que también obtendrá información sobre cómo funciona la barra lateral de MediaWiki. Profundicemos en esta mejora práctica. 🌟

Cómo personalizar el menú de navegación de MediaWiki

Los scripts proporcionados anteriormente se centran en mejorar el menú de navegación de MediaWiki agregando una opción "Versión imprimible" debajo del enlace "Página aleatoria". Esta modificación se puede lograr mediante la personalización del backend mediante ganchos o secuencias de comandos del frontend con JavaScript. Por ejemplo, el script PHP aprovecha la $wgGanchos matriz y el gancho "SkinBuildSidebar" para insertar dinámicamente un nuevo elemento de navegación. Este enfoque garantiza que la adición se integre perfectamente con la estructura de la barra lateral existente, adaptándose a diferentes aspectos como el tema Timeless. 🖥️

La solución JavaScript frontal proporciona una alternativa más dinámica, dirigida al menú de navegación después de que el DOM se haya cargado por completo. Usando comandos como documento.createElement y agregar elementos de lista recién creados al menú de navegación, este método no requiere modificar el código de fondo. Por ejemplo, un wiki universitario podría implementar rápidamente la función "Versión imprimible" para los estudiantes que acceden a los materiales del curso, garantizando una interrupción mínima del sitio en vivo. Esta flexibilidad lo hace ideal para situaciones en las que el acceso al backend es limitado o no está disponible. 📄

Otro aspecto clave de los guiones proporcionados es su modularidad y su enfoque en las mejores prácticas. El script PHP incluye manejo de errores para garantizar que solo se ejecute dentro del marco de MediaWiki. De manera similar, la lógica de JavaScript valida la presencia del menú de navegación antes de intentar modificarlo, lo que reduce el riesgo de errores de tiempo de ejecución. Por ejemplo, en un wiki corporativo, garantizar la confiabilidad es crucial, ya que la barra lateral suele ser un centro de navegación central para que los empleados accedan a documentos o informes del proyecto.

Las pruebas unitarias complementan los scripts verificando que el enlace "Versión imprimible" esté agregado correctamente en diferentes escenarios. Al simular el entorno de MediaWiki utilizando objetos simulados, estas pruebas garantizan que la solución funcione en varias configuraciones. Este proceso de prueba es particularmente valioso para los desarrolladores que administran múltiples wikis, ya que proporciona una protección contra problemas de implementación. En última instancia, ya sea a través de enlaces PHP backend, JavaScript frontend o pruebas unitarias sólidas, los scripts ofrecen métodos versátiles para mejorar la navegación de MediaWiki con un rendimiento y confiabilidad óptimos. 🌟

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

Mejora de MediaWiki con personalizaciones avanzadas

Agregar funciones personalizadas a una instancia de MediaWiki puede ir más allá de simples modificaciones en el menú de navegación. Por ejemplo, los administradores suelen buscar formas de mejorar la funcionalidad para las necesidades específicas de los usuarios, como integrar opciones de exportación o personalizar diseños según las funciones de los usuarios. Estas mejoras, incluida la adición de una "versión imprimible", son vitales para hacer que los wikis sean más dinámicos y fáciles de usar. La integración de nuevos enlaces en el Barra lateral de MediaWiki se puede adaptar para que coincida con los requisitos únicos de un portal universitario o la documentación interna de la empresa.

Un área que vale la pena explorar es la localización de las opciones de menú recién agregadas. Por ejemplo, garantizar que la etiqueta "Versión imprimible" se traduzca dinámicamente según las preferencias de idioma del usuario agrega una capa de inclusión. Usando los métodos de localización integrados de MediaWiki, como $skin->msg(), permite a los desarrolladores alinear sus personalizaciones con los estándares globales de MediaWiki. Esto es particularmente útil en organizaciones multinacionales donde los empleados o contribuyentes acceden al wiki en varios idiomas. 🌍

Otra consideración importante es la interacción entre las personalizaciones y el tema de MediaWiki seleccionado. El Tema atemporal, por ejemplo, utiliza una estructura única que requiere probar minuciosamente cualquier cambio para garantizar la compatibilidad. Por ejemplo, un elemento de navegación visualmente destacado como "Versión imprimible" podría necesitar ajustes CSS adicionales para mantener su apariencia en todos los dispositivos. Estas modificaciones matizadas garantizan que la interfaz siga siendo intuitiva y profesional independientemente del dispositivo o tamaño de la pantalla del usuario. 📱