Como configurar uma MediaWiki

De Compendium Tolkien
Revisão de 23h05min de 28 de fevereiro de 2024 por Projetotolkien (discussão | contribs)

Configurar uma enciclopédia através do MediaWiki não é tão difícil depois que se aprende, mas, infelizmente, é extremamente difícil encontrar informações claras internet afora sobre como fazer o que você precisa. Isso fica ainda mais chocante quando você para para pensar no quão antiga essa plataforma é e no quanto ela é usada mundo afora.

Isto posto, resolvi ir compilando aqui os conhecimentos sobre MediaWiki que eu for obtendo conforme vou aprendendo a configurar o Compendium Tolkien para que outras pessoas não tenham de sofrer como eu sofri (ao menos não tanto quanto).

[Atualizado por último em: 28/02/2024]

LocalSettings.php

Quando você instala o MediaWiki, haverá na raiz dele um documento chamado LocalSettings.php. Este é um dos documentos mais importantes do seu site e que será mais frequentemente usado para configurá-lo. Ele é basicamente um "bloco de notas" no qual você pode incluir "comandos" para serem lidos por seu site.

Aliás, não se assuste: você não precisa entender nada de código; basta encontrar na internet o código referente ao que você precisa, copiá-lo e depois colá-lo dentro deste arquivo LocalSettings.php. Alguns códigos podem ser encontrados no próprio site da MediaWiki, mas eles não fazem um bom trabalho nisso, então a maioria você encontrará internet afora em diversos sites diferentes (Reddit, YouTube, etc.): geralmente alguém pergunta uma dúvida e outra pessoa responde esclarecendo o código que é necessário usar.

Cada "comando" precisa estar em uma linha separada para que um não entre em conflito com o outro. Em tese você pode escrever/colar comandos em qualquer lugar dentro desse arquivo LocalSettings.php, mas, para não correr o risco de você incluir um comando no "meio" de um outro comando sem perceber, eu recomendo que novos comandos sejam sempre incluído ao final do documento, depois de todos os outros comandos já existentes, pois assim você terá certeza de que não estará conflitando com nada.

Outro detalhe muito importante: toda linha de código dever terminar com um símbolo de ponto e vírgula (;). Você pode ter incluído um código perfeitamente; se não tiver colocado um ";" ao final ele não funcionará.

Você também pode incluir qualquer tipo de texto explicativo dentro deste arquivo chamado LocalSettings.php, o que acaba sendo muito importante principalmente para quem não tem muito conhecimento técnico no assunto, pois você pode, por exemplo, incluir uma breve explicação sobre o código que você está incluindo no arquivo. Deste modo, caso você se esqueça no futuro para o que serve um código específico que você colocou lá, essa explicação te ajudará a se lembrar.

Importante: para que o MediaWiki não interprete o seu texto explicativo como um comando é necessário acrescentar uma "hashtag" (#) no início da linha. Toda linha que começar com uma hashtag o programa irá ignorar, enquanto toda linha que começar com qualquer outra coisa o programa irá interpretar como um comando. Então, na hora de incluir textos explicativos, sempre comece a linha com uma hashtag!

Abaixo, um exemplo:

# O código abaixo deixa você escolher o tema padrão da sua wiki, que será automaticamente implementada para todos os usuários que não tenha optado por um tema personalizado (cada usuário pode alterar individualmente seu tema nas configurações de sua conta).

# Para alterá-la, é necessário pegar o nome-código de cada tema no site da MediaWiki e colocá-lo dentro daquelas aspas. Abaixo, optei pelo tema "timeless", cujo nome-código é exatamente o mesmo (às vezes um nome-código é diferente do nome do tema).

$wgDefaultSkin = "timeless";

Nota-se que o texto explicativo começa com uma hashtag (#), bem como que o código que segue na linha de baixo é finalizado por um símbolo de ponto e vírgula (;). Em tese o código pode ser colocado já na linha debaixo do texto explicativo, ou na linha imediatamente abaixo de outro código, mas, para evitar confusões, recomendo que você pule pelo menos uma linha entre um texto explicativo e um código ou entre um código e outro código (lembrando que, como comentei, você pode colocar o código em qualquer lugar do arquivo, pois o programa ignora linhas em branco e linhas que começam com uma hashtag). Ficará mais fácil de você se achar depois.

Caso seu texto explicativo fique muito longo, como no exemplo acima, é interessante "quebrá-lo" em várias linhas para que você não precise rolar o mouse para a direita para continuar lendo. Porém, fique atento: caso você quebre seu texto explicativo em mais linhas, lembre-se de sempre incluir uma hashtag no começo de cada uma dessas linhas, pois, como já disse, linhas que não começam com uma hashtag o programa interpretará como um código!

Por exemplo:

# O código abaixo deixa você escolher o tema padrão da sua wiki,

# que será automaticamente implementada para todos os usuários que

# não tenha optado por um tema personalizado (cada usuário pode alterar

# individualmente seu tema nas configurações de sua conta).

# Para alterá-la, é necessário pegar o nome-código de cada tema

# no site da MediaWiki e colocá-lo dentro daquelas aspas. Abaixo,

# optei pelo tema "timeless", cujo nome-código é exatamente o mesmo

# (às vezes um nome-código é diferente do nome do tema).

$wgDefaultSkin = "timeless";

Alterando a logo da sua wiki

Quando você instala o MediaWiki, o arquivo LocalSettings.php já virá com vários comandos gerados automaticamente. Um deles é o comando que define qual será a imagem que representará a logo da sua wiki. Sendo assim, neste caso não é necessário que você crie nenhum comando novo, mas apenas que você modifique um comando já existente.

Para localizar um código que já consta dentro do documento, você pode usar Ctrl+F (ou, dependendo de qual programa você usou para abrir o LocalSettings.php, Ctrl+L) da mesma forma que você usa, por exemplo, em um site da internet.

Sendo assim, com o LocalSettings.php aberto, pesquise pela palavra "logo" e você encontrará o seguinte código:

## The URL paths to the logo.  Make sure you change this from the default,

## or else you'll overwrite your logo when you upgrade!

$wgLogos = [

   '1x' => "$wgResourceBasePath/resources/assets/change-your-logo.svg",

   'icon' => "$wgResourceBasePath/resources/assets/change-your-logo.svg",

];

Nota-se que aquelas duas linhas que começam com ## são apenas linhas explicativas e não fazem parte de nenhum código. Em tese você poderia apagá-las que não faria falta (mas não tem por que apagar).

O código mesmo são aquelas quatro últimas linhas, que não começam com #. Alguns códigos preencherão tão somente uma linha, enquanto outros podem abranger mais de uma linha (como este). Aliás, nota-se que ao final do código há um símbolo de ponto e vírgula (;). Nunca se esqueça dele quando estiver incluindo um código novo (normalmente códigos que você pega internet afora não incluem o ponto e vírgula final, então você tem de lembrar de pô-lo).

Quanto ao código para alterar a logo do site, note que há um "caminho" nele: /resources/assets/change-your-logo.svg.

Caso você não tenha percebido, cada um desses nomes (resources e assets) são pastas dentro do seu servidor do MediaWiki, e o último nome (change-your-logo.svg) é o nome do arquivo em si. Ou seja, para alterar a logo da sua MediaWiki basta que você "suba" a imagem da logo para dentro do seu servidor e depois atualize o caminho neste código (não é necessário que seja um arquivo em .svg; você pode usar .png ou .jpg normalmente).

Em tese você poderia salvar a sua imagem em qualquer lugar do seu servidor, mas eu recomendaria você salvar no mesmo lugar que a logo padrão (resources/assets). Se quiser, crie uma pasta dentro de assets (por exemplo, uma pasta chamada "imagens").

Atenção: não substitua a imagem padrão que vem pré-instalada no MediaWiki, mas sim salve a sua imagem em outro lugar ou, se for no mesmo lugar, com outro nome. Em tese não teria problema você substituir o arquivo padrão com o seu arquivo pessoal, mas isso pode gerar problemas em uma atualização futura. Quando você atualiza a versão da sua MediaWiki, algumas configurações de fábrica são preestabelecidas, o que quer dizer que, se você substituir a logo padrão pela sua dentro do servidor, pode ser que você perca sua logo em uma atualização. Repito: salve sua logo em outra pasta ou, se for na mesma pasta, use outro nome. Depois é só consertar o "caminho" dela no código.

No meu caso, o código da logo ficou da seguinte forma:

## The URL paths to the logo.  Make sure you change this from the default,

## or else you'll overwrite your logo when you upgrade!

$wgLogos = [

   '1x' => "$wgResourceBasePath/resources/assets/logo-simples-sem-fundo.png",

   'icon' => "$wgResourceBasePath/resources/assets/logo-simples-sem-fundo.png",

];

O caminho é exatamente o mesmo, pois salvei a minha logo na mesma pasta em que se encontra a logo padrão e apenas usei um nome diferente para o arquivo. Sendo assim, bastou que eu alterasse o nome do arquivo no caminho que já se encontrava no código padrão.

Alterando o fuso horário padrão

Como padrão a sua wiki seguirá o fuso horário UTC. Para alterá-lo é extremamente fácil, pois o código dele já está incluso no LocalSettings.php e basta você alterá-lo.

Ao abrir o LocalSettings.php, use Ctrl+F para localizar o seguinte:

# Time zone

$wgLocaltimezone = "UTC";

Basta alterar o UTC para o fuso horário correspondente. Caso pretenda usar o horário de Brasília, que seria GTM-3, o código em questão ficaria:

# Time zone

$wgLocaltimezone = "GMT-3";

Alterando isso e salvando o arquivo não é preciso fazer mais nada, a mudança será instantaneamente aplicada para todo o site (isto não impede que usuários optem por outros fusos horários individualmente nas preferências de suas contas).

Como instalar o "Visual Editor"

Uma das ferramentas mais importantes de uma enciclopédia acessível ao público em geral é o "Visual Editor".

Como padrão, a formatação de texto em qualquer página dentro do MediaWiki é extremamente complexa para um usuário médio, pois é necessário usar "códigos" até mesmo para alterações simples como colocar uma palavra em negrito.

O "Visual Editor", que não vem pré-instalado no MediaWiki, é de longe a sua extensão mais baixada, pois ela facilita em muito a formatação de texto, deixando tudo muito mais intuitivo. Simplificando, ele basicamente transforma o editor de texto em algo como o Microsoft Word: quer colocar uma palavra em negrito? Com um clique você faz isso!

Antes de baixar a extensão vale a pena ver se ela já foi automaticamente baixada quando da criação do seu site. No meu caso, cuja instalação foi feita através da plataforma do Hostinger, algumas extensões já foram automaticamente baixadas, sendo o Visual Editor uma delas.

Para verificar, acesse os arquivos de seu site. Lá na raiz haverá uma pasta chamada "extensions", onde as extensões devem ser colocadas - e onde as extensões que são automaticamente baixadas ficam salvas. Abra essa pasta e veja se há uma outra pasta lá dentro chamada "VisualEditor". Se não tiver, siga os passos abaixo para baixá-la. Caso essa pasta já esteja presente, pule a etapa do download e continue lendo, pois, ainda que ela já venha baixada para você, você ainda precisa ativá-la antes de poder usá-la!

Para baixar a extensão, acesse a página: https://www.mediawiki.org/wiki/Extension:VisualEditor#Installation

Nela você encontrará um link de download. Antes de baixar o arquivo, atente-se para a versão dele: sempre baixe a extensão na mesma versão do seu MediaWiki!

Após efetuar o download da mesma versão que o seu MediaWiki, você terá um arquivo .tar em seu computador, que nada mais é do que uma pasta compactada, como arquivos .rar ou .zip. Para extrair a pasta que se encontra dentro deste arquivo compactado, basta abrir ele e arrastar a pasta que se encontra lá dentro para fora.

Você vai pegar essa pasta que você acabou de extrair, chamada VisualEditor, e salvar ela dentro do seu site, dentro da pasta chamada "extensions" (a mesma pasta que eu pedi para você checar se o VisualEditor já se encontrava lá dentro).

Feito isso, pronto!, o VisualEditor já está "instalado" no seu MediaWiki. Agora você só precisa ativá-lo!

Para ativar a extensão, basta você abrir o arquivo LocalSettings.php e acrescentar a seguinte linha de código (de preferência lá no final, como já expliquei anteriormente):

wfLoadExtension( 'VisualEditor' );

Incluída essa linha e salvado o arquivo LocalSettings.php, pronto, o Visual Editor já está ativo na sua MediaWiki. Agora, sempre que você clicar em editar uma página o Visual Editor já será automaticamente carregado, facilitando a formatação do texto.

Como ativar o módulo de referências dentro do Visual Editor

Após instalação e ativação do Visual Editor, a criação e edição das páginas de sua wiki já serão extremamente facilitadas, mas a extensão infelizmente não vem "completa" e algumas funções importantíssimas que precisam ser instaladas à parte.

A principal dessas funções importantíssimas, ao meu ver, é o módulo de referências, com o qual você pode incluir referências ao longo de seu texto (tipo o número 1 ao final de um parágrafo e lá embaixo do página o nome do livro ou site de onde essa informação foi retirada). Se você pretende criar uma wiki pública, a inclusão de referências (e a facilitação de que elas sejam incluídas) é importantíssima para melhorar seu grau de credibilidade.

Para isso você precisa instalar uma outra extensão que irá conversar com a extensão do Visual Editor (sim, desnecessariamente complicado, mas fazer o quê?):

[CONTINUA...]

Como alterar o tema (skin) padrão de sua wiki

Via de regra, o MediaWiki vem pré-instalado com o tema (skin) Vector como padrão, porém, por uma razão ou outra, talvez seja de seu interesse alterar o tema padrão de seu site.

Cada usuário tem o poder de alterar o tema padrão para si mesmo dentro das configurações de sua conta, mas através do LocalSettings.php você pode alterar o tema padrão que será aplicado para todas as pessoas que acessarem o site sem logar ou para aqueles usuários que não alterarem o tema padrão nas configurações de sua conta.

O código para alterar o tema padrão já vem escrito no arquivo LocalSettings.php e basta você dar um Ctrl+F para localizá-lo:

$wgDefaultSkin = "vector";

Para escolher outro tema como o padrão de sua wiki bastar trocar "vector" pelo código do tema desejado. Mas cuidado: nem todo tema terá seu código idêntico ao seu nome como no caso do tema Vector, cujo código é "vector". Por exemplo, o tema Classic tem como código a palavra "standard".

Para saber qual o código do tema desejado, acesse: https://www.mediawiki.org/wiki/Manual:$wgDefaultSkin, onde você encontrará uma tabela com o código (ID) dos temas mais utilizados.

Como alterar a imagem de fundo da sua wiki

Tema: Timeless

Para wikis que utilizam o tema "Timeless" como padrão, para alterar a imagem de fundo basta incluir o seguinte código no seu LocalSettings.php:

$wgTimelessBackdropImage = "CAMINHO DA IMAGEM";

O "caminho da imagem" funciona da mesma forma que o caminho da logo: basta subir a imagem de fundo dentro do servidor do seu MediaWiki e depois colocar o caminho dele ali. Por exemplo:

$wgTimelessBackdropImage = "$wgResourceBasePath/resources/assets/imagem-de-fundo.png";

É possível escolher diferentes tamanhos para diferentes graus de aproximação, mas eu particularmente desconheço como configurar esse código. Experimente imagens de vários tamanhos e veja qual fica melhor para você.