Como adicionar "versão para impressão" ao menu de navegação do MediaWiki

Aprimorando seu menu de navegação MediaWiki

Personalizar o menu de navegação do MediaWiki pode melhorar significativamente a experiência do usuário, permitindo ferramentas mais acessíveis e funcionais. Se você estiver executando o MediaWiki 1.39 com o tema Timeless, poderá achar um desafio adicionar opções específicas como a "versão para impressão". Esta tarefa não é simples devido às configurações exclusivas do menu da barra lateral.

Um objetivo comum entre os administradores é fornecer aos usuários uma maneira rápida de acessar páginas imprimíveis. Esse recurso é essencial para ambientes onde materiais off-line ou impressos são frequentemente referenciados, como wikis acadêmicos ou corporativos. No entanto, muitos consideram o processo menos intuitivo do que o esperado. 🖨️

Neste guia, exploraremos como incorporar o link “Versão para impressão” no menu de navegação, especificamente na opção “Página aleatória”. Usar o MediaWiki:Sidebar para modificações requer um conhecimento sólido de sua sintaxe e comportamento dentro do tema Timeless.

Se você estiver travado ou enfrentando problemas, não se preocupe! Ao final deste passo a passo, você não apenas saberá como implementar a mudança, mas também obterá insights sobre como funciona a barra lateral do MediaWiki. Vamos mergulhar neste aprimoramento prático. 🌟

Comando	Exemplo de uso
$wgHooks['SkinBuildSidebar'][]	Este comando registra um gancho personalizado no MediaWiki que permite modificar a estrutura da barra lateral durante sua renderização. É específico para personalizar menus de navegação de forma dinâmica.
$skin->$skin->msg()	Recupera mensagens ou links localizados no MediaWiki. Nesse contexto, ele busca dinamicamente o URL do recurso "Versão para impressão" usando configurações de idioma integradas.
document.addEventListener('DOMContentLoaded')	Garante que a lógica JavaScript seja executada somente depois que o DOM estiver totalmente carregado, o que é fundamental para modificar dinamicamente um menu de navegação existente.
document.createElement()	Cria novos elementos HTML, como tags li e a, que são adicionados ao menu de navegação dinamicamente na solução front-end.
arrayHasKey	Usado em testes unitários para verificar se uma determinada chave existe em um array, garantindo que a opção "Versão para impressão" foi adicionada corretamente à estrutura da barra lateral.
if (!defined('MEDIAWIKI'))	Garante que o script seja executado dentro da estrutura MediaWiki, evitando execução não autorizada ou autônoma.
$GLOBALS['wgHooks']	Acessa ganchos globais no MediaWiki, permitindo que os desenvolvedores adicionem ou modifiquem funcionalidades dinamicamente em pontos específicos do ciclo de vida do aplicativo.
link.href	Define a URL de um hiperlink recém-criado dinamicamente em JavaScript, adicionando parâmetros de consulta como ?printable=yes para ativar a versão para impressão.
SkinBuildSidebar	Um gancho específico do MediaWiki que permite a manipulação direta dos elementos da barra lateral, tornando-o altamente relevante para adicionar novos links ou itens de menu.
TestCase::createMock()	Cria objetos simulados para teste de unidade, simulando a classe Skin do MediaWiki para validar modificações na barra lateral sem exigir uma instância completa do MediaWiki.

Como personalizar o menu de navegação do MediaWiki

Os scripts fornecidos acima concentram-se em melhorar o menu de navegação do MediaWiki adicionando uma opção "Versão para impressão" abaixo do link "Página aleatória". Essa modificação pode ser obtida por meio da personalização de back-end usando ganchos ou scripts de front-end com JavaScript. Por exemplo, o script PHP aproveita o array e o gancho "SkinBuildSidebar" para inserir dinamicamente um novo item de navegação. Essa abordagem garante que a adição se integre perfeitamente à estrutura da barra lateral existente, adaptando-se a diferentes skins, como o tema Timeless. 🖥️

A solução frontend JavaScript oferece uma alternativa mais dinâmica, visando o menu de navegação após o carregamento completo do DOM. Usando comandos como e anexar itens de lista recém-criados ao menu de navegação, esse método não requer modificação do código de back-end. Por exemplo, um wiki universitário poderia implantar rapidamente o recurso "Versão para impressão" para os alunos que acessam os materiais do curso, garantindo o mínimo de interrupção no site ativo. Essa flexibilidade o torna ideal para situações em que o acesso back-end é limitado ou indisponível. 📄

Outro aspecto importante dos scripts fornecidos é a sua modularidade e foco nas melhores práticas. O script PHP inclui tratamento de erros para garantir que ele seja executado apenas dentro da estrutura MediaWiki. Da mesma forma, a lógica JavaScript valida a presença do menu de navegação antes de tentar modificá-lo, reduzindo o risco de erros de execução. Por exemplo, em um wiki corporativo, garantir a confiabilidade é crucial, pois a barra lateral costuma ser um hub de navegação central para os funcionários que acessam documentos ou relatórios do projeto.

Os testes unitários complementam os scripts verificando se o link "Versão para impressão" foi adicionado corretamente em diferentes cenários. Ao simular o ambiente MediaWiki usando objetos simulados, esses testes garantem que a solução funcione em diversas configurações. Este processo de teste é particularmente valioso para desenvolvedores que gerenciam vários wikis, pois fornece uma proteção contra problemas de implantação. Em última análise, seja através de ganchos de back-end PHP, JavaScript front-end ou testes de unidade robustos, os scripts oferecem métodos versáteis para aprimorar a navegação do MediaWiki com desempenho e confiabilidade ideais. 🌟

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

Aprimorando o MediaWiki com personalizações avançadas

Adicionar recursos personalizados a uma instância do MediaWiki pode ir além de simples modificações no menu de navegação. Por exemplo, os administradores muitas vezes procuram maneiras de aprimorar a funcionalidade para necessidades específicas do usuário, como integrar opções de exportação ou personalizar layouts com base nas funções do usuário. Essas melhorias, incluindo a adição de uma “versão para impressão”, são vitais para tornar os wikis mais dinâmicos e fáceis de usar. A integração de novos links no pode ser adaptado para atender aos requisitos exclusivos de um portal universitário ou à documentação interna da empresa.

Uma área que vale a pena explorar é a localização das opções de menu recém-adicionadas. Por exemplo, garantir que o rótulo “Versão para impressão” seja traduzido dinamicamente com base nas preferências de idioma do usuário adiciona uma camada de inclusão. Usando os métodos de localização integrados do MediaWiki, como , permite que os desenvolvedores alinhem suas personalizações com os padrões globais do MediaWiki. Isto é particularmente útil em organizações multinacionais onde funcionários ou colaboradores acessam o wiki em vários idiomas. 🌍

Outra consideração importante é a interação entre as personalizações e o tema MediaWiki selecionado. O , por exemplo, usa uma estrutura exclusiva que exige testes completos de quaisquer alterações para garantir a compatibilidade. Por exemplo, um elemento de navegação visualmente proeminente, como "Versão para impressão", pode precisar de ajustes adicionais de CSS para manter sua aparência em todos os dispositivos. Essas modificações diferenciadas garantem que a interface permaneça intuitiva e profissional, independentemente do dispositivo do usuário ou do tamanho da tela. 📱

1. Como posso editar a barra lateral do MediaWiki?
2. Você pode editar a barra lateral modificando a página MediaWiki:Sidebar. Use comandos como e para definir novos links.
3. O que é o tema “Timeless” e como ele afeta a personalização?
4. O tema Timeless é um skin moderno do MediaWiki com um design responsivo. Personalizações como alterações na barra lateral podem exigir testes adicionais para garantir que sejam exibidas corretamente.
5. É possível adicionar localização para novas opções da barra lateral?
6. Sim, você pode usar para buscar rótulos localizados para seus itens de menu, garantindo compatibilidade com wikis multilíngues.
7. Posso adicionar novos recursos sem modificar o código de back-end?
8. Sim, soluções JavaScript de front-end, como usar permitem que você adicione links ou recursos dinamicamente sem alterações de back-end.
9. Como posso testar novos recursos da barra lateral?
10. Usando testes de unidade PHP ou uma estrutura de teste como PHPUnit, simule modificações na barra lateral para garantir que funcionem conforme o esperado.

Adicionar a opção "Versão para impressão" à navegação do MediaWiki traz maior usabilidade e organização ao seu wiki. Com as abordagens detalhadas aqui, desde scripts PHP até JavaScript, a personalização é acessível e eficaz para todos os administradores.

Ao priorizar a localização e a compatibilidade do tema, seu wiki se torna um recurso confiável para diversos públicos. Essas melhorias não apenas melhoram a funcionalidade, mas também proporcionam uma experiência amigável, refletindo uma plataforma acessível e bem mantida. 🌟