Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/professionalwiki/gnd
GND MediaWiki extension created for the German National Library
https://github.com/professionalwiki/gnd
gnd mediawiki mediawiki-extension wikibase wikibase-extension
Last synced: 3 months ago
JSON representation
GND MediaWiki extension created for the German National Library
- Host: GitHub
- URL: https://github.com/professionalwiki/gnd
- Owner: ProfessionalWiki
- Created: 2020-12-18T22:10:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T13:43:58.000Z (over 1 year ago)
- Last Synced: 2024-10-14T08:21:00.404Z (3 months ago)
- Topics: gnd, mediawiki, mediawiki-extension, wikibase, wikibase-extension
- Language: PHP
- Homepage: https://wikibase.consulting
- Size: 289 KB
- Stars: 4
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GND MediaWiki extension
[](https://github.com/ProfessionalWiki/GND/actions?query=workflow%3ACI)
[](https://codecov.io/gh/ProfessionalWiki/GND)
[](https://packagist.org/packages/dnb/mediawiki-gnd)
[](https://packagist.org/packages/dnb/mediawiki-gnd)
[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](#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][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 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:
```php
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. Default `de`. Supports `en` and `de`.
* `codings`. Optional. Coding columns to show. Default `PICA3, 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 everything
* `make test`: Run all tests
* `make cs`: Run all style checks and static analysis
## Release notes
### Version 0.1.0
Under development
* Initial release for MediaWiki/Wikibase 1.35
[Professional.Wiki]: https://professional.wiki
[Wikibase]: https://wikibase.consulting/what-is-wikibase/
[MediaWiki]: https://www.mediawiki.org
[PHP]: https://www.php.net
[Wikibase Repository]: https://www.mediawiki.org/wiki/Extension:Wikibase_Repository
[Composer]: https://getcomposer.org
[Composer install]: https://professional.wiki/en/articles/installing-mediawiki-extensions-with-composer
[MediaWiki development]: https://professional.wiki/en/mediawiki-development
[Wikibase hosting]: https://professional.wiki/en/hosting/wikibase
[German National Library]: https://www.dnb.de/EN/Home/home_node.html