Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/professionalwiki/wikibaseexport
User-friendly Wikibase export page
https://github.com/professionalwiki/wikibaseexport
export mediawiki mediawiki-extension wikibase wikibase-extension
Last synced: 3 days ago
JSON representation
User-friendly Wikibase export page
- Host: GitHub
- URL: https://github.com/professionalwiki/wikibaseexport
- Owner: ProfessionalWiki
- License: gpl-2.0
- Created: 2022-11-02T23:08:25.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T13:09:53.000Z (4 days ago)
- Last Synced: 2025-01-07T00:38:16.402Z (4 days ago)
- Topics: export, mediawiki, mediawiki-extension, wikibase, wikibase-extension
- Language: PHP
- Homepage: https://professional.wiki/en/extension/wikibase-export
- Size: 416 KB
- Stars: 2
- Watchers: 7
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wikibase Export
[](https://github.com/ProfessionalWiki/WikibaseExport/actions?query=workflow%3ACI)
[](https://shepherd.dev/github/ProfessionalWiki/WikibaseExport)
[](psalm.xml)
[](https://packagist.org/packages/professional-wiki/wikibase-export)
[](https://packagist.org/packages/professional-wiki/wikibase-export)
[](LICENSE)
[Wikibase] extension for exporting data as simple CSV.
[Professional Wiki] created and maintains Wikibase Export. We provide [Wikibase hosting], [Wikibase development], and [Wikibase consulting].
**Table of Contents**
- [Demo](#demo)
- [Usage](#usage-documentation)
- [REST API](#rest-api)
- [Installation](#installation)
- [PHP Configuration](#php-configuration)
- [Export page text configuration](#export-page-text-configuration)
- [Development](#development)
- [Release notes](#release-notes)
## Demo
Quickly get an idea about what this extension does by checking out the [demo wiki] or [demo video].
## Usage documentation
See the [usage documentation](https://professional.wiki/en/extension/wikibase-export).
## REST API
This extension provides a REST API endpoint for exporting Wikibase items.
For more information, refer to the [REST API documentation].
## Installation
Platform requirements:
* [PHP] 8.0 or later (tested up to 8.1)
* [MediaWiki] 1.37 or later (tested up to 1.39)
* [Wikibase] 1.37 or later (tested up to 1.39)
The recommended way to install Wikibase Export is using [Composer] with
[MediaWiki's built-in support for Composer][Composer install].
On the commandline, go to your wikis root directory. Then run these two commands:
```shell script
COMPOSER=composer.local.json composer require --no-update professional-wiki/wikibase-export:~1.0
```
```shell script
composer update professional-wiki/wikibase-export --no-dev -o
```
Then enable the extension by adding the following to the bottom of your wikis [LocalSettings.php] file:
```php
wfLoadExtension( 'WikibaseExport' );
```
You can verify the extension was enabled successfully by opening your wikis Special:Version page.
## PHP Configuration
Configuration can be changed via [LocalSettings.php].
### Export configuration
In JSON format, following the JSON Schema at [schema.json].
Gets combined with rules defined on page `MediaWiki:WikibaseExportConfig`.
Variable: `$wgWikibaseExport`
Default: `""`
Example: [example.json]
Caution: invalid JSON will be ignored. No error will be shown, the intended config will just not be applied.
### Enable in-wiki configuration
If it should be possible to configure this extension via `MediaWiki:WikibaseExportConfig`.
Variable: `$wgWikibaseExportEnableInWikiConfig`
Default: `true`
Example: `false`
The page `MediaWiki:WikibaseExportConfig` will always be available. If this configuration is set to `false`, its contents will be ignored.
## Development
To ensure the dev dependencies get installed, have this in your `composer.local.json`:
```json
{
"require": {
"vimeo/psalm": "^4",
"phpstan/phpstan": "^1.8.11"
},
"extra": {
"merge-plugin": {
"include": [
"extensions/WikibaseExport/composer.json"
]
}
}
}
```
### Running tests and CI checks
You can use the `Makefile` by running make commands in the `WikibaseExport` directory.
* `make ci`: Run everything
* `make test`: Run all tests
* `make cs`: Run all style checks and static analysis
Alternatively, you can execute commands from the MediaWiki root directory:
* PHPUnit: `php tests/phpunit/phpunit.php -c extensions/WikibaseExport/`
* Style checks: `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`
## Release notes
### Version 1.0.0 - 2023-02-06
* Special page with export UI
* Language selector
* Subject (entity) selector
* Grouping and filtering by year based on point in time or time range qualifiers
* Property selection for both grouped and ungrouped values
* Header style choice: entity label or entity ID
* Support for multiple values
* Configuration that can be set via PHP and a configuration UI on `MediaWiki:WikibaseExportConfig`
* API endpoint for export
* TranslateWiki integration
* Support for PHP from 8.0 up to 8.2
* Support for MediaWiki from 1.37 up to 1.39
[Professional Wiki]: https://professional.wiki
[Wikibase]: https://wikibase.consulting/what-is-wikibase/
[Wikibase hosting]: https://professional.wiki/en/hosting/wikibase
[Wikibase development]: https://professional.wiki/en/wikibase-software-development
[Wikibase consulting]: https://wikibase.consulting/
[MediaWiki]: https://www.mediawiki.org
[PHP]: https://www.php.net
[Composer]: https://getcomposer.org
[Composer install]: https://professional.wiki/en/articles/installing-mediawiki-extensions-with-composer
[LocalSettings.php]: https://www.pro.wiki/help/mediawiki-localsettings-php-guide
[Wikibase Stakeholder Group]:https://wbstakeholder.group/
[schema.json]: https://github.com/ProfessionalWiki/WikibaseExport/blob/master/schema.json
[example.json]: https://github.com/ProfessionalWiki/WikibaseExport/blob/master/example.json
[Rest API Documentation]: docs/rest.md
[demo wiki]: https://export.wikibase.wiki/
[demo video]: https://www.youtube.com/watch?v=uBdzDcYChOI