Virtual Organisation:VZML

From VZ Developer Wiki
Jump to: navigation, search

Inhaltsverzeichnis, Virtual_Organisation:VZML, Schritt für Schritt



Einleitung

Die VZ Markup Language (VZML) ermöglicht es, Objekte wie die Pinnwand oder Links aus der Menüleiste in die Vorder- und Rückseite von Edelprofilen einzubinden. Dazu wird an der entsprechenden Stelle ein XML-Tag geschrieben, welches dann vor dem Ausliefern der Profilseite durch das entsprechende Objekt ersetzt wird.

Der Inhalt eines Edelprofils kann über die REST-API oder den Editor im Profil bearbeiten-Menü gesetzt werden. Bei beiden Varianten können VZML-Tags im Text angegeben werden.

ACHTUNG: Momentan ist es über den Edelprofil-Editor nur möglich, die VZML-Tags vz-counter und vz-pinboard zu verwenden.

Tags

Alle VZML Tag bestehen aus einem öffnenden und einem schließenden Tag. Die Tagnamen haben die Form vz-object, wobei object durch den Namen des Objekts ersetzt wird, welches eingebunden werden soll. Ein gültiges VZML-Tag könnte zum Beispiel so aussehen:

    <vz-object> </vz-object>

VZML-Tags können Parameter enthalten, welche die Anzeige der Objekte beeinflussen. Die Parameter werden - wie bei XML - im öffnenden Tag spezifiziert:


    <vz-object parameter="wert"> </vz-object>

Der Inhalt des Tags wird lediglich für einige Elemente berücksichtigt (siehe genaue Erläuterungen zu den einzelnen Tags).

    <vz-object>Diesen Text wird nie jemand lesen, ausser er benutzt den Editor</vz-object>

Anmerkung:

VZML-Tags werden nicht im normalen Profileditor angezeigt. Um sie zu verwenden, muss momentan noch die HTML-Ansicht des Editors genutzt werden. Diese kann im geöffneten Editor per Reiter HTML erreicht werden.


vz-counter

Das vz-counter Tag bindet einen Zähler ein, der anzeigt, wie viele Nutzer das Edelprofil gut finden.

Es können mehrere counter in einem Profil eingebunden werden.


Profilinhalt in der HTML-Ansicht des Editor oder über die Rest-API:

    <p><vz-counter> </vz-counter> </p>

HTML-Code der ausgelieferten Profilseite

    <p>113123</p>

vz-pinboard

Das vz-pinboard Tag bindet das Pinboard an eine bestimmte Stelle des Edelprofils ein.

Wird dieses Tag verwendet, so wird das Pinboard an seiner Standardposition unterhalb des Profilinhalts nicht mehr angezeigt. Werden mehrere vz-pinboard Tags im Profilinhalt verwendet, so wird nur das erste Vorkommen durch das Pinboard ersetzt. Alle weiteren Tags werden lediglich aus dem Profilinhalt entfernt.

Profilinhalt in der HTML-Ansicht des Editor oder über die Rest-API:

    <vz-pinboard> </vz-pinboard>

vz-addlink

Das vz-addlink Tag wird durch einen Link ersetzt, mit dem der Benutzer das Edelprofil gut finden kann.

Der Content des Links wird über den Inhalt des Tags definiert. Hier können übliche HTML-Elemente (z.B. strong, img, h1 etc) verwendet werden. Wird kein Text gesetzt, wird der Link so angezeigt wie im Seitenmenü.

Es ist möglich, mehrere Links in einem Profil einzubinden. Das Vorkommen des Links im rechten Menü auf der Vorderseite wird nicht beeinflusst.

Das <vz-addlink> Tag erzeugt nur einen addlink, wenn der Benutzer das Edelprofil noch nicht hinzugefügt hat. Andernfalls wird weder der Content noch der Link angezeigt. Für den Besitzer des Edelprofils wird nur der Content des Links angezeigt.

Profilinhalt in der HTML-Ansicht des Editor oder über die Rest-API:

    <p><vz-addlink>Der Addlink Text</vz-addlink> </p>
    <p><vz-addlink imgurl="/some/image.png"> </vz-addlink> </p>

HTML-Code der ausgelieferten Profilseite

    <p><a href="...">Der Addlink Text</a></p>
    <p><a href="..."><img src="/some/image.png"/></a></p>

vz-suggestlink

Das vz-suggestlink Tag bindet einen Link ein, mit dem Benutzer das Edelprofil ihren Freunden oder im Buschfunk zeigen können.

Die Funktion des Suggest-Links ist nur für eingeloggte Mitglieder gegeben, so dass der Benutzer sich erst anmelden muss, um das Edelprofil seinen Freunden zu zeigen.

Das vz-suggestlink Tag verhält sich genauso wie das vz-addlink Tag.

    <p><vz-suggestlink>Der Suggestlink Text</vz-suggestlink></p>

vz-editorcontent

Das vz-editorcontent Tag bindet den Text aus dem Editor in den Teil des Edelprofils ein, der über die Rest-API gesetzt wurde.

Wie oben schon beschrieben, kann der Inhalt eines Edelprofils sowohl über den Editor als auch über die Rest-API gesetzt werden. Allerdings können mit der REST-API gesetzte Inhalte nicht mit dem Editor angezeigt und verändert werden und ebenso andersherum. Zur Unterscheidung:

  • Inhalt, der über den Editor eingegeben wird: EditorContent
  • Inhalt, der über die API gesetzt wird: APIContent

EditorContent und APIContent sind im Prinzip komplett unabhängig. Beide werden getrennt gespeichert bzw. bearbeitet und werden standardmäßig untereinander auf der Profilseite angezeigt. Durch Verwendung des <vz-editorcontent></vz-editorcontent> Tags kann der EditorContent in den APIContent eingebunden werden.


Es ist nicht möglich, den EditorContent an mehreren Stellen in den APIContent einzubinden. Lediglich das erste Tag wird bearbeitet, alle weiteren werden ignoriert.

Es ist nicht möglich, das vz-editorcontent Tag innhalb des EditorContents zu verwenden. Sollte der EditorContent dennoch das Tag enthalten, so wird es ignoriert.

Profilinhalt über die Rest-API:

    <p><vz-editorcontent></vz-editorcontent></p>

HTML-Code der ausgelieferten Profilseite:

    <p>Dieser Text würde normalerweise weiter unten im EditorContent angezeigt werden</p>


Inhaltsverzeichnis, Virtual_Organisation:VZML, Schritt für Schritt