|
|
In this Wiki you will find documentation and instructional material for Decker.
|
|
|
Decker software and this Wiki are under active development. Use our [feedback and bug tracker](https://gitlab2.informatik.uni-wuerzburg.de/decker/feedback) if you run into problems or want to share your ideas with us. Just open a new issue!
|
|
|
In this Wiki you will find documentation and instructional material for Decker. Decker software and this Wiki are under active development. Use our [feedback and bug tracker](https://gitlab2.informatik.uni-wuerzburg.de/decker/feedback) if you run into problems or want to share your ideas with us. Just open a new issue!
|
|
|
|
|
|
# Welcome to Decker
|
|
|
|
|
|
Decker is an e-authoring tool for the creation of web-based educational content.
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
|
# Setup
|
|
|
|
|
|
This section will lead you through downloading and installing decker on your system.
|
|
|
|
|
|
:warning:
|
|
|
|
|
|
This repository is currently in the process of migration to [github](https://github.com/decker-edu/decker). Stick to the build steps [there](https://github.com/decker-edu/decker) and search here for additional information regarding usage.\
|
|
|
There is no installer for the current latest build. If you want to use version 0.13.0 you need either to compile it from source or use a precompiled binary from [here](https://github.com/MatthiasPopp/decker/releases/tag/v0.13.0-RC4).
|
|
|
|
|
|
## Windows
|
|
|
|
|
|
Download: [Windows Installer](https://downloads.hci.informatik.uni-wuerzburg.de/decker-installer/Decker-nightly.msi)
|
... | ... | @@ -19,7 +23,6 @@ Download: [Windows Installer](https://downloads.hci.informatik.uni-wuerzburg.de/ |
|
|
- Find the file in your `Downloads` folder and install Decker by double clicking it and following the installer instructions.
|
|
|
- If you have installed Decker previously you might need to manually uninstall the previous version. The Windows installer does not yet support automatic reinstallation.
|
|
|
|
|
|
|
|
|
## MacOS
|
|
|
|
|
|
Download: [MacOS Installer](https://downloads.hci.informatik.uni-wuerzburg.de/decker-installer/Decker-nightly.pkg)
|
... | ... | @@ -27,7 +30,6 @@ Download: [MacOS Installer](https://downloads.hci.informatik.uni-wuerzburg.de/de |
|
|
- Click the link and download the MacOS package `Decker-nightly.pkg`.
|
|
|
- Find the file in your `Downloads` folder. Right-click to open the file and follow the installer instructions.
|
|
|
|
|
|
|
|
|
## Linux
|
|
|
|
|
|
A linux executable is available here: [decker-linux-nightly](https://downloads.hci.informatik.uni-wuerzburg.de/decker-installer/decker-linux-nightly)
|
... | ... | @@ -37,28 +39,29 @@ A linux executable is available here: [decker-linux-nightly](https://downloads.h |
|
|
- Move the executable to a directory that is on `$PATH` to be able to use `decker` anywhere.
|
|
|
|
|
|
# First Steps
|
|
|
|
|
|
After downloading the correct Decker version for your operating system from the [Setup](home#setup), follow this guide to learn the basics of Decker.
|
|
|
|
|
|
## Windows
|
|
|
|
|
|
- Use the Windows file explorer to navigate to a folder suitable for saving presentations. We suggest creating a new folder e.g. `C:\Users\<username>\Documents\presentations`.
|
|
|
- Open a *Console* by typing `powershell` in the address bar of the file explorer.
|
|
|
- Continue with subsection [*Opening a presentation*](Home#opening-a-presentation).
|
|
|
- Use the Windows file explorer to navigate to a folder suitable for saving presentations. We suggest creating a new folder e.g. `C:\\Users\\<username>\\Documents\\presentations`.
|
|
|
- Open a _Console_ by typing `powershell` in the address bar of the file explorer.
|
|
|
- Continue with subsection [_Opening a presentation_](Home#opening-a-presentation).
|
|
|
|
|
|
## MacOS
|
|
|
|
|
|
- Use Finder to navigate to a folder suitable for saving presentations. We suggest creating a new folder e.g. `/Users/<username>/Documents/presentations`.
|
|
|
- Open a *Console* by right clicking the folder symbol and choosing `Services > New Terminal at Folder`.
|
|
|
- Continue with subsection [*Opening a presentation*](Home#opening-a-presentation).
|
|
|
- Open a _Console_ by right clicking the folder symbol and choosing `Services > New Terminal at Folder`.
|
|
|
- Continue with subsection [_Opening a presentation_](Home#opening-a-presentation).
|
|
|
|
|
|
## Opening a presentation
|
|
|
|
|
|
- Type `decker example` in the *Console*. This will generate a new folder named `example`.
|
|
|
- Navigate to this new folder by typing `cd example` in the *Console*. If you close the *Console* the presentation might not be loaded correctly, therefore we recommend to only close the *Console* after concluding the presentation.
|
|
|
- Type `decker server` in the *Console*. This command will open a local web server.
|
|
|
- Type `decker example` in the _Console_. This will generate a new folder named `example`.
|
|
|
- Navigate to this new folder by typing `cd example` in the _Console_. If you close the _Console_ the presentation might not be loaded correctly, therefore we recommend to only close the _Console_ after concluding the presentation.
|
|
|
- Type `decker server` in the _Console_. This command will open a local web server.
|
|
|
- Open a web browser (we recommend Google Chrome). If you don't have another instance of this server running open, type [http://localhost:8888/](http://localhost:8888/) in the address bar.
|
|
|
- You should now see a Decker presentation designed to provide an overview of some of the features that Decker offers.
|
|
|
- To close the server created by Decker, either close the *Console* or terminate the process by using the keyboard shortcut.
|
|
|
- You should now see a Decker presentation designed to provide an overview of some of the features that Decker offers.
|
|
|
- To close the server created by Decker, either close the _Console_ or terminate the process by using the keyboard shortcut.
|
|
|
|
|
|
Many of our users simply use `decker example` and rename/modify the `example-deck` to create their own presentation.
|
|
|
|
... | ... | @@ -84,6 +87,7 @@ dolor sit |
|
|
|
|
|
amet
|
|
|
```
|
|
|
|
|
|
- Save the file and take a look at your browser window. On the `Generated Index` page under `Slide decks` there should be a new presentation called `minimal-deck.html`
|
|
|
- The presentation running in your browser window will update itself with any changes made to the `-deck.md` file after saving it.
|
|
|
|
... | ... | @@ -91,8 +95,8 @@ amet |
|
|
|
|
|
In the simplest case, a new Decker presentation consists of the following files:
|
|
|
|
|
|
- `decker.yaml`: A file containing configuration option. If you have never used Decker before you should copy the one that is located in the `example` folder generated by Decker.
|
|
|
- At least one file called `*-deck.md`. This is a text file in the popular `Markdown` format.
|
|
|
- `decker.yaml`: A file containing configuration option. If you have never used Decker before you should copy the one that is located in the `example` folder generated by Decker.
|
|
|
- At least one file called `\*-deck.md`. This is a text file in the popular `Markdown` format.
|
|
|
|
|
|
After running e.g. `decker server`, Decker will have generated additional files and folders:
|
|
|
|
... | ... | @@ -103,25 +107,24 @@ After running e.g. `decker server`, Decker will have generated additional files |
|
|
|
|
|
Paths to local file resources that are referenced by slide sets need to be provided in several contexts. For example:
|
|
|
|
|
|
- as a URL in an image tag to locate local media files like images or videos (learn more about including media files on the page [Media](Media))
|
|
|
|
|
|
``` {.markdown}
|
|
|
## A very important image
|
|
|
![](image.png)
|
|
|
```
|
|
|
- as a URL in an image tag to locate local media files like images or videos (learn more about including media files on the page [Media](Media))
|
|
|
|
|
|
- as the value of meta data variables, for example to provide the location of the bibliography database and the citation style definition
|
|
|
```{.markdown}
|
|
|
## A very important image
|
|
|
![](image.png)
|
|
|
```
|
|
|
- as the value of meta data variables, for example to provide the location of the bibliography database and the citation style definition
|
|
|
|
|
|
``` {.yaml}
|
|
|
bibliography: /bib/bibliography.tex
|
|
|
csl: /bib/chicago-author-data.csl
|
|
|
```
|
|
|
```{.yaml}
|
|
|
bibliography: /bib/bibliography.tex
|
|
|
csl: /bib/chicago-author-data.csl
|
|
|
```
|
|
|
|
|
|
In any case, path values for local file resources are interpreted either as relative to the defining file, if specified as a *relative path*, or as relative to the project root directory, if specified as an *absolute path*.
|
|
|
In any case, path values for local file resources are interpreted either as relative to the defining file, if specified as a _relative path_, or as relative to the project root directory, if specified as an _absolute path_.
|
|
|
|
|
|
Consider the following project layout and file contents:
|
|
|
|
|
|
``` {.txt}
|
|
|
```{.txt}
|
|
|
project
|
|
|
├── images
|
|
|
│ └── image.png
|
... | ... | @@ -131,7 +134,7 @@ project |
|
|
|
|
|
`slides/slide-deck.md` contains:
|
|
|
|
|
|
``` {.markdown}
|
|
|
```{.markdown}
|
|
|
# First slide
|
|
|
|
|
|
![Project relative path](/images/image.png)
|
... | ... | |