Extension:PageAssessments

MediaWiki 拡張機能マニュアル

PageAssessments リリースの状態: 安定
実装	パーサー関数 , データベース
説明	An extension for storing article assessments (e.g. for WikiProjects) in a new database table
作者	Niharika Kohli Frances Hocutt Ryan Kaldari
最新バージョン	1.1.0 (2016-01-11)
MediaWiki	>= 1.43
データベースの変更	はい
テーブル	page_assessments page_assessments_projects
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー
パラメーター $wgPageAssessmentsOnTalkPages $wgPageAssessmentsSubprojects
使用するフック ArticleDeleteComplete LinksUpdateComplete LoadExtensionSchemaUpdates ParserFirstCallInit
四半期ごとのダウンロード数	4 (Ranked 127th)
translatewiki.net で翻訳を利用できる場合は、PageAssessments 拡張機能の翻訳にご協力ください
問題点	未解決のタスク · バグを報告

This extension is for storing article assessments (e.g. for WikiProjects) in a structured and query-able way. For an example of how article assessments are done, see the guidelines on Wikipedia.

インストール

• ダウンロードして、ファイルをextensions/フォルダー内のPageAssessmentsという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageAssessments
• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'PageAssessments' );
  

• 更新スクリプトを実行します。このスクリプトは、この拡張機能が必要とするデータベーステーブルを自動的に作成します。
•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

You can also use these configuration options in your LocalSettings.php:

• $wgPageAssessmentsOnTalkPages — If assessments are normally recorded on the pages themselves rather than on talk pages, set this to false (default: true).
• $wgPageAssessmentsSubprojects — If projects on your wiki have subprojects or task forces that you would like to record separate assessments for, set this to true (default: false).

使用法

The parser function for creating a new assessment is: {{#assessment: <name of the wikiproject> | <class> | <importance>}}

• name of the wikiproject — a short name for the project assessing the article, for example, "Medicine" or "Hungarian culture‎". Can be up to 128 characters long.
• class — a quality ranking, for example, "B" or "FA". See the class grades on Wikipedia for a more comprehensive example. Can be up to 20 characters long.
• importance — a ranking of how important the article is to the project, for example, "Low" or "High". Can be up to 20 characters long.

The assessment parser function is expected to be on the talk page of the page under review, however it may be included on the page itself if $wgPageAssessmentsOnTalkPages is set to false. A page may have more than one assessment function for different projects.

If an assessment template is already in use on multiple pages, the parser function can be embedded inside the template instead of having to edit each individual article's talk page.

Example usage

The importance/priority of an article might be different depending on the WikiProject:

{{#assessment:Medicine|A|Low}}
{{#assessment:Biology|B|High}}

Explanation:

Using this example in a talk page, declares the current page inside the Medicine project, with A quality, and with Low importance.

It also declares the current page in the Biology project, with B quality, and with High importance.

API

The PageAssessments extension includes three API query modules: pageassessments, projectpages, and projects.

Pageassessments

pageassessments is a new property query for the MediaWiki Action API. It is used to retrieve assessment metadata for one or more pages.

例

Get project and assessment data for page "Apple".

api.php?action=query&prop=pageassessments&titles=Apple

Get project and assessment data for pages "Apple" and Pear, using the newer API result format.

api.php?action=query&prop=pageassessments&titles=Apple|Pear&formatversion=2

Get project and assessment data for page "Apple", including subprojects and task forces (only available if $wgPageAssessmentsSubprojects is true).

api.php?action=query&prop=pageassessments&titles=Apple&pasubprojects=true

Projectpages

projectpages is a new list query. It is used to retrieve all the pages assessed by a particular WikiProject. This query can be used as a generator. By adding wppassessments=true, you can also get the assessment metadata for each of the pages.

例

Get first 10 pages associated with any WikiProject:

api.php?action=query&list=projectpages [ApiSandbox で試用する]

Get first 10 pages associated with WikiProject Medicine, including assessment data:

api.php?action=query&list=projectpages&wppprojects=Medicine&wppassessments=true [ApiSandbox で試用する]

Get page info for first 10 pages associated with WikiProject Textile Arts:

api.php?action=query&generator=projectpages&prop=info&gwppprojects=Textile%20Arts [ApiSandbox で試用する]

Projects

projects is a new list query. It is used to retrieve a list of all the WikiProjects on a wiki. The results are returned as an array of project names.

例

Get a list of all the WikiProjects.

api.php?action=query&list=projects

Get a list of all the WikiProjects, including subprojects and task forces (only available if $wgPageAssessmentsSubprojects is true).

api.php?action=query&list=projects&pjsubprojects=true

特別ページ

PageAssessments also provides an on-wiki interface for retrieving assessment data at Special:PageAssessments.

データベースのテーブル

PageAssessments creates two new database tables:

• page_assessments
• page_assessments_projects

page_assessments stores the assessment metadata, while page_assessments_projects stores the names of WikiProjects (so that they don't have to be recorded in full as part of each assessment record in the page_assessments table). Both tables are required for proper functioning of the parser function and APIs. The tables should exist on any wiki that has the PageAssessments extension installed. If PageAssessments is uninstalled, both tables can be dropped safely.

The purgeUnusedProjects.php maintenance script can be run to remove projects from the page_assessments_projects table that are no longer used by any assessments.

関連項目

• Community Tech/PageAssessments at Meta-Wiki
• Create new extension implementing article importance and quality