Commit 7af30c60 authored by schneider210's avatar schneider210
Browse files

Update README.md

parent b23d7b9a
Pipeline #139770 passed with stages
in 2 minutes and 50 seconds
......@@ -90,7 +90,22 @@ Locate the `index.template.html` file inside the root of your project dir and fi
*Please note:* it's a json object. So if you are going to make changes and you have to quote these, use double quotes, not single ones.
![config](./config.png "configure the Viewer")
```html
<script id="emo-config" type="application/json">
{
"entrypoint": "https://ahikar-test.sub.uni-goettingen.de/api/textapi/ahikar/3r9ps/collection.json",
"itemlabel": "Page",
"manifestlabel": "Manuscript",
"standalone": true,
"panels": {
"image": true,
"text": true,
"metadata": false,
"treeview": false
}
}
</script>
```
### The keys in detail
......@@ -112,7 +127,7 @@ This change affects the captions of the navigational tools, e.g. the navbuttons
- **standalone:**
- denotes if the Viewer will be used as a single page application on its own or if it will be embedded into an existing page. If you want to use it in the latter case, please toggle the value to "false". That way the language toggle in the footer section will not show up.
Defaults to "**true**" (Note: do not quote this value as it is a boolean)
Defaults to "**true**" (Note: do not quote this value since it is a boolean)
- **panels:**
- it's a nested object. Its keys correspond to the panelnames, e.g. "treeview", "text", "image", "metadata".
......@@ -120,15 +135,6 @@ This change affects the captions of the navigational tools, e.g. the navbuttons
Defaults to **true** for every panel
```json
{
"treeview": true,
"text": true,
"image": true,
"metadata": true
}
```
## Dockerfile
The dockerfile is used at GitLab CI.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment