dnb / mediawiki-gnd
Adds scripts to import GND items into Wikibase Repository
Installs: 245
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 6
Forks: 3
Open Issues: 2
Type:mediawiki-extension
Requires
- php: >=7.4
- composer/installers: ^2|^1.0.1
- dnb/wikibase-converter: dev-master
- jeroen/file-fetcher: ^6|^5|^4.2
This package is auto-updated.
Last update: 2024-10-30 02:10:40 UTC
README
MediaWiki extension that adds scripts to import GND PICA+ into Wikibase.
The GND extension was created by Professional.Wiki for the German National Library. Professional.Wiki provides commercial Wikibase hosting, MediaWiki development and support.
Platform requirements
- PHP 7.4 or later, including PHP 8
- MediaWiki 1.35
- Wikibase Repository REL1_35
See the release notes for more information on the different versions of this extension.
Installation
First install MediaWiki and Wikibase Repository.
The recommended way to install the GND extension is using Composer with MediaWiki's built-in support for Composer.
On the commandline, go to your wikis root directory. Then run these two commands:
COMPOSER=composer.local.json composer require --no-update dnb/mediawiki-gnd:*
composer update dnb/mediawiki-gnd --no-dev -o
Enabling the extension
Then enable the extension by adding the following to the bottom of your wikis LocalSettings.php
file:
wfLoadExtension( 'GND' );
You can verify the extension was enabled successfully by opening your wikis Special:Version page in your browser.
Usage: GND doku function
{{#gnd_doku:language=en|codings=PICA3, PICA+}}
Parameters:
language
. Optional language code. Defaultde
. Supportsen
andde
.codings
. Optional. Coding columns to show. DefaultPICA3, PICA+, MARC21
. Supports these 3 values.
Usage: GND import
GND import via ImportGndDump.php
. Example:
php extensions/GND/maintenance/ImportGndDump.php --path extensions/GND/data/GND.json --limit 10
The import script expects a file with one JSON structure per line. Example of a valid file: https://github.com/ProfessionalWiki/GND/blob/master/tests/GND.json
To see all availble options, run:
php extensions/GND/maintenance/ImportGndDump.php --help
GND Vocabulary syncronisation
Doku-wiki vocabulary sync via SyncDokuVocabulary
. Example:
php extensions/GND/maintenance/SyncDokuVocabulary.php
Usage: Changing item properties to strings
Property IDs provided in comma seperated list. Spacing does not matter.
php extensions/GND/maintenance/ItemPropertiesToStrings.php --properties "P1, P2, P3"
Running tests and CI checks
You can use the Makefile
by running make commands in the ExternalContent
directory.
make ci
: Run everythingmake test
: Run all testsmake cs
: Run all style checks and static analysis
Release notes
Version 0.1.0
Under development
- Initial release for MediaWiki/Wikibase 1.35