Rozšíření:GettingStarted

This page is a translated version of the page Extension:GettingStarted and the translation is 21% complete.
Základní informace k tomuto rozšíření MediaWiki
GettingStarted
Stav rozšíření: bez správce
Zavádění Uživatelské rozhraní, API
Popis Přináší návrhy úkolů novým editorům a ukazuje editorům, jak tyto úkoly dokončit
Napsal(i)
  • Munaf Assaf,
  • Matthew Flaschen,
  • Pau Giner,
  • Kaity Hammerstein,
  • Ori Livneh,
  • Rob Moen,
  • S Page,
  • Sam Smith,
  • Moiz Syed
Nejnovější verze Průběžně aktualizováno
MediaWiki 1.25+
Licence GNU General Public License 2.0 nebo pozdější
Zdrojový kód
  • $wgGettingStartedRedisSlave
  • $wgGettingStartedTasks
  • $wgGettingStartedRedisOptions
  • $wgGettingStartedRedis
  • $wgGettingStartedCategoriesForTaskTypes
  • $wgGettingStartedExcludedCategories
Čtvrtletní stahování 5 (Ranked 155th)
Přeložte rozšíření GettingStarted, používá-li lokalizaci z translatewiki.net
Problémy Otevřené úkoly · Nahlásit chybu

Rozšíření GettingStarted poskytuje proces registrace pro nové editory Wikipedie.

The extension was deployed by the Growth team circa 2014. However, in October, 2014, the Growth team disbanded and since then a number of the extension's authors have shifted focus. In October 2021, the extension was removed from Wikimedia wikis in favor of the newer GrowthExperiments extension.

UX/UI described in more detail at Onboarding new Wikipedians

GettingStarted provides several interfaces for suggesting introductory tasks to newly-registered editors, and it uses guided tours to show them how to complete their first edits.

If CentralAuth is installed, GettingStarted users are redirected back to their internal referrer (or the main page, if there was no referrer) post-registration. After users are sent back, they are provided with an invitation to either edit the current page or take a suggestion of something easy to edit.

Without CentralAuth, the above is the same, but the standard core interstitial page letting you change your preferences (or click a link to return) shows. The link to their internal referrer is modified to include a GettingStarted parameter (triggering the above-mentioned invitation).

Installation

  • Install the required dependencies:
  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného GettingStarted ve vaší složce extensions/.
  • Na konec vašeho souboru LocalSettings.php přidejte následující kód:
    wfLoadExtension( 'GettingStarted' );
    
  • Configure as required.
  • Yes Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.

Pro ty, kteří používají MediaWiki 1.27 a starší:

Výše uvedené instrukce se týkají instalace přes wfLoadExtension(), což je novější způsob instalace rozšíření. Pokud potřebujete toto rozšíření nainstalovat na starší verzi (MediaWiki 1.27 či starší), musíte místo wfLoadExtension( 'GettingStarted' ); použít:

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

Configuration

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

See also