Extension:GettingStarted

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:GettingStarted and the translation is 82% complete.

Other languages:
English • ‎español • ‎русский • ‎中文 • ‎日本語
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
GettingStarted
リリースの状態: 安定
実装 User interface, API
説明 登録したばかりの編集者を対象に、タスクの提案と完了する方法を送信する
作者
  • Munaf Assaf,
  • Matthew Flaschen,
  • Pau Giner,
  • Kaity Hammerstein,
  • Ori Livneh,
  • Rob Moen,
  • S Page,
  • Sam Smith,
  • Moiz Syed
最新バージョン 継続的な更新
MediaWiki 1.25+
データベースの変更 いいえ
ライセンス GNU General Public License 2.0 or later
ダウンロード
パラメーター
  • $wgGettingStartedTasks
  • $wgGettingStartedCategoriesForTaskTypes
  • $wgGettingStartedExcludedCategories
  • $wgGettingStartedRedis
  • $wgGettingStartedRedisSlave
  • $wgGettingStartedRedisOptions
  • $wgGettingStartedRunTest
  • $wgvTaskRecommendationsExperimentV1StartDate
  • $wgTaskRecommendationsExperimentV1EndDate
使用するフック
BeforePageDisplay
CategoryAfterPageAdded
CategoryAfterPageRemoved
ArticleDeleteComplete
MakeGlobalVariablesScript
ResourceLoaderGetConfigVars
ResourceLoaderRegisterModules
CentralAuthPostLoginRedirect
PostLoginRedirect
GetPreferences
UserLogoutComplete
PersonalUrls
translatewiki.net で翻訳を利用できる場合は、GettingStarted 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点 未解決のタスク · バグを報告

GettingStarted拡張機能はウィキペディアの新人編集者に活動への案内onboarding process を提供します。

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. The extension is still maintained by Sam Smith.

特徴

UX/UI (ユーザー体験・ユーザーインターフェース) の詳細はOnboarding new Wikipedians をご参照ください

GettingStartedは新しく登録された編集者にいくつかのインターフェースを提供し、guided tours を使い入門篇のタスクを提案して、最初の編集を完了する方法を示します。

CentralAuth拡張機能をインストールしてある場合、GettingStartedの利用者はアカウント作成直前に閲覧していたページ(有効な戻り先がない場合はメインページ)に戻ることになっています。 その戻った先にて、利用者は2つの行動選択肢としてその時点で表示されている記事の編集もしくは編集が簡単な別の記事を提示されます。

CentralAuthを未利用の場合には、プロセスは上記と同じですが、標準的なコア機能の中間ページが表示され、個人設定を変更できます(またはリンクをクリックして戻ります)。 内部参照元へのリンクが変更され、GettingStartedパラメータを含むようになりました(上記の招待の誘因です)。

インストール

  • Install the required dependencies:
  • ダウンロードして、ファイルを extensions/ フォルダー内の GettingStarted という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'GettingStarted' );
    
  • Configure as required
  • Yes 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.27 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.27 以前) にインストールする必要がある場合は、wfLoadExtension( 'GettingStarted' ); の代わりに以下を使用する必要があります:

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

設定

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

関連項目