Как добавить «Версию для печати» в меню навигации MediaWiki

Улучшение навигационного меню MediaWiki

Настройка навигационного меню MediaWiki может значительно улучшить взаимодействие с пользователем, предоставляя более доступные и функциональные инструменты. Если вы используете MediaWiki 1.39 с темой Timeless, вам может быть сложно добавить определенные параметры, такие как «Версия для печати». Эта задача непроста из-за уникальных конфигураций бокового меню.

Одна из общих целей администраторов — предоставить пользователям быстрый доступ к страницам, пригодным для печати. Эта функция важна для сред, где часто используются офлайновые или бумажные материалы, например академические или корпоративные вики. Однако многие считают этот процесс менее интуитивным, чем ожидалось. 🖨️

В этом руководстве мы рассмотрим, как включить ссылку «Версия для печати» в меню навигации, в частности в параметр «Случайная страница». Использование MediaWiki:Sidebar для внесения изменений требует четкого понимания его синтаксиса и поведения в теме Timeless.

Если вы застряли или столкнулись с проблемами, не волнуйтесь! К концу этого пошагового руководства вы не только узнаете, как реализовать изменения, но и получите представление о том, как функционирует боковая панель MediaWiki. Давайте углубимся в это практическое усовершенствование. 🌟

Как настроить меню навигации MediaWiki

Приведенные выше сценарии направлены на улучшение навигационного меню MediaWiki путем добавления опции «Версия для печати» под ссылкой «Случайная страница». Это изменение может быть достигнуто путем настройки серверной части с помощью перехватчиков или сценариев внешнего интерфейса с использованием JavaScript. Например, PHP-скрипт использует $wgHooks массив и хук «SkinBuildSidebar» для динамической вставки нового элемента навигации. Такой подход гарантирует, что дополнение легко интегрируется с существующей структурой боковой панели, адаптируясь к различным скинам, таким как тема Timeless. 🖥️

Решение JavaScript для внешнего интерфейса предоставляет более динамичную альтернативу, ориентированную на меню навигации после полной загрузки DOM. Используя такие команды, как документ.createElement и добавления вновь созданных элементов списка в меню навигации, этот метод не требует изменения внутреннего кода. Например, университетская вики может быстро развернуть функцию «Версия для печати» для доступа студентов к материалам курса, гарантируя минимальное нарушение работы действующего сайта. Такая гибкость делает его идеальным для ситуаций, когда доступ к серверной части ограничен или недоступен. 📄

Еще одним ключевым аспектом предоставленных сценариев является их модульность и ориентация на лучшие практики. Сценарий PHP включает обработку ошибок, чтобы гарантировать его работу только в среде MediaWiki. Аналогично, логика JavaScript проверяет наличие меню навигации перед попыткой его изменения, что снижает риск ошибок во время выполнения. Например, в корпоративном вики-сайте обеспечение надежности имеет решающее значение, поскольку боковая панель часто является центральным навигационным узлом для сотрудников, получающих доступ к проектным документам или отчетам.

Модульные тесты дополняют сценарии, проверяя правильность добавления ссылки «Версия для печати» в различных сценариях. Моделируя среду MediaWiki с использованием фиктивных объектов, эти тесты гарантируют, что решение работает в различных конфигурациях. Этот процесс тестирования особенно ценен для разработчиков, управляющих несколькими вики-сайтами, поскольку он обеспечивает защиту от проблем с развертыванием. В конечном счете, будь то с помощью внутренних перехватчиков PHP, внешнего интерфейса JavaScript или надежного модульного тестирования, сценарии предлагают универсальные методы улучшения навигации по MediaWiki с оптимальной производительностью и надежностью. 🌟

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

Улучшение MediaWiki с помощью расширенных настроек

Добавление пользовательских функций в экземпляр MediaWiki может выходить за рамки простых модификаций меню навигации. Например, администраторы часто ищут способы улучшить функциональность для конкретных потребностей пользователей, например интегрировать параметры экспорта или настраивать макеты на основе ролей пользователей. Эти улучшения, включая добавление «версии для печати», жизненно важны для того, чтобы сделать вики более динамичными и удобными для пользователя. Интеграция новых ссылок в Боковая панель MediaWiki может быть адаптирован в соответствии с уникальными требованиями университетского портала или внутренней документации компании.

Одна из областей, которую стоит изучить, — это локализация недавно добавленных пунктов меню. Например, обеспечение динамического перевода метки «Версия для печати» в зависимости от языковых предпочтений пользователя добавляет уровень инклюзивности. Использование встроенных методов локализации MediaWiki, таких как $skin->msg(), позволяет разработчикам согласовывать свои настройки с глобальными стандартами MediaWiki. Это особенно полезно в многонациональных организациях, где сотрудники или участники имеют доступ к вики на нескольких языках. 🌍

Еще одним важным фактором является взаимодействие между настройками и выбранной темой MediaWiki. Вечная тема, например, использует уникальную структуру, которая требует тщательного тестирования любых изменений для обеспечения совместимости. Например, визуально заметный элемент навигации, такой как «Версия для печати», может потребовать дополнительных настроек CSS, чтобы сохранить его внешний вид на разных устройствах. Эти тонкие изменения гарантируют, что интерфейс останется интуитивно понятным и профессиональным независимо от устройства пользователя или размера экрана. 📱