Improved documentation regarding customization
Change-Id: Ifa1aec91defaa335f2eb58dc3bd3ec48bb127de1
diff --git a/README.md b/README.md
index 479f12c..7e22507 100644
--- a/README.md
+++ b/README.md
@@ -88,16 +88,16 @@
(see [Kustvakt](https://github.com/KorAP/Kustvakt) for further information).
-### Configuration
+## Configuration
The basic configuration file is ```kalamar.conf```. To define derivations,
create a configuration file with the pattern ```kalamar.[MYNAME].conf``` and
follow the descriptions in ```kalamar.conf```.
For client-side configurations, a file ```kalamar.conf.js``` can be
introduced, that will be consulted during the build process, loading
-optional components using a ```require(...)``` directive.
+optional components using a ```require(...)``` directive (see example below).
-### Localization and Customization
+### Localization
To create a localized version of Kalamar, start the ```localize``` command
with the target locale as its argument, e.g. ```pl``` for polish.
@@ -109,7 +109,7 @@
The newly defined dictionary file can then be modified and added to the resources
definition of the ```Localize``` plugin in the configuration:
-```
+```perl
Localize => {
resources => ['kalamar.pl.dict']
}
@@ -118,7 +118,7 @@
To localize example queries according to a special corpus environment,
define a name of the example corpus in the configuration.
-```
+```perl
Kalamar => {
examplecorpus => 'mycorpus'
}
@@ -130,8 +130,6 @@
Templates can be localized and customized by overriding
the ```Template``` dictionary entries.
-This is especially useful for the landing page in
-```Template_intro```.
Currently the JavaScript translations are separated and stored in ```dev/js/src/loc```.
To generate assets relying on different locales, add the locale to ```Gruntfile.js```.
@@ -141,7 +139,7 @@
For example to support ```marmot``` and ```malt```,
the configuration may look like this:
-```
+```js
require([
"hint/foundries/marmot",
"hint/foundries/malt"
@@ -151,6 +149,17 @@
See ```dev/js/src/hint/foundries``` for
more optional foundries.
+### Customization
+
+The landing page can be customized by overriding the
+entry for ```Template_intro``` in the dictionary.
+
+Some sections of the user interface can be customized
+by adding new
+[content blocks](https://github.com/Akron/Mojolicious-Plugin-TagHelpers-ContentBlock).
+Currently the sections are in ```footer```, in the bottom line of the user interface,
+and ```loginInfo```, below the login form, if present.
+
## COPYRIGHT AND LICENSE
### Bundled Software
@@ -189,7 +198,7 @@
Corpus Analysis Platform at the
[Institute for the German Language (IDS)](http://ids-mannheim.de/),
member of the
-[Leibniz-Gemeinschaft](http://www.leibniz-gemeinschaft.de/en/about-us/leibniz-competition/projekte-2011/2011-funding-line-2/)
+[Leibniz Association](https://www.leibniz-gemeinschaft.de/en/home/)
and supported by the [KobRA](http://www.kobra.tu-dortmund.de) project,
funded by the
[Federal Ministry of Education and Research (BMBF)](http://www.bmbf.de/en/).