Skip to content
Snippets Groups Projects
Unverified Commit c3f5a0da authored by Odin Kroeger's avatar Odin Kroeger
Browse files

docs(README): Mentioned what the repo is about

parent b80a38f5
No related branches found
No related tags found
No related merge requests found
# Translating the Basisklassifikation
# Basisklassifikation WordPress plugin
This is a WordPress plugin that provides a taxonomy for the so-called
Basisklassifikation and an admin panel to upload JSKOS-files that contain
a current version of that classificatory scheme.
Note that processing a JSKOS file will likely take longer than PHP scripts are
permitted to run on your server. WordPress has not been made to create
thousands of taxonomy terms at once. You will need to adjust this limit before
uploading a JSKOS file.
## Translating the Basisklassifikation
This assumes that you are using Polylang and that the taxonomy has already
been translated.
......@@ -18,7 +30,7 @@ You will need access to a modern-ish Unix-like system with:
* [Pandoc](https://www.pandoc.org/) >= v3.0
## Terminology
### Terminology
Basisklassifikation classes have an organisational number (e.g., "08.00").
This number, in keeping with JSKOS terminology, is hereafter referred to as
......@@ -29,7 +41,7 @@ names, which are referred to as "labels". This plugin ignores alternative labels
every mention of a "label" always refers to "preferred" one.
## Get a JSKOS file
### Get a JSKOS file
The JSKOS format defines a JSON format (hence "JS") for knowledge
organisation systems (hence "KOS").
......@@ -52,7 +64,7 @@ that contains the German labels of the Basisklassifikation is named
jskos_de=01-bk-de.jskos
```
## Extract German labels
### Extract German labels
DeepL only accepts word processing documents as input, so we will
perform some conversions. The route we will take is:
......@@ -88,7 +100,7 @@ does *not* print anything, then no non-top-level class is missing;
otherwise, you have to add the missing classes manually.
## Convert to Office Open XML (aka ".docx")
### Convert to Office Open XML (aka ".docx")
The CSV file can be converted to an Office Open XML file using Pandoc
and a custom CSV reader "csv.lua", which ships with this plugin and is
......@@ -114,7 +126,7 @@ including top-level classes, provided that they are not missing from the CSV
file. Again, missing classes need to be added manually.
## Translate using DeepL
### Translate using DeepL
Upload "03-bk-de.docx" to <https://www.deepl.com/translator/files>,
make sure that the document's language is set to German, and let DeepL
......@@ -137,7 +149,7 @@ Yet again, we check whether any classes are missing from the translation:
Again, missing classes need to be added manually.
## Convert back to CSV
### Convert back to CSV
The Office Open XML file can be converted back to a CSV file using Pandoc
and a custom CSV writer "csv.lua" (the same script as before), which ships
......@@ -156,7 +168,7 @@ Check whether classes are missing:
diff "$csv_de_n" "$csv_trans_n"
```
## Correct translations errors
### Correct translations errors
This is the best time to fix the errors that DeepL made.
......@@ -180,7 +192,7 @@ You will want to look out for:
* Inconsistently translated abbreviations.
## Create a new ndJSON JSKOS file
### Create a new ndJSON JSKOS file
Create a new JSKOS file that contains the German as well as your
translated labels:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment