Gadget Makro
Gadgets sind kleine Applikationen, die dynamische Inhalte anbieten können. Meistens werden sie von Web-Applikationen-Servern bedient und können in zahlreichen anderen Web-Applikationen wiederbenutzt werden. In Confluence können Sie das Gadget Makro benutzen, um Seiten oder Blog Post Gadgets hinzuzufügen.
Confluence bietet einige native Gadgets an, die Sie Ihren Seiten oder Blog Posts hinzufügen können. Sie können auf zusätzliche Gadgets zugreifen, wenn Ihr Confluence Admin:
- extra Gadgets in Confluence installiert hat (im typischen Fall als Confluence Plugin oder
- Gadgets registriert hat, die von einer externen Web-Applikation oder Webseite (wie z.B. einer Jira Applikation) bedient werden.
Im Gegensatz zu anderen Makros, ist der Name jedes Gadget-Makros einzigartig und folgt der Regel "<gadget-name> macro", wobei <gadget-name> der Name des Gadgets selbst ist.
Anwendung des Gadget Makros
So fügen Sie Gadgets auf Confluence Seiten oder Blog Posts ein:
- Im Bearbeitungsmodus der Seite klicken Sie oben im Editor Menü auf das
Symbol (Weiteren Inhalt einfügen) und dann auf Andere Makros. - Klicken Sie links in der Randleiste auf Externer Inhalt, um eine Liste aller Gadgets Ihrer Confluence-Instanz zu sehen.
(Einige Confluence Makros, wie z.B. Jira Issues, RSS Feed, and Widget Connector, sind hier auch sichtbar, da diese auf auch externe Inhalte zugreifen können.) - Klicken Sie auf das gewünschte Gadget, um die Parameter und Eigenschaften aufzurufen.
Fast alle Gadgets ermöglichen es Ihnen, grundlegende Parameter einzustellen (siehe unten), welche in dem Parameter-Dialog erscheinen. Einige Gadgets besitzen auch ihre eigenen Parameter, welche nur direkt im Gadget selbst eingestellt werden können. Sie können auf diese mit Hilfe des Preview-Panels im Makro-Browser zugreifen. - Geben Sie die Parameter je nach Ihren Anforderungen ein.
- Klicken Sie auf Vorschau, um Ihre Änderungen anzusehen.
- Klicken Sie auf Einfügen, um das Gadget zu Ihrer Seite hinzuzufügen.
Schneller geht's mit der Autovervollständigung:
Tippen Sie die sich öffnende geschweifte Klammer '{' und den Beginn des Names des Makros, um eine Liste vorgeschlagener Makros zu sehen.
Editieren eines existierenden Gadgets auf einer Confluence Seite oder einem Blog Post
Um ein existierendes Gadget auf einer Seite oder einem Blog Post zu bearbeiten:
Klicken Sie im Bearbeitungsmodus der Seite oder des Blog Eintrags auf den Gadget-Platzhalter und dann auf Bearbeiten (oder doppel-klicken Sie auf den Platzhalter).
- Ändern Sie die Parameter des Gadgets.
- Klicken Sie auf Vorschau, um die Änderungen anzusehen.
- Speichern Sie das Gadget.
Standard-Parameter der Gadgets
Bei fast allen Gadgets können Basis-Parameter (siehe unten) eingestellt werden. Diese können Sie rechts im Makro-Dialog sehen. Jedes Gadget kann auch seine eigenen Parameter besitzen, die Sie links im Dialog sehen können.
Parameter | Standard- | Beschreibung |
|---|---|---|
Breite | 450 pixels | Bestimmen Sie die Breite des Gadgets:
|
Rand | angeklickt | Wählen Sie aus, ob das Gadget einen dünnen grauen Rand haben soll oder nicht. |
Inhalte eines Gadget Markros
Zusätzlich zu den Standard-Parametern, beinhaltet das Gadget Makro "Parameter-ähnliche" Inhalte, welche spezifische Eigenschaften beinhalten, die für jedes Gadget verschieden sind. Deshalb dokumentieren wir diese hier nicht. Diese Inhalte würden nur geändert werden, wenn die Standard-Eigenschaften des Gadgets durch den Makro-Browser geändert würden.
Beispiel eines Wiki Markups
Macro name: gadget
Macro body: None.
This example shows the Confluence Page gadget:
{gadget:width=500|border=false|url=rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml} spaceName=Documentation&spaceKey=DOC&quickfind-space=Documentation&pageId=753666&pageName=Documentation%20Home&quickfind-page=Documentation%20Home&isEditable=true&isConfigured=true&refresh=15&showLink=false {gadget}This example shows the Confluence News gadget:
{gadget:url=rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:Diese zusätzlichen Parameter gibt es im Wiki-Markup.
| Parameter | Benötigt | Standard-Einstellung | Beschreibung des Parameters und akzeptierte Werte |
|---|---|---|---|
url | Ja | Keine | Dieses ist der Speicherort der Gadget-Spezifikation (XML-Datei) |
preferences | Nein | (je nach Gadget) | Spezifische Eigenschaften, die für jedes Gadget anders sind. |
Ein Hinweis zum Bearbeiten der Eigenschaften (Einstellungen) des Gadgets beim Markup: es ist möglich, diese Werte der Eigenschaften direkt im Wiki-Markup oder im Storage-Format zu bearbeiten. Dieses erlaubt jedoch die Eingabe von ungültigen Werten. Wenn eine Gadget-Eigenschaft einen bestimmten Satz von Werten unterstützt, beschränkt der Makro-Browser den Benutzer darauf, nur gültige Werte für diese Eigenschaften auszuwählen. Aus diesem Grund empfehlen wir Ihnen, die Eigenschaften eines Gadgets mit dem Makro-Browser zu bearbeiten.
Übersicht aller Confluence Makros
Auf dieser Seite finden Sie eine Übersicht aller im Standard von Confluence enthaltenden Makros und allgemeine Informationen über die Anwendung von Makros.