Extension:GettingStarted/zh
此扩展目前不再活跃维护! 尽管它可能仍然工作,但任何错误报告或功能请求将很可能被忽略。 如果您对承担开发与维护该扩展的任务工作感兴趣,您可以请求自己的存储库。 As a courtesy, you may want to contact the author. 或者您应移除该模板,并在页面的{{extension}}信息框中将您自己列为扩展的维护人员。 |
![]() 發佈狀態: 不再維護 |
|
---|---|
实现 | 用户界面, API |
描述 | Delivers task suggestions to new editors and shows editors how to complete those tasks |
作者 |
|
最新版本 | Continuous updates |
MediaWiki | 1.25+ |
许可协议 | GNU通用公眾授權條款2.0或更新版本 |
下載 | |
|
|
季度下載量 | 9 (Ranked 168th) |
翻譯GettingStarted的扩展,若在translatewiki.net可用 | |
問題 | 尚未完成的工作 · 报告錯誤 |
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 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).
安裝
- Install the required dependencies:
- EventLogging (for logging)
- GuidedTour (for providing tours and tooltips)
- Redis (for maintaining its lists of articles)
- 下载文件,并将其放置在您
extensions/
文件夹中的GettingStarted
目录内。 - 将下列代码放置在您的
LocalSettings.php
的底部:wfLoadExtension( 'GettingStarted' );
- Configure as required
- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
致使用MediaWiki 1.27或更早版本的用户:
上面的说明介绍的是安装此扩展的新方法,它使用wfLoadExtension()
。
如果您需要在早期版本(MediaWiki 1.27和更早版本)中安装此扩展,而不是wfLoadExtension( 'GettingStarted' );
,您需要使用:
require_once "$IP/extensions/GettingStarted/GettingStarted.php";
配置
The following configuration parameters are provided:
$wgGettingStartedTasks
$wgGettingStartedCategoriesForTaskTypes
$wgGettingStartedExcludedCategories
$wgGettingStartedRedis
$wgGettingStartedRedisSlave
$wgGettingStartedRedisOptions
$wgGettingStartedRunTest
$wgvTaskRecommendationsExperimentV1StartDate
$wgTaskRecommendationsExperimentV1EndDate
API
gettingstartedgetpages | |
---|---|
此模块不能用作generator。 | |
前缀 | gsgp |
需要的权限 | 无 |
仅限Post? | 否 |
产生帮助 | 当前 |
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:
- The
$wgGettingStartedCategoriesForTaskTypes
variable has been configured in InitialiseSettings.php ; and - 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
参见
- List of MediaWiki messages used (English Wikipedia version)