Extension:Cargo

MediaWiki 拡張機能マニュアル

Cargo リリースの状態: 安定
実装	特別ページ , API , パーサー関数
説明	テンプレートに含まれるデータを格納できるようにし、データのクエリを実行できるようにする拡張機能。
作者	Yaron Koren <yaron57@gmail.com> (Yaron Korenトーク)
最新バージョン	3.4.3 (2023年7月)
互換性の方針	master は後方互換性を維持しています。
MediaWiki	1.35+
データベースの変更	はい
Composer	mediawiki/cargo
テーブル	cargo_tables cargo_pages cargo_backlinks
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (Phabricator · GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー
例	A page containing various calls to #cargo_query
パラメーター $wgCargoFileDataColumns $wgCargoDrilldownLargestFontSize $wgCargoDecimalMark $wgCargoDefaultStringBytes $wgCargoAllowedSQLFunctions $wgCargoHideNamespaceName $wgCargoPageDataColumns $wgCargoMaxVisibleHierarchyDrilldownValues $wgCargoDrilldownSmallestFontSize $wgCargoIgnoreBacklinks $wgCargoRecurringEventMaxInstances $wgCargoDefaultMapService $wgCargoStoreUseTemplateArgsFallback $wgCargoLegacyNullLuaFieldsAsEmptyString $wgCargoTablesPrioritizeReplacements $wgCargoDigitGroupingCharacter $wgCargoDefaultQueryLimit $wgCargoDrilldownNumRangesForNumbers $wgCargo24HourTime $wgCargoMaxQueryLimit $wgCargoDrilldownUseTabs $wgCargoMapClusteringMinimum $wgCargoDrilldownMinValuesForComboBox
使用するフック AdminLinks ApprovedRevsRevisionApproved ApprovedRevsRevisionUnapproved CategoryAfterPageAdded CategoryAfterPageRemoved LinksUpdate LoadExtensionSchemaUpdates MakeGlobalVariablesScript PageForms::TemplateFieldEnd PageForms::TemplateFieldStart PageMoveComplete PageSaveComplete PageSchemasRegisterHandlers ParserFirstCallInit ResourceLoaderGetConfigVars ScribuntoExternalLibraries SidebarBeforeOutput SkinTemplateNavigation::Universal UploadComplete
提供するフック CargoSetFormatClasses CargoBeforeStoreData CargoDisplayExportData CargoTablesSetAllowedActions CargoTablesSetActionLinks
Quarterly downloads	110 (Ranked 71st)
Cargo 拡張機能の翻訳にご協力ください
問題点	未解決のタスク · バグを報告

Cargo は MediaWiki 拡張機能であり、テンプレート呼び出しに含まれるデータを格納したり、データのクエリを実行したりできる軽量な方法を提供します。 概念は Semantic MediaWiki 拡張機能に似ていますが、インストールの容易さや使いやすさなど、多くの利点があります。

Cargo stores all its data in database tables, which can be placed in either MediaWiki's own database (the default) or a separate database. For the most part, each stored template gets its data stored in a single DB table, with a column for each relevant template parameter. There are a few exceptions to this: the handling of template fields that hold arrays/lists of values, and of fields that hold geographical coordinates, is more complex, due to poor native handling of those data types in most DB systems. And multiple templates can be set to all store their data in one DB table.

The extension defines a number of parser functions; these three are the most important:

• #cargo_declare - placed within the ‎<noinclude> part of a template; it defines the schema for a table.
• #cargo_store - stores one row to a Cargo table; usually placed within the ‎<includeonly> part of a template.
• #cargo_query - queries one or more Cargo data tables, using SQL components.

The other defined parser functions are:

• #cargo_attach - 他の場所で宣言されたテーブルに行を追加するようにテンプレートを定義します。
• #cargo_compound_query - displays the results of multiple queries in one place.
• #cargo_display_map - displays a map showing a single point.
• #recurring_event - prints out the dates for a recurring event; for use by #cargo_store.

Cargo also defines various interfaces for viewing and drilling down through this stored data. As such, it adds the following special pages:

• Special:CargoQuery
• Special:CargoTableDiagram
• Special:CargoTables
• Special:Drilldown

Cargo has been tested, and works, with the MySQL and PostgreSQL database systems. In theory, it also supports SQLite, but it has not been well-tested with SQLite and may not work.

This version of the Cargo extension requires MediaWiki 1.35+.

Click through the pages in the navigation bar above to learn more about Cargo, how it works, how to use it, and how to install it.

インストール

See Download and Installation.

設定

Below are Cargo's global configuration settings along with their default values.

To configure Cargo to use a separate database instead of the MediaWiki database, the following settings are provided:

Separate Database Configuration Settings
Setting	Default	Description
$wgCargoDBtype	null	Database type.
$wgCargoDBserver	null	Host name or IP address of database server.
$wgCargoDBname	null	Name of the database.
$wgCargoDBuser	null	Database username.
$wgCargoDBpassword	null	The password for $wgCargoDBuser.
$wgCargoDBprefix	null	Database table name prefix.
$wgCargoDBRowFormat	null	Data base row format.

For character configuration as related to numbers, the following configuring settings are provided:

Character Configuration Settings
Setting	Default	Description
$wgCargoDecimalMark	.	Decimal character for numbers.
$wgCargoDigitGroupingCharacter	,	Thousands digit separator.

The remaining global configuration settings are as follows:

Setting	Default	Description
$wgCargoAllowedSQLFunctions	[]	Sets allowed SQL functions. See Using SQL Functions for defaults.
$wgCargoRecurringEventMaxInstances	100	The number of max instances to store for recurring events with no set end date.
$wgCargoDefaultStringBytes	300	The default number of characters for fields of type Page, String, Wikitext string, File, URL, and Email.
$wgCargoDefaultQueryLimit	100	Number of results to show for #cargo_query if no limit is set
$wgCargoMaxQueryLimit	5000	The maximum allowed number of results for #cargo_query
$wgCargo24HourTime	false	If true uses 24-hour time for Datetime field types.
$wgCargoDefaultMapService	OpenLayers	Sets the default map service to Google Maps, if set to googlemaps, to Leaflet if set to leaflet, and to OpenLayers if set to openlayers.
$wgCargoGoogleMapsKey	null	API key for Google Maps, for the googlemaps display format.
$wgCargoMapClusteringMinimum	80	If the number of map points displayed is greater than the value of $wgCargoMapClusteringMinimum, the map displays the locations in "clusters" instead of individual points, for readability. If set to a very high number, does not display clustering.
$wgCargoDrilldownUseTabs	true	Displays Special:Drilldown table names as tabs at the top instead of a vertical list at the side.
$wgCargoDrilldownSmallestFontSize	-1	If set to a positive number, sets the smallest font size, in pixels, for a tag-cloud-style display of filter values.
$wgCargoDrilldownLargestFontSize	-1	If set to a positive number, sets the largest font size, in pixels, for a tag-cloud-style display of filter values.
$wgCargoDrilldownMinValuesForComboBox	40	Sets the minimum number of values before their display is converted to a combo box, instead of individual links.
$wgCargoDrilldownNumRangesForNumbers	5	For fields/filters of type Integer or Float, specifies the number of "buckets" into which values are divided.
$wgCargoMaxVisibleHierarchyDrilldownValues	30	If set to a positive integer, specifies the maximum number of values shown at a time for any hierarchy field (All the top-level values are shown irrespective of this value). The values are hidden beyond a certain depth of the hierarchy such that the count of total visible values is at most this number.
$wgCargoTablesPrioritizeReplacements	false	If true, all tables having a replacement appear at the top of the Special:CargoTables page, instead displaying them in alphabetical order.
$wgCargoPageDataColumns	[]	The set of fields to store in the _pageData Cargo table. See Storing page data.
$wgCargoFileDataColumns	[]	The set of fields to store in the _fileData Cargo table. See Storing file data.
$wgCargoHideNamespaceName	[6]	Array of namespaces to hide from query results.

関連項目

• Manual:MediaWikiのデータ管理法 – An overview and comparison.
• DynamicPageList – Allows to extract data from pages.
• Semantic MediaWiki – Allows for the storage and querying of data within pages.
• WikiDB – Provides database features, somewhat similar to semantic properties.
• Wikibase – Allows to represent and manipulate structured data as part of the Wikidata project.