Extensão:GettingStarted

This page is a translated version of the page Extension:GettingStarted and the translation is 100% complete.
Other languages:
English • ‎Türkçe • ‎português do Brasil • ‎中文 • ‎日本語
Manual de extensões do MediaWiki
OOjs UI icon advanced.svg
GettingStarted
Estado da versão: estável
Implementação Interface de usuário, API
Descrição Fornece sugestões de tarefas para novos editores e mostra-lhes como concluí-las
Autor(es)
  • Munaf Assaf,
  • Matthew Flaschen,
  • Pau Giner,
  • Kaity Hammerstein,
  • Ori Livneh,
  • Rob Moen,
  • S Page,
  • Sam Smith,
  • Moiz Syed
Última versão Atualizações contínuas
MediaWiki 1.25+
Licença GNU GPL (Licença Pública Geral) 2.0 ou superior
Download
  • $wgGettingStartedRedisSlave
  • $wgGettingStartedTasks
  • $wgGettingStartedRedisOptions
  • $wgGettingStartedRedis
  • $wgGettingStartedCategoriesForTaskTypes
  • $wgGettingStartedExcludedCategories
Para traduzir a extensão GettingStarted, verifique sua disponibilidade no translatewiki.net

Verificar uso e matriz de versões

Problemas Tarefas em aberto · Relatar um bug

A extensão GettingStarted fornece um processo de ambientação para novos editores da Wikipédia.

A extensão foi implantada pela Equipe de Crescimento em meados de 2014. Entretanto, com a supressão da equipe ocorrida em outubro daquele ano, a maior parte dos autores da extensão se transferiram para outros projetos. A extensão ainda é mantida pelo usuário Sam Smith.

Recursos

UX/UI descritos mais detalhadamente em Onboarding new Wikipedians

A extensão fornece diversas interfaces para sugerir tarefas introdutórias a editores recém-registrados e usa de guided tours para mostrá-los como fazer suas primeiras edições.

Se o CentralAuth estiver instalado, usuários da GettingStarted serão redirecionados de volta ao encaminhador interno (ou, se não houver, à página principal) após o registro. Após o redirecionamento, um convite será exibido para ou editar a página atual ou tomar alguma sugestão de algo fácil de editar.

Sem o CentralAuth, a diferença é que é exibida a página de preferências (ou uma ligação para voltar). A ligação ao encaminhador interno é modificada para incluir um parâmetro ao GettingStarted (ativando o convite mencionado acima).

Instalação

  • Install the required dependencies:
  • Baixe e coloque o(s) arquivo(s) num diretório chamado GettingStarted na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    wfLoadExtension( 'GettingStarted' );
    
  • Configure as required
  •   Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

Para usuários executando o MediaWiki 1.27 ou anteriores:

As instruções acima descrevem a nova forma de instalar essa extensão utilizando wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.27 e anteriores), em vez de wfLoadExtension( 'GettingStarted' );, você precisa usar:

require_once "$IP/extensions/GettingStarted/GettingStarted.php";
CentralAuth is supported but not required.

Configuração

The following configuration parameters are provided:

  • $wgGettingStartedTasks
  • $wgGettingStartedCategoriesForTaskTypes
  • $wgGettingStartedExcludedCategories
  • $wgGettingStartedRedis
  • $wgGettingStartedRedisSlave
  • $wgGettingStartedRedisOptions
  • $wgGettingStartedRunTest
  • $wgvTaskRecommendationsExperimentV1StartDate
  • $wgTaskRecommendationsExperimentV1EndDate

API

The extension implements a MediaWiki API query list submodule "gettingstartedgetpages" that supplies

  • suggested pages to work on
  • or simply related pages.

"Related pages" relies on the morelike: prefix search feature of the Cirrus Search extension.

Suggested pages are optional for the GettingStarted new user experience and they only appear if the wiki has appropriate task categories set. GettingStarted stores lists of articles in Redis, populating them from on-wiki categories such as English Wikipedia's All articles needing copy edit according to the configuration in $wgGettingStartedCategoriesForTaskTypes . You may also exclude certain categories via $wgGettingStartedExcludedCategories . On the Wikimedia cluster, configuration settings in InitialiseSettings.php determine their value.

View the generated API documentation for the gettingstartedgetpages API module on English Wikipedia. The following are examples of types of pages you request from the API:

  • Get 10 random pages, related to Earth


  • Get a single random page that needs copy-editing.


  • Get three random pages needing copy-editing, in XML.


Developer notes

Setting up the environment for automated browser testing

The extension's automated browser tests require that:

  1. The $wgGettingStartedCategoriesForTaskTypes variable has been configured in InitialiseSettings.php ; and
  2. The populate_categories.php maintenance script has been run.

For example, if and when the extension's nightly build starts failing because there aren't any suggestions (see https://phabricator.wikimedia.org/diffusion/EGST/browse/master/tests/browser/features/modal_on_editable_returnto.feature$10), then run the populate_categories.php maintenance script on the Beta Cluster, i.e.

ssh deployment-tin.deployment-prep.eqiad.wmflabs
foreachwikiindblist gettingstarted-with-category-suggestions.dblist extensions/GettingStarted/maintenance/populate_categories.php

Ver também