Skip to main content

Vorlagenvariablen

Jede Vorlage verfügt über vier Variablen: site für die veröffentlichte Website, page für die gerade erstellte Seite, theme für die Optionen und Texte Ihres Themes sowie paligo für den von Paligo hinzugefügten Markup-Code. Ein nicht festgelegter Wert wird nicht ausgegeben.

Website

Variable

Typ

Inhaltsverzeichnis

site.title

Text

Der Titel der Website des Layouts oder, falls dieser leer ist, der Titel der Publikation.

site.subtitle

Text oder null

Der Untertitel Sitedes Layouts.

site.logo

URL oder null

Das Logo des Layouts.

site.logoDark

URL oder null

Das Logo des Layouts für dunkle Hintergründe. Null bedeutet, dass überall site.logo verwendet wird.

site.logoLink

URL oder null

Die URL des Logo-Links im Layout. Der Wert Null bedeutet, dass das Logo mit der Startseite der Website verlinkt wird.

site.logoLinkNewTab

richtig oder falsch

Das Open-Logo des Layouts öffnet einen Link in einem neuen Tab. Dies ist nur relevant, wenn site.logoLink festgelegt ist.

site.favicon

URL oder null

Das Favicon des Layouts.

site.copyright

Text oder null

Die Copyright-Zeile in der Fußzeile, entweder aus dem Layout-Element Copyright in der Fußzeileoder aus Firmenname und Copyright-Jahr.

site.base_url

Text

Die Basis-URL des Layouts oder leer.

site.lang

Text

Der Sprachcode der Seite, z. B. en oder de-DE.

site.dir

rtl, ltr oder null

Die Textrichtung der Sprache der Publikation. Null, wenn nicht festgelegt; dies bedeutet von links nach rechts.

site.languages

Liste

Die Sprachen der Website. Siehe unten.

site.nav

Liste

Der Navigationsbaum. Siehe unten.

site.topNav

Objekt

Die Links für die obere Navigationsleiste. Siehe unten.

site.portal

Objekt oder null

Der Inhalt der Portalseite. Null, wenn die Website keine Portalseite hat. Siehe unten.

site.search

Objekt

Die Suchmaschine site.search.backend ist none, pagefind (Nexus Search), algolia oder coveo. Siehe In einem Thema suchen.

site.strings

Objekt

Texte, die Paligo in die Sprache der Seite übersetzt: searchPlaceholder, navPrev und navNext.

site.codeColors

Text

Die Code-Farben des Layouts: pygments für den Syntaxstil oder theme für die Themenfarben. Bei theme werden die Farben aus Ihrem Stylesheet zur Hervorhebung des Codes verwendet.

site.languages: ein Eintrag pro Sprache, mit:

  • code: der Sprachcode, z. B. de.

  • label: Der Name der Sprache in dieser Sprache, z. B. Deutsch.

  • default: true für die Standardsprache der Website.

site.nav: Die Seiten der Publikation als Baumstruktur für ein Navigationsmenü. Jeder Eintrag enthält:

  • title: Der Titel der Seite.

  • url: Der Link zur Seite. Fehlt, wenn der Eintrag keine eigene Seite hat.

  • children: die Einträge darunter, in derselben Form.

  • current: true, wenn die Seite gerade erstellt wird.

  • ancestor: true für jeden Eintrag oberhalb der aktuellen Seite.

{% macro tree(items) %}
    <ul>
    {% for item in items %}
        <li{% if item.current %} aria-current="page"{% endif %}>
            {% if item.url %}<a href="{{ item.url }}">{{ item.title }}</a>{% else %}{{ item.title }}{% endif %}
            {% if item.children %}{{ _self.tree(item.children) }}{% endif %}
        </li>
    {% endfor %}
    </ul>
{% endmacro %}

<nav class="sidebar">{{ _self.tree(site.nav) }}</nav>

site.topNav: zwei Listen, von denen jede leer sein kann:

  • items: Topics, deren section die Rolle top-nav-link hat. Jedes Element verfügt über einen title, eine url und children – eine Liste aus title und url für ein Dropdown-Menü.

  • links: Die Links der oberen Navigationsleiste des Layouts. Jeder Link verfügt über einen title und eine url.

Zeige eine obere Leiste nur dann an, wenn mindestens eine der Listen Einträge enthält.

site.portal: Der Inhalt der Portalseite:

  • heading: Die Portalüberschrift des Layouts oder eine übersetzte Standardüberschrift.

  • featured: die vorgestellten Topics, jeweils mit title, slug und url.

  • sections: the Topics, which can be browsed, each with a title, a slug, and url.

  • labels: Übersetzte Texte für das Portal: featuredContent, showMore und showLess.

  • startPage: Der Slug des Topics, bei dem mit dem Lesen begonnen werden soll, sofern vorhanden.

Seite

Variable

Typ

Inhaltsverzeichnis

page.title

Text

Der Seitentitel.

page.content

HTML

Der Inhalt der Seite. Drucke ihn mit {{ page.content }} aus.

page.type

Text

topic, portal oder search.

page.home

richtig oder falsch

true für die erste Seite der Publikation, wenn die Website keine Startseite hat.

page.slug

Text

Der Dateiname der Seite ohne die End ung .html.

page.url

Text

Der Dateiname der Seite, z. B. install.html.

page.toc

Liste

Die Überschriften auf der Seite bilden ein Inhaltsverzeichnis auf der Seite. Jede Überschrift verfügt über einen title, einen anchor und children.

page.breadcrumbs

Liste

Die Seiten oberhalb dieser Seite, beginnend ganz oben. Jede Seite hat einen title und einen slug.

page.prevPage, page.nextPage

Objekt oder null

Die vorherige und die nächste Seite, jeweils mit title, slug und url.

page.meta.description

Text

Eine Zusammenfassung der Seite im Klartext, maximal 160 Zeichen.

page.meta.canonical

URL

Die kanonische URL der Seite, sofern im Layout die Option Kanonische URL hinzufügen aktiviert ist.

page.taxonomies

Liste

Die Taxonomiewerte der Seite. Jeder Wert verfügt über eine group, einen value und – bei verschachtelten Taxonomien – eine hierarchy: eine Liste der Ebenen von oben nach unten.

page.search.weight

Text

boost oder reduce, wenn die Suchpriorität des Topics geändert wurde.

Auf dem Portal und den Suchseiten ist page.content leer und die Listen sind leer.

{% if page.prevPage or page.nextPage %}
<nav class="pager">
    {% if page.prevPage %}<a rel="prev" href="{{ page.prevPage.url }}">{{ site.strings.navPrev }}: {{ page.prevPage.title }}</a>{% endif %}
    {% if page.nextPage %}<a rel="next" href="{{ page.nextPage.url }}">{{ site.strings.navNext }}: {{ page.nextPage.title }}</a>{% endif %}
</nav>
{% endif %}

Thema

Variable

Inhaltsverzeichnis

theme.options

Der Wert der jeweiligen Designoption für das Layout. Siehe Referenz zu den Designoptionen.

theme.strings

Die themeneigenen Texte in der Sprache der Seite. Siehe Ein Theme übersetzen.

paligo

Variable

Inhaltsverzeichnis

paligo.head

Markup, das in jedem <head> jeder Seite enthalten sein muss. Siehe Designvorlagen.

paligo.foot

Dieser Code muss am Ende des <body>-Tags jeder Seite stehen. Siehe Designvorlagen.