README

Wikibase 扩展，用于将数据导出为简单的 CSV 格式。

Professional.Wiki 创建并维护 Wikibase Export。我们提供 Wikibase 主机托管，Wikibase 开发和 Wikibase 咨询。

演示
使用方法
REST API
安装
PHP 配置
导出页面文本配置
开发
发行说明

演示

通过查看演示维基或演示视频，快速了解此扩展的功能。

使用文档

请参阅使用文档。

REST API

此扩展提供了一个用于导出 Wikibase 项目的 REST API 端点。

有关更多信息，请参阅 REST API 文档。

安装

平台要求

PHP 8.0 或更高版本（已测试至 8.1）
MediaWiki 1.37 或更高版本（已测试至 1.39）
Wikibase 1.37 或更高版本（已测试至 1.39）

安装 Wikibase Export 的推荐方法是使用 Composer，利用 MediaWiki 内置对 Composer 的支持。

在命令行中，前往您的维基根目录。然后运行以下两个命令

COMPOSER=composer.local.json composer require --no-update professional-wiki/wikibase-export:~1.0

composer update professional-wiki/wikibase-export --no-dev -o

然后通过在您的维基的 LocalSettings.php 文件底部添加以下内容来启用扩展

wfLoadExtension( 'WikibaseExport' );

您可以通过打开您的维基的 Special:Version 页面来验证扩展是否已成功启用。

PHP 配置

配置可以通过 LocalSettings.php 进行更改。

导出配置

以 JSON 格式，遵循位于 schema.json 的 JSON Schema。与在 MediaWiki:WikibaseExportConfig 页面上定义的规则相结合。

变量: $wgWikibaseExport

默认: ""

示例: example.json

注意：无效的 JSON 将被忽略。不会显示错误，只是不会应用预期的配置。

启用维基内配置

如果应该可以通过 MediaWiki:WikibaseExportConfig 来配置此扩展。

变量: $wgWikibaseExportEnableInWikiConfig

默认: true

示例: false

页面 MediaWiki:WikibaseExportConfig 总是可用的。如果将此配置设置为 false，其内容将被忽略。

开发

为确保安装开发依赖项，请在您的 composer.local.json 中添加以下内容

{
	"require": {
		"vimeo/psalm": "^4",
		"phpstan/phpstan": "^1.8.11"
	},
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/WikibaseExport/composer.json"
			]
		}
	}
}

运行测试和CI检查

您可以通过在 WikibaseExport 目录中运行make命令来使用 Makefile。

make ci：运行所有内容
make test：运行所有测试
make cs：运行所有样式检查和静态分析

或者，您也可以从 MediaWiki 根目录执行命令

PHPUnit： php tests/phpunit/phpunit.php -c extensions/WikibaseExport/
样式检查： vendor/bin/phpcs -p -s --standard=extensions/WikibaseExport/phpcs.xml
PHPStan： vendor/bin/phpstan analyse --configuration=extensions/WikibaseExport/phpstan.neon --memory-limit=2G
Psalm： php vendor/bin/psalm --config=extensions/WikibaseExport/psalm.xml

发行说明

版本 1.0.0 - 2023-02-06

带有导出UI的特殊页面
- 语言选择器
- 主题（实体）选择器
- 根据时间点或时间范围限定符按年份分组和过滤
- 为分组和未分组值选择属性
- 标题样式选择：实体标签或实体ID
支持多个值
可以通过PHP和 MediaWiki:WikibaseExportConfig 上的配置UI设置的配置
导出API端点
TranslateWiki集成
支持PHP 8.0至8.2
支持MediaWiki 1.37至1.39

专业维基 / wikibase-export

维护者

详细信息