|
|
The audience of a deck can annotate slides with questions. The questions are aggregated on a server and are visible by all audience members and the author.
|
|
|
|
|
|
The slide author can later choose to address the questions by changeing or extending the information in the deck.
|
|
|
|
|
|
To enable this feature a deck must specify the URL of a Decker Engine server in the meta data by setting the variable `decker-engine.base-url`. For example:
|
|
|
|
|
|
```
|
|
|
decker-engine:
|
|
|
base-url: 'https://tramberend.beuth-hochschule.de/decker'
|
|
|
```
|
|
|
|
|
|
### Endpoints with authorization
|
|
|
|
|
|
There are two modes of operation depending on the deployment details of the server, *authorized* and *public*.
|
|
|
|
|
|
If the server is running behind a proxy with Basic Authentication enabled, questions can only be added if the user has been authenticated by the proxy. Administrators are recognized automatically, no further authorization is necessary.
|
|
|
|
|
|
The `de-api` endpoint works that way:
|
|
|
|
|
|
```
|
|
|
decker-engine:
|
|
|
base-url: 'https://tramberend.beuth-hochschule.de/de-api'
|
|
|
```
|
|
|
|
|
|
### Public endpoints
|
|
|
|
|
|
If the server is publicly available without authentication, the user is assigned a token that allows her to later delete or edit all questions that where added using that token. The token can be entered by hand or stored in the browser's local storage. Administrators need to authenticate with a username and a password.
|
|
|
|
|
|
The `decker` endpoint works that way:
|
|
|
|
|
|
```
|
|
|
decker-engine:
|
|
|
base-url: 'https://tramberend.beuth-hochschule.de/decker'
|
|
|
```
|
|
|
|
|
|
### Admistrators
|
|
|
|
|
|
Users that are authorized as administrators can edit and delete all questions in a set.
|
|
|
|
|
|
### Deck Identification
|
|
|
|
|
|
Decks are identified by their public URL. This can be problematic if a deck is served locally, for example from `http://localhost:8888/test/decks/engine-deck.html` during video recording, but is supposed to show the questions on the published version. For this situation the public URL of a deck can be set in the meta data.
|
|
|
|
|
|
```
|
|
|
decker-engine:
|
|
|
deck-id: 'https://tramberend.beuth-hochschule.de/public/decker/test/decks/engine-deck.html'
|
|
|
```
|
|
|
|
|
|
If `decker-engine.deck-id` is specified, it overrides the actual deck URL as far as deck identification for decker engine is concerned. The questions shown if the deck is served locally will be the questions that where added to the published deck. |
|
|
\ No newline at end of file |