Як додати «Версію для друку» до навігаційного меню MediaWiki

Покращення навігаційного меню MediaWiki

Налаштування навігаційного меню MediaWiki може значно покращити взаємодію з користувачем, надаючи доступніші та функціональніші інструменти. Якщо ви використовуєте MediaWiki 1.39 із темою Timeless, вам може бути складно додати певні параметри, наприклад «версію для друку». Це завдання непросте через унікальні конфігурації меню бічної панелі.

Однією з спільних цілей адміністраторів є надання користувачам швидкого доступу до сторінок для друку. Ця функція має важливе значення для середовищ, де часто посилаються на офлайнові або друковані матеріали, як-от академічні чи корпоративні вікі. Однак багато хто вважає процес менш інтуїтивним, ніж очікувалося. 🖨️

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

Якщо ви застрягли або зіткнулися з проблемами, не хвилюйтеся! До кінця цього покрокового керівництва ви не тільки знатимете, як впровадити зміни, але й дізнаєтеся, як функціонує бічна панель MediaWiki. Давайте зануримося в це практичне вдосконалення. 🌟

Як налаштувати навігаційне меню MediaWiki

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

Інтерфейсне рішення JavaScript надає більш динамічну альтернативу, орієнтуючись на навігаційне меню після повного завантаження DOM. Використовуючи такі команди, як document.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. The Вічна тема, наприклад, використовує унікальну структуру, яка вимагає ретельного тестування будь-яких змін для забезпечення сумісності. Наприклад, візуально помітний навігаційний елемент, як-от «Версія для друку», може потребувати додаткових коригувань CSS, щоб зберегти його вигляд на всіх пристроях. Ці тонкі зміни гарантують, що інтерфейс залишається інтуїтивно зрозумілим і професійним незалежно від пристрою користувача чи розміру екрана. 📱