Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
310 changes: 288 additions & 22 deletions settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,296 @@ tbd
## Data Ressources
tbd


## Static Content
tbd

### 1. `Global Settings`
Type: *json*

Attribute:

- Bildrechte / Copyright anzeigen <br>
Code: "showImageRights": boolean -> true / false <br>
Erklärung: In den Bildern wird ein "Copyright" des Rechteinhabers angezeigt <br>
Beispiel:
![Logo](/smart-village-app-admin-doku/images/imagerights.jpg)

- Filter <br>
Code: <br>
{ <br>
"filter": { <br>
"news": false, <br>
"events": true, <br>
"eventLocations": true <br>
}, <br>
Erklärung: <br>
Beispiel: <br>



### ⚙️ App-Konfiguration: `globalSettings`

Type: *json* <br><br>
Diese Datei beschreibt die zentralen globalen Einstellungen der Smart-Village-App. Die Konfigurationswerte beeinflussen das Verhalten und die Darstellung von Inhalten innerhalb der App.

---

#### 📁 filter

Steuert, welche Inhaltsarten im Filterbereich der App angezeigt oder deaktiviert sind.

```json
"filter": {
"news": false,
"events": true,
"eventLocations": true
}
```

- `news`: Wenn `true`, können Nachrichten gefiltert werden.
- `events`: Wenn `true`, können Veranstaltungen gefiltert werden.
- `eventLocations`: Wenn `true`, können Veranstaltungsorte im Filter genutzt werden.

> Beispielhafte Darstellung:
> ![Platzhalter-Bild](filter-placeholder.png)

---

#### 🖼️ showImageRights

Zeigt oder versteckt die Angabe der Bildrechte bei Bildern in der App.

```json
"showImageRights": true
```

- `true`: Urhebervermerk bei Bildern wird angezeigt.
- `false`: Urhebervermerk wird unterdrückt.

> Beispiel: Bild mit eingeblendeten Bildrechten
> ![Logo](/smart-village-app-admin-doku/images/imagerights.jpg)

---

#### 📚 sections

Definiert, welche Sektionen in der App erscheinen und wie sie betitelt werden.

##### 🔹 Sichtbarkeit

```json
"showNews": true,
"showPointsOfInterestAndTours": false,
"showEvents": true
```

- Zeigt oder verbirgt komplette Bereiche der App (z. B. News, POIs, Events).

#### 🔹 Headlines und Buttons

Diese Texte erscheinen als Überschrift oder Aktionsbutton in der App:

```json
"headlineNews": "Nachrichten",
"buttonNews": "Alle Nachrichten anzeigen",
"headlineEvents": "Veranstaltungen",
"buttonEvents": "Alle Veranstaltungen anzeigen",
...
```

#### 🔹 Kategoriezuweisung (Beispiel für News)

```json
"categoriesNews": [
{
"categoryId": 854,
"categoryTitle": "Nachrichten",
"categoryTitleDetail": "Nachricht",
"categoryButton": "Alle Nachrichten anzeigen"
}
]
```

> Beispielhafte App-Darstellung mit angepasster Buttonbeschriftung:
> ![Platzhalter-Bild](sections-placeholder.png)

---

### 📆 eventListIntro

Ein Einführungstext oberhalb der Veranstaltungsübersicht inkl. Aktionsbutton.

```json
"eventListIntro": {
"buttonType": "top",
"introText": "Es fehlt eine Veranstaltung im Kalender? Auf den Button klicken und über das jeweilige Formular melden!",
"buttonTitle": "Veranstaltung hinzufügen",
"url": "https://www.smarte-region-linz.de/veranstaltungen-ort"
}
```

- `introText`: Text zur Erklärung der Funktion
- `buttonTitle`: Beschriftung des Buttons
- `url`: Zieladresse beim Klick auf den Button

> Vorschau mit Einleitungstext und Button:
> ![Platzhalter-Bild](event-intro-placeholder.png)

---

### ⚙️ settings

#### ▶️ Slider

```json
"sliderPauseButton": {
"show": true,
"size": 15,
"horizontalPosition": "right",
"verticalPosition": "bottom"
},
"sliderSettings": {
"autoplayInterval": 8000
}
```

- "sliderPauseButton": Aktiviert einen Pause-Button im Bildslider;
- "size", "horizontalPosition", "verticalPosition" bestimmt die Größe und Position des Button im Bild
- `autoplayInterval`: Dauer in Millisekunden zwischen Slides

#### 🔄 Personalisierte Kacheln & Ansichten

```json
"personalizedTiles": true,
"switchBetweenListAndMap": "bottom-floating-button"
```

- `personalizedTiles`: Kacheln werden individuell angepasst
- `switchBetweenListAndMap`: Umschaltmöglichkeit zwischen Listen- und Kartenansicht

#### 📲 Push-Mitteilungen

```json
"pushNotifications": true
```

- Aktiviert die Nutzung von Push-Nachrichten

#### 🗓️ Event-Kalender

```json
"eventCalendar": {
"dotCount": 1,
"subList": true
}
```

- `dotCount`: Anzahl an Punkten pro Tag in der Kalenderansicht
- `subList`: Wenn `true`, wird eine Unterliste mit Events angezeigt

#### 📅 Kalenderumschaltung

```json
"calendarToggle": true
```

- Zeigt einen Schalter zum Wechsel zwischen verschiedenen Kalenderansichten

> Beispielhafte Slider- und Kalenderdarstellung:
> ![Platzhalter-Bild](slider-calendar-placeholder.png)

---

### 📈 Matomo (Tracking)

```json
"matomo": {
"urlBase": "https://matomo.common.smart-village.app",
"siteId": 11
}
```

- Konfiguration für datenschutzkonformes Besuchertracking via Matomo

---

### 📍 locationService

```json
"locationService": {
"defaultAlternativePosition": {
"lat": 50.569494,
"lng": 7.285771
}
}
```

- Fallback-Koordinaten, falls der Nutzer keinen Standort freigibt

---

### 🧰 Bürger- und Unternehmensservices

```json
"busBb": {
"uri": "https://v2.rlp-bus.smart-village.app/graphql",
"v2": {
"areaId": 40842
},
"initialFilter": [
"search",
"aToZ"
],
"isMultiCity": true
}
```

- Einbindung der Verwaltungsleistungen des Bürger- und Unternehmensservices des jeweiligen Landes (hier am Beispiel des BUS-RLP)

---

### 🚀 onboarding

```json
"onboarding": true
```

- Wenn `true`, wird die App-Einführung für neue Nutzende aktiviert bzw. Nutzende können die App-Einführung individuell in den Einstellungen erneut aktivieren

---

### 🗑️ wasteAddresses

```json
"wasteAddresses": {
"isInputAutoFocus": true,
"twoStep": true
}
```

- Steuerung der Adresssuche für Müllkalender

> Beispieldarstellung der Müllkalender-Suche:
> ![Platzhalter-Bild](waste-placeholder.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


⚡ Disturber

  "disturber": {
      "show": true,
      "content": "disturber"
    }
  • Aktivierung des "Störer"-Moduls
  • Erfordert Json-Datei "homeDisturber"

---

### 🧩 widgets

Steuern die Anzeige von Mini-Modulen auf der Startseite.

```json
"widgets": [
"weather",
{
"widgetName": "event",
"text": "Events"
},
{
"widgetName": "custom",
"text": "Orte",
"additionalProps": {
"iconName": "location",
"accessibilityLabel": "Orte",
"routeName": "TilesScreen",
"params": {
"title": "Stadt und Ortsgemeinden",
"staticJsonName": "stadt-ortsgemeinden",
"rootRouteName": "Stadt und Ortsgemeinden"
}
}
}
]
```

> Darstellung eines Event-Widgets:
> ![Platzhalter-Bild](widget-placeholder.png)

---

### 📝 Hinweis

Alle Werte können über das Admin-Backend angepasst und bei Bedarf versioniert werden.
Stimmen Sie sich vor größeren Änderungen mit dem technischen Team ab.


### 2. `Home Carousel`
Expand Down