Erweiterung:GettingStarted

MediaWiki-Erweiterungen

GettingStarted Freigabestatus: ohne Wartung
Einbindung	Benutzer-Schnittstelle, API
Beschreibung	Delivers task suggestions to new editors and shows editors how to complete those tasks
Autor(en)	Munaf Assaf, Matthew Flaschen, Pau Giner, Kaity Hammerstein, Ori Livneh, Rob Moen, S Page, Sam Smith, Moiz Syed
Letzte Version	Laufende Aktualisierungen
MediaWiki	1.25+
Lizenz	GNU General Public License 2.0 oder neuer
Herunterladen	Erweiterung herunterladen Git [?]: Git master herunterladen Repository durchsuchen (Phabricator · GitHub) Ergänzungen und Änderungen Repository-Mitwirkende (GitHub) Code-Review
Parameter $wgGettingStartedRedisSlave $wgGettingStartedTasks $wgGettingStartedRedisOptions $wgGettingStartedRedis $wgGettingStartedCategoriesForTaskTypes $wgGettingStartedExcludedCategories
Verwendete Hooks ArticleDeleteComplete BeforePageDisplay CategoryAfterPageAdded CategoryAfterPageRemoved CentralAuthPostLoginRedirect GetPreferences MakeGlobalVariablesScript PostLoginRedirect ResourceLoaderGetConfigVars ResourceLoaderRegisterModules UserLogoutComplete
Quarterly downloads	9 (Ranked 165th)
Übersetze die GettingStarted-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Probleme	Offene Aufgaben · Einen Fehler melden

The GettingStarted extension provides an onboarding process for new editors of Wikipedia.

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 Erweiterung:GrowthExperiments extension.

Funktionen

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:
  • EventLogging (for logging)
  • GuidedTour (for providing tours and tooltips)
  • Redis (for maintaining its lists of articles)
• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens GettingStarted im Ordner extensions/ ablegen.
• Folgenden Code am Ende der LocalSettings.php einfügen:

  wfLoadExtension( 'GettingStarted' );
  

• Configure as required
•  Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Für Benutzer, die MediaWiki in der Version 1.27 und früher betreiben:

Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.27 und früher)  – an Stelle von wfLoadExtension( 'GettingStarted' ); – installiert, benutze:

require_once "$IP/extensions/GettingStarted/GettingStarted.php";

CentralAuth is supported but not required.

Konfiguration

The following configuration parameters are provided:

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

API

gettingstartedgetpages
Dieses Modul kann nicht als Generator benutzt werden!
Präfix	gsgp
Erforderliche Rechte	Keine
nur Beitrag?	Nein
generierte Hilfe	aktuell

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

api.php?action=query&list=gettingstartedgetpages&gsgptaskname=morelike&gsgpexcludedtitle=Earth&gsgpcount=10&format=json [In der ApiSandbox ausprobieren]

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

api.php?action=query&list=gettingstartedgetpages&gsgptaskname=copyedit&gsgpcount=1 [In der ApiSandbox ausprobieren]

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

api.php?action=query&list=gettingstartedgetpages&gsgptaskname=copyedit&gsgpcount=3&format=xml [In der ApiSandbox ausprobieren]

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

Siehe auch

• List of MediaWiki messages used (English Wikipedia version)