Skip to content

Commit 1847df2

Browse files
committed
Usage instructions
1 parent 31d9151 commit 1847df2

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,39 @@
11
DCAT-AP for Wikibase
22
=================
33

4-
A project aimed at generating a [DCAT-AP](https://joinup.ec.europa.eu/system/files/project/c3/22/18/DCAT-AP_Final_v1.00.html) document for [Wikibase](http://wikiba.se) installations
4+
A project aimed at generating a [DCAT-AP](https://joinup.ec.europa.eu/system/files/project/c3/22/18/DCAT-AP_Final_v1.00.html)
5+
document for [Wikibase](http://wikiba.se) installations
56
in general and [Wikidata](http://wikidata.org) in particular.
67

78
Takes into account access through:
89

9-
* Content negotiation (various formats)
10-
* MediaWiki api (various formats)
11-
* JSON dumps (assumes that these are gziped)
10+
* Content negotiation (various formats)
11+
* MediaWiki api (various formats)
12+
* JSON dumps (assumes that these are gziped)
1213

1314
Current result can be found at [lokal-profil / dcat-wikidata.rdf](https://gist.github.com/lokal-profil/8086dc6bf2398d84a311)
15+
16+
17+
## To use
18+
19+
1. Copy `config.example.json` to `config.json` and change the contents
20+
to match your installation. Refer to `config.explanations.json` for
21+
the individual configuration parameters.
22+
2. Copy `catalog.example.json` to a suitable place (e.g. on-wiki) and
23+
update the translations to fit your wikibase installation. Set this
24+
value as `catalog-i18n` in the config file.
25+
3. Create the dcatap.rdf file by running `php -r "require 'DCAT.php'; run('<PATH>');"`
26+
where `<PATH>` is the relative path to the directory containing the
27+
dumps (if any) and where the dcatap.rdf file should be created.
28+
`<PATH>` can be left out if already supplied through the `directory`
29+
parameter in the config file.
30+
31+
32+
## Translations
33+
34+
* Translations which are generic to the tool can be submitted as pull
35+
requests and should be in the same format as the files in the `i18n`
36+
directory.
37+
* Translations which are specific to a project/catalog are added to
38+
the location specified in the `catalog-i18n` parameter of the config
39+
file.

0 commit comments

Comments
 (0)