Handbuch:Erweiterung/ContentDroplets/Eigene Droplets hinzufügen: Unterschied zwischen den Versionen

Margit Link-Rodrigue (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
Margit Link-Rodrigue (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
Markierung: Quelltext-Bearbeitung 2017
 
(9 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
Es ist möglich eigene existierende Vorlagen oder Tags in den Content Droplets anzuzeigen.
Es ist möglich eigene existierende Vorlagen oder Tags in den Content-Droplets anzuzeigen.


{{Textbox|boxtype=important|header=Wichtig:|text=Wenn Ihre Vorlage Parameter enthält, zeigt das Wiki die Eingabemaske für Parameter erst nach dem ersten Speichern des eingefügten Droplets an. Bei Standard-Droplets wird die Eingabemaske bereits direkt nach dem Einfügen auf der Seite angezeigt.


Gehen Sie zur Seite. Falls diese noch nicht existiert, erstellen Sie die Seite. die Seite wird im json-Format gespeichert und muss eine öffnende und abschließende geschweifte Klammer enthalten:<syntaxhighlight lang="json">
 
Überlegen Sie daher, ob es sinnvoll ist, eigene Droplets mit Parametern anzulegen.|icon=yes}}
 
 
 
Gehen Sie zur Seite ''MediaWiki:ContentDroplets.json''. Falls diese noch nicht existiert, erstellen Sie die Seite. Die Seite wird im <code>json</code>-Format gespeichert und muss eine öffnende und abschließende geschweifte Klammer enthalten:<syntaxhighlight lang="json">
{
{


Zeile 20: Zeile 26:
         ],
         ],
         "description": "message-key",
         "description": "message-key",
         "icon": "check",
         "icon": "MyIcon",
         "rlModules": [],
         "rlModules": [],
         "categories": [
         "categories": [
Zeile 37: Zeile 43:
|DropletName
|DropletName
|z. B. ''TOClimit''
|z. B. ''TOClimit''
|Name der Vorlage ohne Leerzeichen
|Name der Vorlage ohne Leerzeichen (für die Datenbank)
|-
|-
|name
|name
|TOCLimit
|Inhaltsverzeichnis
|Wiederholung des Namens der Vorlage ohne Leerzeichen
|Name, der im Droplet angezeigt wird.
|-
|type
|template
|Bei Vorlagen muss hier der Wert "template" gesetzt werden.
|-
|-
|template
|template
Zeile 56: Zeile 66:
|-
|-
|icon
|icon
|bi-list-columns-reverse
|
|Hintergrund Icon, welches über MediaWiki:Common.css definiert ist. Wenn hier kein Wert existiert, wird ein graues BlueSpice-Icon angezeigt.
|Hintergrund Icon, welches über MediaWiki:Common.css definiert ist. Wenn hier kein Wert existiert, wird ein graues BlueSpice-Icon angezeigt.<syntaxhighlight lang="css">/*icon for custom content droplet ISMS check */
.droplet .icon-droplet.MyIcon {
    background-image: url(/w/nsfr_img_auth.php/6/65/MyIcon.svg);
    background-size: 35px;
}</syntaxhighlight>
|-
|-
|rlModules
|rlModules
Zeile 73: Zeile 87:
|}
|}


== Tag.Droplet hinzufügen ==
== Tag-Droplet hinzufügen ==
Falls Sie im Wiki ein Tag verwenden, welches unter den Droplets erscheinen soll, geben Sie es folgendermaßen an (nachfolgend dem Vorlagen-Droplet angehängt):<syntaxhighlight lang="json">
Falls Sie im Wiki ein Tag verwenden, welches unter den Droplets erscheinen soll, geben Sie es folgendermaßen an. Das Beispiel zeigt die Syntax für ein fiktives <code>myTagDroplet</code> nach dem Vorlagen-Droplet <code>DropetName</code>.<syntaxhighlight lang="json">
{
{
     "DropletName": {
     "DropletName": {
Zeile 111: Zeile 125:
}
}
</syntaxhighlight>
</syntaxhighlight>
[[en:Manual:Extension/ContentDroplets/Adding_your_own_droplets]]

Aktuelle Version vom 5. Februar 2026, 16:03 Uhr

Es ist möglich eigene existierende Vorlagen oder Tags in den Content-Droplets anzuzeigen.

Wichtig:Wenn Ihre Vorlage Parameter enthält, zeigt das Wiki die Eingabemaske für Parameter erst nach dem ersten Speichern des eingefügten Droplets an. Bei Standard-Droplets wird die Eingabemaske bereits direkt nach dem Einfügen auf der Seite angezeigt.


Überlegen Sie daher, ob es sinnvoll ist, eigene Droplets mit Parametern anzulegen.



Gehen Sie zur Seite MediaWiki:ContentDroplets.json. Falls diese noch nicht existiert, erstellen Sie die Seite. Die Seite wird im json-Format gespeichert und muss eine öffnende und abschließende geschweifte Klammer enthalten:

{

}

Vorlagen-Droplet hinzufügen[Bearbeiten | Quelltext bearbeiten]

Zwischen den Klammern können Sie Ihre Droplets definieren.

{
    "DropletName": {
    	"name": "TemplateDroplet",
        "type": "template",
        "template": "Lorem",
        "params": [
        	{ "color": "blue" },
            { "count": "5" }
        ],
        "description": "message-key",
        "icon": "MyIcon",
        "rlModules": [],
        "categories": [
            "content"
        ],
        "content": "{{Lorem|color=blue|count=5}}"
    }
}
Objekt/Node Wert (Beispiele) Beschreibung
DropletName z. B. TOClimit Name der Vorlage ohne Leerzeichen (für die Datenbank)
name Inhaltsverzeichnis Name, der im Droplet angezeigt wird.
type template Bei Vorlagen muss hier der Wert "template" gesetzt werden.
template TOClimit Name der existierenden Vorlagenseite im Vorlagennamensraum (kann Leerzeichen beinhalten)
params "color":"blue" Name der Parameter, die in der Vorlage existieren. Ein Standardwert kann mitgegeben werden
description Formatierung des Inhlaltsverzeichnisses anpassen. Beschreibung des Droplets, die im Droplet-Menü angezeigt wird (kann direkt eingegeben werden oder bei mehrsprachigen Wikis als "message-key".
icon Hintergrund Icon, welches über MediaWiki:Common.css definiert ist. Wenn hier kein Wert existiert, wird ein graues BlueSpice-Icon angezeigt.
/*icon for custom content droplet ISMS check */
.droplet .icon-droplet.MyIcon {
    background-image: url(/w/nsfr_img_auth.php/6/65/MyIcon.svg);
    background-size: 35px;
}
rlModules - -
categories content, featured Zeigt die Vorlage in unterschiedlichen Reitern des Droplet-Menüs auf. Mögliche Werte:

content, featured, media, visualization, data, navigation, lists, export,all

content {{TOClimit|color=blue}} Wikitext, der im Quelltext der Seite eingefügt werden soll (also die Transklusion der Vorlage).

Tag-Droplet hinzufügen[Bearbeiten | Quelltext bearbeiten]

Falls Sie im Wiki ein Tag verwenden, welches unter den Droplets erscheinen soll, geben Sie es folgendermaßen an. Das Beispiel zeigt die Syntax für ein fiktives myTagDroplet nach dem Vorlagen-Droplet DropetName.

{
    "DropletName": {
    	"name": "TemplateDroplet",
        "type": "template",
        "template": "Lorem",
        "params": [
        	{ "color": "blue" },
            { "count": "5" }
        ],
        "description": "message-key",
        "icon": "check",
        "rlModules": [],
        "categories": [
            "content"
        ],
        "content": "{{Lorem|color=blue|count=5}}"
    },
        "myTagDroplet": {
    	"name": "TagDroplet",
    	"type": "tag",
    	"tagname": "Lorem",
    	"attributes": [
    		{ "color": "blue" }
    	],
    	"hasContent": false,
    	"veCommand": "droplet",
    	"description": "message-key",
        "icon": "check",
        "rlModules": [],
        "categories": [
        	"content"
        ],
        "content": "<myDroplet color=blue/>"
    }
}