Skip to content

GitLab

Commit 211bfde8 authored by schneider210's avatar schneider210
Browse files

Merge branch 'issue/make-language-switch-configurable' into 'develop' 

feat: implement config option for the language switch

See merge request !215
parents 8dbca9cb c12f5816
Pipeline #223843 passed with stages
in 4 minutes and 58 seconds
Hide whitespace changes
Inline Side-by-side
README.md
View file @ 211bfde8
......@@ -200,100 +200,101 @@ As a rule of thumb, each key with a boolean value (e.g. *true* or *false*) defau
<script id="tido-config" type="application/json">
{
"entrypoint": "https://subugoe.pages.gwdg.de/emo/backend/sampledata/collection.json",
"annotations": {
"types": [
"annotations": {
"show": true,
"types": [
{
"contenttype": "Person",
"icon": "fasUser",
"label": "Names"
},
{
"contenttype": "Place",
"icon": "fasMapMarkerAlt",
"label": "Places"
},
{
"contenttype": "Editorial Comment",
"icon": "fasComment",
"label": "Comments"
},
{
"contenttype": "Motif",
"icon": "fasHighlighter",
"label": "Motifs"
}
],
"tabs":{
"Editorial": ["Person", "Place", "Editorial Comment"],
"Motif": ["Motif"]
}
},
"breadcrumbNavigation": {
"show": true,
"title_homepage_key": "title_homepage",
"title_viewer_key": "title_viewer",
"website": "https://ahikar.sub.uni-goettingen.de/website/"
},
"colors": {
"primary": "",
"secondary": "",
"accent": ""
},
"header_section": {
"show": true,
"navigation": true,
"panelheadings": true,
"titles": true,
"toggle": true
},
"labels": {
"item": "Sheet",
"manifest": "Manuscript"
},
"lang": "de-de",
"language-switch": true,
"meta": {
"collection": {
"all": true
},
"manifest": {
"all": true
},
"item": {
"all": true
}
},
"notificationColors": {
"info":"blue-9",
"warning":"red-9"
},
"panels": [
{
"contenttype": "Person",
"icon": "fasUser",
"label": "Names"
"connector": [1, 2],
"panel_label": "contentsMetadata",
"show": true,
"toggle": true
},
{
"contenttype": "Place",
"icon": "fasMapMarkerAlt",
"label": "Places"
"connector": [3],
"panel_label": "Image",
"show": true,
"toggle": true
},
{
"contenttype": "Editorial Comment",
"icon": "fasComment",
"label": "Comments"
"connector": [4],
"panel_label": "Text",
"show": true,
"toggle": true
},
{
"contenttype": "Motif",
"icon": "fasHighlighter",
"label": "Motifs"
"connector": [5],
"panel_label": "Annotations",
"show": true,
"toggle": true
}
],
"tabs": {
"Editorial": ["Person", "Place", "Editorial Comment"],
"Motif": ["Motif"]
}
},
"colors": {
"primary": "",
"secondary": "",
"accent": ""
},
"header_section": {
"show": true,
"navigation": true,
"panelheadings": true,
"titles": true,
"toggle": true
},
"labels": {
"item": "Sheet",
"manifest": "Manuscript"
},
"meta": {
"collection": {
"all": true
},
"manifest": {
"all": true
},
"item": {
"all": true
}
},
"notificationColors": {
"info":"blue-9",
"warning":"red-9"
},
"panels": [
{
"connector": [1, 2],
"panel_label": "Contents & Meta",
"show": true,
"toggle": true
},
{
"connector": [3],
"panel_label": "Image",
"show": true,
"toggle": true
},
{
"connector": [4],
"panel_label": "Text",
"show": true,
"toggle": true
},
{
"connector": [5],
"panel_label": "Annotations",
"show": true,
"toggle": true
}
],
"rtl": false,
"lang": "en-us",
"standalone": true,
"breadcrumbNavigation": {
"show": true,
"title_homepage_key": "title_homepage",
"title_viewer_key": "title_viewer",
"website": "https://ahikar.sub.uni-goettingen.de"
}
"rtl": false
} </script>
```
......@@ -347,6 +348,34 @@ As a rule of thumb, each key with a boolean value (e.g. *true* or *false*) defau
**Note**: The strings contained within the group label keys (e.g. *Person*, *Place*, ...) have to match its API-counterpart explicitely. Please refer to the note above (content-type).
- **breadcrumbNavigation**
- **show**
defines if a project header should be shown or not.
Defaults to `false`
- **title_homepage_key**
defines the string shown as first item in the breadcrumb. Shows a "Home Icon"
Note: To change this title please navigate to "tido/src/i18n/en or tido/src/i18n/de" and find "title_homepage".
Has to be set!
- **title_viewer_key**
defines the string shown as last item in the breadcrumb. Shows a "Document Icon"
Note: To change this title please navigate to "tido/src/i18n/en or tido/src/i18n/de" and find "title_viewer".
Has to be set!
- **website**
Navigates to the Home Page page on website.
- **colors**
set the colors used in the frontend.
......@@ -403,26 +432,6 @@ As a rule of thumb, each key with a boolean value (e.g. *true* or *false*) defau
Defaults to `Manuscript`
- **notificationColors**
sets the colors used in frontend to apply for icons in notification messages.
`info` and `warning` are set to `blue-9` `red-9` respectively which can be changed according to the project requirements.
There is a re-usable component called notification.vue (src/components/notification.vue) which receives the type of notification (ex: `info` or `warning`). Based on the type we send, this component searches for it and its respective icon which in turn gets displayed before the title message of Notifications.
If we do not send any type, than there is no `icon` set to the notification message.
**Note**: Can add additional types ex: `success`, `error`, `positive`, `negative`. Based on these we need to add them at the component level as well and their icons respectively.
- **rtl (right to left)**
refers to the direction the text inside the text panel will be displayed.
set the value to `true` if you want text to be displayed from right to left; e.g. Arabic.
Defaults to `false`
- **lang (language)**
refers to the default language of the application.
......@@ -431,39 +440,31 @@ As a rule of thumb, each key with a boolean value (e.g. *true* or *false*) defau
Defaults to `en-us`
- **standalone**
- **language-switch**
denotes if the Viewer will be used as a single page application 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.
set this value to `false` if you don't want to switch the language. this setting hides the appropriate toggle.
Defaults to `true`
- **breadcrumbNavigation**
- **show**
defines if a project header should be shown or not.
Defaults to `false`
- **title_homepage_key**
- **notificationColors**
defines the string shown as first item in the breadcrumb. Shows a "Home Icon"
sets the colors used in frontend to apply for icons in notification messages.
Note: To change this title please navigate to "tido/src/i18n/en or tido/src/i18n/de" and find "title_homepage".
`info` and `warning` are set to `blue-9` `red-9` respectively which can be changed according to the project requirements.
Has to be set!
There is a re-usable component called notification.vue (src/components/notification.vue) which receives the type of notification (ex: `info` or `warning`). Based on the type we send, this component searches for it and its respective icon which in turn gets displayed before the title message of Notifications.
- **title_viewer_key**
If we do not send any type, than there is no `icon` set to the notification message.
defines the string shown as last item in the breadcrumb. Shows a "Document Icon"
**Note**: Can add additional types ex: `success`, `error`, `positive`, `negative`. Based on these we need to add them at the component level as well and their icons respectively.
Note: To change this title please navigate to "tido/src/i18n/en or tido/src/i18n/de" and find "title_viewer".
- **rtl (right to left)**
Has to be set!
refers to the direction the text inside the text panel will be displayed.
- **website**
set the value to `true` if you want text to be displayed from right to left; e.g. Arabic.
Navigates to the Home Page page on website.
Defaults to `false`
### Configure the Panels
......
src/App.vue
View file @ 211bfde8
......@@ -15,7 +15,6 @@
:manifests="manifests"
:panels="panels"
:projectcolors="config.colors"
:standalone="config.standalone"
/>
<q-page-container class="root">
......
src/components/footer.vue deleted 100644 → 0
View file @ 8dbca9cb
<template>
<q-toolbar
:class="$q.dark.isActive ? 'bg-dark' : 'bg-secondary text-primary'"
>
<div class="footer__wrap">
<div
bordered
class="row justify-center items-center"
reveal
>
<Language v-if="standalone" />
<Color :projectcolors="projectcolors" />
<Softwareinfo />
</div>
</div>
</q-toolbar>
</template>
<script>
import Color from '@/components/color.vue';
import Language from '@/components/language.vue';
import Softwareinfo from '@/components/softwareinfo.vue';
export default {
name: 'Footer',
components: {
Color,
Language,
Softwareinfo,
},
props: {
projectcolors: {
type: Object,
default: () => {},
},
standalone: Boolean,
},
};
</script>
<style lang="scss" scoped>
.footer__wrap {
margin: 0 auto;
max-width: 1200px;
}
</style>
src/components/header.vue
View file @ 211bfde8
......@@ -23,7 +23,6 @@
<Tools
:config="config"
:projectcolors="projectcolors"
:standalone="standalone"
/>
</q-toolbar>
......@@ -50,7 +49,6 @@
<Tools
:config="config"
:projectcolors="projectcolors"
:standalone="standalone"
/>
</div>
</q-toolbar>
......@@ -112,7 +110,6 @@ export default {
type: Object,
default: () => {},
},
standalone: Boolean,
},
};
</script>
......
src/components/tools.vue
View file @ 211bfde8
<template>
<div class="row no-wrap justify-end col-xs-3">
<Language
v-if="standalone"
v-if="config['language-switch']"
:config="config"
/>
......@@ -32,7 +32,6 @@ export default {
type: Object,
default: () => {},
},
standalone: Boolean,
},
};
</script>
src/index.template.html
View file @ 211bfde8
......@@ -31,7 +31,7 @@
-->
<script id="tido-config" type="application/json">
{
"entrypoint": "",
"entrypoint": "https://ahikar-dev.sub.uni-goettingen.de/api/textapi/ahikar/arabic-karshuni/collection.json",
"annotations": {
"show": true,
"types": [
......@@ -61,6 +61,12 @@
"Motif": ["Motif"]
}
},
"breadcrumbNavigation": {
"show": true,
"title_homepage_key": "title_homepage",
"title_viewer_key": "title_viewer",
"website": "https://ahikar.sub.uni-goettingen.de/website/"
},
"colors": {
"primary": "",
"secondary": "",
......@@ -77,6 +83,8 @@
"item": "Sheet",
"manifest": "Manuscript"
},
"lang": "en-us",
"language-switch": true,
"meta": {
"collection": {
"all": true
......@@ -118,15 +126,7 @@
"toggle": true
}
],
"rtl": false,
"lang": "en-us",
"standalone": true,
"breadcrumbNavigation": {
"show": true,
"title_homepage_key": "title_homepage",
"title_viewer_key": "title_viewer",
"website": "https://ahikar.sub.uni-goettingen.de/website/"
}
"rtl": false
}
</script>
......
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