Decker Anleitung

Folienerstellung - Titelseite

Sebastian Lukas Hauer

Lehrstuhl für Computergraphik, TU Dortmund

🚀 by Decker

Konfiguration der Titelseite

Die Titelseite wird von decker vollkommen automatisch aus Konfigurationsparametern erstellt.

Die Parameter können sowohl Projektweit (um einen Standardwert für alle Dokumente zu definieren) als auch pro Quelldatei (-deck.md bzw. -page.md) im Frontmatter angegeben werden.

---
title: Titel der Präsentation
subtitle: Untertitel der Präsentation
author: Max Mustermann
affiliation: Institut für Mustererkennung
---
Frontmatter-Beispiel im Kopf einer Markdown-Quelldatei

Konfigurationseinstellungen

Im Standard und TU Dortmund Ressourcenpaket haben Titelseiten folgende Eigenschaften:

  • Titel: Der Titel der Präsentation / Vorlesung
  • Nebentitel: Ein Nebentitel für die Präsentation
  • Autor: Informationen über den Autoren des Dokuments
  • Autoren: Optional, wenn mehrere Autoren an dem Dokument gearbeitet haben
  • Zuordnung: Die Zuordnung der Präsentation
  • Copyright: Informationen über das anzuwendende Urheberrecht

Titel und Nebentitel konfigurieren

title: 'Titel'
subtitle: 'Nebentitel'

Ihre Präsentationen müssen einen Wert für title angeben. Ist dieser nicht konfiguriert ist der Standardwert <undefined>.

Ein Nebentitel mit subtitle muss nicht angegeben werden. Für größere Projekte bietet es sich jedoch an, Nebentitel für unterschiedliche Präsentationen zu verwenden.

Autor*in konfigurieren

Die primäre Autor*in können Sie mit der Konfigurationsoption author spezifizieren.

author: 'Name'

Eine Autor*in kann sowohl als einfacher Name angegeben werden, als auch als komplexeres Objekt:

author:
  name: 'Name'
  url: 'https://example.org'
  affiliation: <Zugehörigkeit>

In der komplexen Variante können Sie Name, Link zur Webseite der Autor*in und Zugehörigkeit der Person spezifizieren. Alle Angaben außer dem Namen sind hierbei optional.

Wie Zugehörigkeiten spezifiziert werden können finden Sie hier.

Mehrere Autor*innen konfigurieren

Wenn Sie mehrere Autor*innen angeben möchten sollten Sie die Konfiguration authors anstatt author verwenden. Sie können mehrere Autor*innen in einer Liste angeben:

authors:
  - 'Name'
  - 'Name'
  - 'Name'

Auch diese Angaben können “einfach” als Name angegeben werden, oder jeweils als komplexes Objekt mit zusätzlichen Informationen. Achten Sie bei Angabe von Zusatzinformationen auf die passende Einrückung der Attribute:

authors:
  - name: 'Name'
    url: 'Link'
    affiliation: <Zugehörigkeit>
  - 'Name'
  - name: 'Name'
    url: 'Link'
    affiliation: <Zugehörigkeit> 

Zugehörigkeiten konfigurieren

Die Zugehörigkeit der Präsentation können Sie mit der Konfiguration affiliation spezifizieren:

affiliation: 'Institut'

Auch Zugehörigkeiten können mit Zusatzinformationen versehen werden, indem sie als Objekt beschrieben werden:

affiliation:
  name: 'Institut'
  url: 'Link'
  logo: <Bild>

Zuordnungslogos konfigurieren

Logos von Zuordnungen können mit einem Dateipfad zum entsprechenden Bild konfiguriert werden:

affiliation:
  name: 'Institut'
  logo: '/pfad/zur/datei.png'

Sie können zusätzlich das Bild als Objekt spezifizieren, um Breite und Höhe des Bildes zu spezifizieren.

affiliation:
  logo:
    uri: '/pfad/zur/datei.png'
    width: '128px'
    height: '128px'

Hinweis: Wenn Sie Logos als .svg vorliegen haben, so kann es sein dass diese Bilder keine Größeninformationen über sich selbst besitzen. In diesem Falle sind die automatisch ermittelten Größen des Bildes \(0 \times 0\) Pixel. Sie müssen also die gewünschte Größe manuell angeben.

Primärlogos konfigurieren

Die Logos von Institutionen, die Sie auf der Titelseite unabhängig zu Autor*innen anzeigen lassen wollen können Sie mit der Konfiguration logos spezifizieren.

logos:
  - '/pfad/zur/datei1.png'
  - '/pfad/zur/datei2.jpg'
  - '/pfad/zur/datei3.svg'

Sie können jedes Logo nach Bedarf als Objekt angeben, um die Größen zu spezifieren.

logos:
  - uri: '/pfad/zur/datei1.png'
    width: '128px'
    height: '128px'
  - '/pfad/zur/datei2.jpg'
  - uri: '/pfad/zur/datei3.svg'
    width: '128px'
    height: '128px'

Im Ressourcenpaket der TU Dortmund können Sie das TU Logo mit folgender Konfiguration verstecken:

includeTULogo: false

Urheberrechtsangaben einstellen

Sie können auf der Titelseite noch zusätzlich einen Hinweis zum Urheberrecht hinzufügen:

copyright: 'CC BY-SA 4.0'

Auch diese Angabe hat eine komplexe Objektvariante, der Sie einen Link zum Verwendungsvertrag hinzufügen können:

copyright:
  type: 'CC BY-SA 4.0'
  url: 'https://creativecommons.org/licenses/by-sa/4.0/'

Teaserbild

Der Titelseite kann noch ein Bild als Teaser für den Inhalt der Präsentation hinzugefügt werden:

teaser: '/pfad/zum/bild.svg'

Auch dieses Bild kann wie Logos als Objekt mit Größenangaben spezifiziert werden.

Wasserzeichen angeben

Zuletzt können Sie auch noch nach Bedarf der Präsentation ein Wasserzeichen hinzufügen:

watermark: 'Wasserzeichen'

Dies Wasserzeichen ist auf jeder Folie als transparentes Element sichtbar (auch auf der Titelseite).

Sie können als Inhalt des Wasserzeichens auch HTML-Code verwenden, um z.B. ein Bild als Wasserzeichen zu verwenden:

watermark: '<img src="./pfad/zum/bild.png" />'

Maximal konfiguriertes Beispiel

authors:
  - 'Max Mustermann'
  - name: 'Maria Musterfrau'
    url: 'https://musterfrau.de'
    affiliation:
      name: 'Institut für Muster'
      url: 'https://muster.de'
      logo:
        uri: '/images/muster.png'
        width: '128px'
        height: '128px'
copyright:
  type: 'CC BY-SA 4.0'
  url: 'https://creativecommons.org/licenses/by-sa/4.0/'
teaser:
  uri: '/images/teaser.png'
  width: '128px'
  height: '128px'
watermark: 'Beispielfoliensatz'
logos:
  - '/images/university.png'
  - uri: '/images/institute.svg'
    width: '128px'
    height: '128px'

Pseudogrammatik für die Titelseitenkonfiguration

title: string
subtitle: string
author: Author
authors: [Author]
affiliation: Affiliation
copyright: Copyright
teaser: Image
watermark: string
logos: [Image]

type Author: string | {
  name: string
  url?: string
  affiliation?: Affiliation
}

type Affiliation: string | {
  name: string
  url?: string
  logo?: Image
}

type Copyright: string | {
  type: string
  url?: string
}

type Image: string | {
  uri: string
  width?: css-size
  height?: css-size
}