summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/meta.mdwn
blob: c9660d79b2c9ce81e6da6201ebf42f8720d87861 (plain)

Die meta-Anweisung wird durch die [[!iki plugins/meta desc=meta]]-Erweiterung bereitgestellt.

Diese Anweisung erlaubt es, beliebige Metadaten in den Quelltext einer Seite einzufügen. Dies geschieht wie folgt:

\[[!meta field="value"]]
\[[!meta field="value" param="value" param="value"]]

In der ersten Form wird das angegebene Feld auf den angegebenen Wert gesetzt. In der zweiten Form werden zusätzlich einige Unter-Parameter angegeben.

Die Feldwerte können HTML-Entities enthalten, zum Beispiel kann durch " ein Anführungszeichen eingefügt werden.

Unterstützte Felder:

  • title

    Überschreibt den Titel der Seite, der normalerweise dem Namen der Seite entspricht. Wenn der Titel so überschrieben wird, wird die Template-Variable title_overridden auf wahr gesetzt. Eine Vorlage kann in diesem Fall eine andere Darstellung wählen.

    An optional sortas parameter will be used preferentially when [[ikiwiki/pagespec/sorting]] by meta(title):

    [[!meta title="The Beatles" sortas="Beatles, The"]]

    [[!meta title="David Bowie" sortas="Bowie, David"]]

  • license

    Gibt eine Lizenz für die Seite an, etwa GPL. Kann WikiLinks und beliebige Formatierungsanweisungen enhalten.

  • copyright

    Gibt die Urheberrechte der Seite an, zum Beispiel Copyright 2007 by Joey Hess. Kann WikiLinks und beliebige Formatierungsanweisungen enhalten.

  • author

    Gibt den Autor der Seite an.

    An optional sortas parameter will be used preferentially when [[ikiwiki/pagespec/sorting]] by meta(author):

    [[!meta author="Joey Hess" sortas="Hess, Joey"]]

  • authorurl

    Gibt eine URL für den Autor der Seite an.

  • description

    Gibt eine kurze Beschreibung der Seite an. Diese wird im HTML-Header angegeben und kann zum Beispiel auch durch die [[map]]-Anweisung ausgegeben werden.

  • permalink

    Gibt einen dauerhaften Link zu der Seite an, wenn dieser anders ist als die von ikiwiki generierte Seite.

  • date

    Gibt das Erstellungsdatum der Seite an. Das Datum kann in nahezu beliebigem Format angegeben werden, da es durch [[!cpan TimeDate]] interpretiert wird.

  • stylesheet

    Fügt ein Stylesheet zu der Seite hinzu. Der angegebene Name wird als WikiLink zu einer .css-Datei im Wiki behandelt, es können also keine externen Stylesheets eingebunden werden. Beispiel:

    [[!meta stylesheet=somestyle rel="alternate stylesheet" title="somestyle"]]

  • openid

    Fügt die nötigen <link>-Tags für die Weiterleitung an einen externen OpenID-Server ein. Dadurch kann eine ikiwiki-Seite als OpenID verwendet werden.

    Standardmäßig werden sowohl openid als auch openid2 weitergeleitet. Um nur eines davon weiterzuleiten, kann ein Parameter wie delegate=openid verwendet werden.

    Der optionale Parameter xrds-location erlaubt es, den Ort eines eXtensible Resource DescriptorS anzugeben.

    Beispiel:

    [[!meta openid="http://joeyh.myopenid.com/" server="http://www.myopenid.com/server" xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]]

  • link

    Gibt einen Link zu einer anderen Seite an. Auf diese Weise kann das Wiki dazu gebracht werden, eine Seite so zu behandeln, als ob sie einen Link auf eine andere enthält, ohne dass die Benutzer einen [[ikiwiki/WikiLink]] zu Gesicht bekommen:

     \[[!meta link=andereseite]]
    

    Es kann auch ein HTML <link>-Tag eingefügt werden, zum Beispiel:

     \[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
    

    Allerdings ist diese zweite Syntax nicht erlaubt, wenn die [[!iki plugins/htmlscrubber desc=htmlscrubber]]-Erweiterung aktiviert ist, weil auf diese Weise unsichere Inhalte eingefügt werden können.

  • redir

    Lässt die Seite auf eine andere Seite im Wiki weiterleiten.

    [[!meta redir=andereseite]]

    Es kann optional eine Verzögerung (delay=seconds) angegeben werden. Voreingestellt ist, ohne Verzögerung weiterzuleiten.

    Es kann auch auf eine externe URL weitergeleitet werden. Zum Beispiel:

    [[!meta redir="http://beispiel.de/"]]

    Allerdings ist diese zweite Syntax nicht erlaubt, wenn die [[!iki plugins/htmlscrubber desc=htmlscrubber]]-Erweiterung aktiviert ist, weil auf diese Weise unsichere Inhalte eingefügt werden können.

    In beiden Fällen kann ein anzuspringender Anker auf der Zielseite angegeben werden, indem die übliche #ANKER-Syntax verwendet wird.

  • robots

    Schreibt den robots-Meta-Tag:

      \[[!meta robots="index, nofollow"]]
    

    Zulässige Werte sind index, noindex, follow und nofollow. Es können mehrere Werte durch Kommas getrennt angegeben werden, aber offensichtlich ergeben nur einige Kombinationen Sinn. Wenn der robots-Meta-Tag nicht explizit angegeben wird, wird als Voreinstellung "index,follow" angenommen.

    Der Wert wird nicht auf Zulässigkeit geprüft.

  • guid

    Gibt eine global einmalige ID für die Seite an. Diese guid sollte eine URI sein (insbesondere kann sie nach [[!rfc 4122]] urn:uuid: gefolgt von einer UUID sein). Sie wird verwendet, um den Eintrag der Seite in RSS- und Atom-Feeds zu identifizieren. Wird keine guid angegeben, wird an dieser Stelle die URL der Seite verwendet.

    Diese Angabe ist in erster Linie dann nützlich, wenn eine Seite verschoben wurde: Indem die guids unverändert gelassen werden, kann das Fluten von Aggregatoren vermieden werden (siehe [[!iki tips/howto_avoid_flooding_aggregators]]).

  • updated

    Gibt eine gefälschte Änderungszeit für die Seite an, die dann von RSS- und Atom-Feeds ausgegeben wird. Dies ist nützlich, um Aggregatoren nicht zu fluten, die nach Änderungszeit sortieren, wie etwa Planet: Wenn man zum Beispiel einen alten Blog-Eintrag bearbeitet (etwa um Tags hinzuzufügen), kann man updated auf eine Sekunde später als den ursprünglichen Wert setzen. Das Datum mit Uhrzeit kann in jedem Format angegeben werden, das von [[!cpan TimeDate]] verstanden wird, genauso wie im Feld date.

Wenn das Feld nicht eines der oben vordefinierten ist, werden die Metadaten als <meta>-Header in die generierte Seite geschrieben. Dies ist allerdings nicht erlaubt, wenn die [[!iki plugins/htmlscrubber desc=htmlscrubber]]-Erweiterung aktiv ist, da auf diese Weise unsichere Inhalte eingefügt werden können.

[[!meta robots="noindex, follow"]]