Vorschau beim Teilen — technische Referenz
Diese Seite beschreibt Auszeichnung, Herkunft der Werte, Ausgabe, Verwaltungsfläche und Erweiterungspunkt. Für den Einstieg siehe Überblick.
Der Block einer Seite
Die Syntaxkomponente erkennt zwei gleichwertige Schreibweisen desselben Blocks; beide wertet derselbe Leser aus. Der Block erzeugt keine sichtbare Ausgabe — er wird beim Aufbau der Seitenmetadaten gelesen und wirkt ausschließlich im Seitenkopf.
<og> title = ... description = ... image = :wiki:logo.png type = article </og>
%%{{wk:og>title=...|description=...|image=:wiki:logo.png}}%%
wkcore und trennt ihre Paare mit | statt mit Zeilenumbrüchen. Sie wird nur registriert, wenn wkcore installiert ist; fehlt es, bleibt die erste Form allein gültig.
Erkannte Schlüssel
| Schlüssel | Wird zu | Vorgabe, wenn die Seite nichts sagt |
|---|---|---|
title | og:title, twitter:title | Seitentitel, wie ihn DokuWiki bestimmt |
description | og:description, twitter:description | Kette aus Seitenauszug, Vorgabetext und Tagline |
image | og:image, twitter:image | Einstellung defaultImage |
url | og:url | absolute Adresse der Seite |
type | og:type | Einstellung defaultType |
site_name | og:site_name | Einstellung siteName, sonst Wiki-Titel |
Für type gilt eine Besonderheit: die Auszeichnung nimmt jeden Wert entgegen, also auch profile oder book; die Einstellung für den Vorgabetyp kennt nur article und website.
Mehrsprachige Werte
Jeder Wert darf mehrere Sprachen in einem Feld führen, getrennt durch |, jeweils als Zweibuchstaben-Kürzel und Doppelpunkt. Das gilt auch für die Einstellungen defaultDescription, defaultImage und siteName.
<og> title = de:Kryptographie|en:Cryptography|sl:Kriptografija </og>
Woher jeder Wert kommt
| Stufe | Quelle | Was sie beisteuert |
|---|---|---|
| 1 | Vorgaben | Einstellungen des Pakets, Wiki-Titel, Seitentitel, Seitenadresse, Seitenauszug |
| 2 | Seite | der Block dieser Seite |
| 3 | Beitragende Pakete | das Ereignis WKOPENGRAPH_VALUES |
Später gesetzte Werte gewinnen, leere Werte überschreiben nie. Ausgeliefert wird, was nicht leer ist. Ein leerer Wert erzeugt kein Tag — und das ist Absicht: ein ausgeliefertes leeres Tag liest ein Auswerter als Zusage, diese Seite habe keine Beschreibung, statt sich selbst eine zu suchen.
Die Kette der Beschreibung
Die Beschreibung ist der einzige Wert, dessen Vorgabe selbst eine Kette ist: erst der Seitenauszug, sonst die Einstellung defaultDescription, sonst die Tagline des Wikis.
Die Reihenfolge ist der Punkt. Der Seitenauszug steht vorn, weil er als Einziger die geteilte Seite beschreibt; Vorgabetext und Tagline beschreiben das Wiki und sind auf jeder Seite gleich. Ohne diese erste Stufe lieferte der häufigste Fall — eine Seite ohne eigenen Block — überhaupt keine Beschreibung.
Der Auszug wird auf 200 Zeichen gekürzt, an einer Wortgrenze. Der Wert liegt bewusst zwischen den rund 160 Zeichen, die Suchmaschinen anzeigen, und den rund 300, die Open-Graph-Auswerter annehmen — damit ein Text für beide taugt, ohne dass zwei gepflegt werden müssen.
Bild-Kennungen werden aufgelöst
Ein Bildwert, der mit : beginnt, ist eine DokuWiki-Medien-Kennung und keine fertige Adresse. Er wird vor der Auslieferung in eine absolute Adresse übersetzt — ein Netzwerk, das die Vorschau abruft, hat keinen Wiki-Kontext und könnte eine Kennung nicht auflösen.
Erzeugte Meta-Tags
Ausgeliefert werden og:title, og:description, og:image, og:url, og:type und og:site_name, dazu die twitter:-Entsprechungen für Titel, Beschreibung und Bild. Jedes Tag nur, wenn sein Wert nicht leer ist.
Verwaltungsbildschirm
Der Bildschirm liegt unter ?do=admin&page=wkopengraph. Er zeigt die Vorgaben mit ihrer Wirkung, bietet den Block einer Seite als Formular an und prüft die Vorschaubilder.
Was Speichern an der Konfiguration tut
Die Vorgaben liegen in der Konfiguration des Wikis. Das Formular schreibt sie über den gewöhnlichen Weg des Konfigurationsmanagers — es gibt keinen zweiten Speicherort und keine Datei, die nur dieses Paket kennt.
Vorgaben
Die Einstellungen regeln Vorgabetext, Vorgabebild, Vorgabetyp, den Namen der Site und die Schwellen der Bildprüfung. Ein ungültiger Wert wird nicht übernommen; es gilt dann die Vorgabe.
Prüfung der Vorschaubilder
Die Prüfung meldet Vorschaubilder, die zu klein sind oder ein ungünstiges Seitenverhältnis haben. Sie ist eine Meldung, keine Sperre: ein Bild wird nie zurückgehalten, sondern benannt.
Erweiterungspunkt
Andere Pakete steuern eigene Werte über das Ereignis WKOPENGRAPH_VALUES bei. Das ist Stufe 3 der Herkunft. Der Beiträger liefert nur Werte; Vokabular, Maskierung und die Entscheidung, welche Tags es gibt, bleiben bei diesem Paket — zwei Pakete, die in denselben Kopf schreiben, erzeugten doppelte Eigenschaften, die Auswerter uneinheitlich auflösen. So beliefert etwa Blog jeden Beitrag mit seinen eigenen Werten.
Verhalten in Sonderfällen
- Eine Seite ohne Block bekommt trotzdem alle sechs Werte — aus den Vorgaben.
- Ein leerer Wert im Block überschreibt nicht; er lässt die Vorgabe stehen.
- Ein unbekannter Schlüssel ist gültig und wirkungslos.
- Fehlt
wkcore, entfällt die zweite Schreibweise; die erste bleibt.
Empfehlungen für Vorschaubilder
Ein Vorschaubild sollte mindestens 1200 × 630 Bildpunkte haben und im Verhältnis nahe 1,91:1 liegen — das ist das Format, das die verbreiteten Netzwerke ohne Beschnitt zeigen. Kleinere Bilder werden ausgeliefert, aber häufig vergrößert oder weggelassen.