Skip to content

Commit

Permalink
Merge pull request #109 from ProfessionalWiki/rel100
Browse files Browse the repository at this point in the history
Bump to 1.0 and add usage docs
  • Loading branch information
malberts authored Oct 4, 2022
2 parents 61d72db + dfaeb4c commit 5c1452d
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 5 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,23 @@ It was conceived and funded by the [Wikibase Stakeholder Group].

## Usage

TODO
When the extension is enabled, Item and Property pages show a "Mapping to other ontologies" section.
This section is located in between the "In more languages" and "Statements" sections.

<img src="https://user-images.githubusercontent.com/146040/193851219-dc30080a-7cbb-4c1a-9800-e7c7d98ef644.png" style="border: 1px solid black" alt="Property page with a mapping">

Users with editing permissions can add, edit or remove mappings.

A mapping consists of a predicate and a URL. The predicate can only be one out of a preconfigured set of values. The URL has to be a valid URL.

<img src="https://user-images.githubusercontent.com/146040/193851211-b4031ca1-4cc9-47ab-9160-658f4a38d979.png" style="border: 1px solid black" alt="Mapping editing UI">

Mapping predicates can be configured via the `MediaWiki:MappingPredicates` page by anyone with interface-admin permissions.
You can also configure mapping predicates via [PHP Configuration](#php-configuration).

<img src="https://user-images.githubusercontent.com/146040/193851215-86b8ad05-0c1a-431c-ad4b-5750997fd642.png" style="border: 1px solid black" alt="Mapping predicates configuration page">

<img src="https://user-images.githubusercontent.com/146040/193854181-af8b85f2-1444-4882-a0af-d8123331f30c.png" style="border: 1px solid black" alt="Editing mapping predicates via the configuration page">

### REST API

Expand Down Expand Up @@ -83,6 +98,8 @@ $wgWikibaseRdfPredicates = [
];
```

You can also configure what predicates are allowed via the `MediaWiki:MappingPredicates` page.

## Development

To ensure the dev dependencies get installed, have this in your `composer.local.json`:
Expand Down Expand Up @@ -120,7 +137,7 @@ Alternatively, you can execute commands from the MediaWiki root directory:

## Release notes

### Version 1.0.0 - TBD
### Version 1.0.0 - 2022-10-04

Initial release for Wikibase 1.37 with these features:

Expand Down
2 changes: 1 addition & 1 deletion extension.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Wikibase RDF",
"type": "wikibase",

"version": "1.0.0-alpha",
"version": "1.0.0",

"author": [
"[https://Professional.Wiki/ Professional.Wiki]",
Expand Down
2 changes: 1 addition & 1 deletion i18n/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"wikibase-rdf-save-mappings-save-failed": "Speichern fehlgeschlagen",
"wikibase-rdf-entity-id-invalid": "Die von Dir angegebene Entitätskennung ist ungültig.",
"wikibase-rdf-permission-denied": "Du bist nicht berechtigt, die RDF-Zuordnungen zu dieser Entität zu bearbeiten.",
"wikibase-rdf-config-intro": "Das Entfernen von RDF-Prädikaten, die im Wiki genutzt werden, verursacht Probleme mit der Eingabemaske. Davon wird daher abgeraten.",
"wikibase-rdf-config-intro": "",
"wikibase-rdf-config-invalid": "{{PLURAL:$1|Ungültiges RDF-Prädikat|Ungültige RDF-Prädikate}}:\n$2. Die Änderungen wurden nicht gespeichert.",
"wikibase-rdf-config-list-intro": "Diese Seite gibt an, welche Prädikate für die Zuordnungen zu anderen Ontologien verwendet werden können. Diese Funktionalität ist Teil der <a href=\"https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:WikibaseRDF\">„Erweiterung Wikibase RDF“</a>.",
"wikibase-rdf-config-list-heading": "{{PLURAL:$1|Zulässiges RDF-Prädikat|Zulässige RDF-Prädikate}}:",
Expand Down
2 changes: 1 addition & 1 deletion i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"wikibase-rdf-entity-id-invalid": "The entity ID you specified is invalid",
"wikibase-rdf-permission-denied": "You do not have permission to edit this entity's mappings",

"wikibase-rdf-config-intro": "Removing predicates that are in use on your wiki breaks the editing UI and is not recommended.",
"wikibase-rdf-config-intro": "",

This comment has been minimized.

Copy link
@Nikerabbit

Nikerabbit Oct 5, 2022

What's this supposed to mean? Should we disable translation of this message?

This comment has been minimized.

Copy link
@JeroenDeDauw

JeroenDeDauw Oct 5, 2022

Member

There should be no message shown at the moment. I blanked the message rather than removing it, since we might re-add something in the near future. That way we do not need to change the UI code.

If this causes problems for TWN, we can always fully remove the message.

This comment has been minimized.

Copy link
@Nikerabbit

Nikerabbit Oct 24, 2022

I have marked the message as ignored for now. If you add content back, do let us know so that we can re-enable translations.

"wikibase-rdf-config-invalid": "Invalid {{PLURAL:$1|predicate|predicates}}:\n$2. Your changes were not saved.",

"wikibase-rdf-config-list-intro": "This page defines which predicates can be used in mappings to other ontologies. This functionality is part of the <a href=\"https://www.mediawiki.org/wiki/Extension:WikibaseRDF\">Wikibase RDF extension</a>.",
Expand Down

0 comments on commit 5c1452d

Please sign in to comment.