Jak přidat „Verzi pro tisk“ do navigační nabídky MediaWiki

Vylepšení vaší navigační nabídky MediaWiki

Přizpůsobení navigační nabídky MediaWiki může výrazně zlepšit uživatelskou zkušenost a umožnit přístupnější a funkčnější nástroje. Pokud používáte MediaWiki 1.39 s tématem Timeless, může být pro vás obtížné přidat konkrétní možnosti, jako je „Verze pro tisk“. Tento úkol není přímočarý kvůli jedinečným konfiguracím nabídky postranního panelu.

Jedním ze společných cílů správců je poskytnout uživatelům rychlý způsob přístupu k tisknutelným stránkám. Tato funkce je nezbytná pro prostředí, kde se často odkazuje na offline nebo tištěné materiály, jako jsou akademické nebo podnikové wiki. Mnohým však tento proces připadá méně intuitivní, než se očekávalo. 🖨️

V této příručce prozkoumáme, jak začlenit odkaz „Verze pro tisk“ do navigační nabídky, konkrétně pod možnost „Náhodná stránka“. Používání MediaWiki:Sidebar k úpravám vyžaduje důkladné pochopení jeho syntaxe a chování v rámci tématu Timeless.

Pokud jste uvízli nebo narazili na problémy, nebojte se! Na konci tohoto návodu budete nejen vědět, jak provést změnu, ale také získáte přehled o tom, jak funguje postranní panel MediaWiki. Pojďme se vrhnout na toto praktické vylepšení. 🌟

Jak přizpůsobit navigační nabídku MediaWiki

Výše uvedené skripty se zaměřují na vylepšení navigační nabídky MediaWiki přidáním možnosti „Verze pro tisk“ pod odkaz „Náhodná stránka“. Této úpravy lze dosáhnout přizpůsobením backendu pomocí háčků nebo frontend skriptování pomocí JavaScriptu. Například PHP skript využívá $wgHooks pole a háček "SkinBuildSidebar" pro dynamické vložení nové navigační položky. Tento přístup zajišťuje, že se doplněk hladce integruje se stávající strukturou postranního panelu a přizpůsobí se různým vzhledům, jako je téma Timeless. 🖥️

Řešení frontend JavaScript poskytuje dynamičtější alternativu, která cílí na navigační nabídku po úplném načtení modelu DOM. Pomocí příkazů jako document.createElement a přidávání nově vytvořených položek seznamu do navigační nabídky, tato metoda nevyžaduje úpravu backendového kódu. Například univerzitní wiki by mohla rychle nasadit funkci „Verze pro tisk“ pro studenty, kteří mají přístup ke studijním materiálům, a zajistit tak minimální narušení živého webu. Díky této flexibilitě je ideální pro situace, kdy je přístup k backendu omezený nebo nedostupný. 📄

Dalším klíčovým aspektem poskytovaných skriptů je jejich modularita a zaměření na osvědčené postupy. PHP skript obsahuje zpracování chyb, aby bylo zajištěno, že běží pouze v rámci MediaWiki. Podobně logika JavaScriptu ověřuje přítomnost navigační nabídky před pokusem o její úpravu, čímž se snižuje riziko chyb za běhu. Například u podnikové wiki je zajištění spolehlivosti zásadní, protože postranní panel je často centrálním navigačním centrem pro zaměstnance, kteří přistupují k projektovým dokumentům nebo sestavám.

Unit testy doplňují skripty ověřením, že odkaz "Verze pro tisk" je správně přidán v různých scénářích. Díky simulaci prostředí MediaWiki pomocí falešných objektů tyto testy zajišťují, že řešení funguje v různých konfiguracích. Tento testovací proces je zvláště cenný pro vývojáře spravující více wiki, protože poskytuje ochranu proti problémům s nasazením. Nakonec, ať už prostřednictvím PHP backend hooks, frontend JavaScriptu nebo robustního testování jednotek, skripty nabízejí všestranné metody pro vylepšení navigace MediaWiki s optimálním výkonem a spolehlivostí. 🌟

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

Vylepšení MediaWiki pomocí pokročilých přizpůsobení

Přidání vlastních funkcí do instance MediaWiki může jít nad rámec jednoduchých úprav navigační nabídky. Správci například často hledají způsoby, jak zlepšit funkčnost pro specifické potřeby uživatelů, jako je integrace možností exportu nebo přizpůsobení rozvržení na základě uživatelských rolí. Tato vylepšení, včetně přidání „verze pro tisk“, jsou zásadní pro to, aby byly wiki dynamičtější a uživatelsky přívětivější. Integrace nových odkazů v Postranní panel MediaWiki lze upravit tak, aby odpovídala jedinečným požadavkům univerzitního portálu nebo interní firemní dokumentace.

Jednou z oblastí, které stojí za to prozkoumat, je lokalizace nově přidaných možností nabídky. Například zajištění dynamického překladu štítku „Verze pro tisk“ na základě jazykových preferencí uživatele přidává vrstvu inkluzivity. Pomocí vestavěných lokalizačních metod MediaWiki, jako je např $skin->msg(), umožňuje vývojářům sladit svá přizpůsobení s globálními standardy MediaWiki. To je užitečné zejména v nadnárodních organizacích, kde zaměstnanci nebo přispěvatelé přistupují k wiki ve více jazycích. 🌍

Dalším důležitým aspektem je interakce mezi přizpůsobením a vybraným tématem MediaWiki. The Nadčasové téma, například používá jedinečnou strukturu, která vyžaduje důkladné testování všech změn, aby byla zajištěna kompatibilita. Například vizuálně výrazný navigační prvek, jako je „Verze pro tisk“, může vyžadovat další úpravy CSS, aby si zachoval svůj vzhled na různých zařízeních. Tyto jemné úpravy zajišťují, že rozhraní zůstane intuitivní a profesionální bez ohledu na zařízení uživatele nebo velikost obrazovky. 📱