Vorlage:MediaWikiGadgetDefinition/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:MediaWikiGadgetDefinition.

TemplateData

{ "description": "Dokumentation eines '''Gadgets''' unter '''MediaWiki'''.<br /> Es kann ein Abschnitt „Profil“ (oder ähnlich) erzeugt werden.",
  "params": {
     "ID":
        { "label":           "Bezeichner",
          "description":     "Gadget-Bezeichner",
          "type":            "line",
          "suggested":       true,
          "example":         "myGenialGadget" },
     "ResourceLoader":       
        { "label":           "RL",
          "description":     "ResourceLoader möglich",
          "type":            "boolean",
          "required":        false,
          "default":         "0",
          "example":         "1" },
     "default":              
        { "label":           "Standard",
          "description":     "Standardmäßig aktiv",
          "type":            "boolean",
          "required":        false,
          "default":         "0",
          "example":         "1" },
     "hidden":               
        { "label":           "versteckt",
          "description":     "Nicht in den Einstellungen konfigurierbar",
          "type":            "boolean",
          "required":        false,
          "default":         "0",
          "example":         "1" },
     "dependencies":         
        { "label":           "",
          "description":     "Benötigte RL-Module; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false },
     "scripts":              
        { "label":           "",
          "description":     "Eingebundene JS-Ressourcen; mehrere möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false },
     "styles":               
        { "label":           "",
          "description":     "Eingebundene CSS-Ressourcen; mehrere möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false },
     "datas":                
        { "label":           "",
          "description":     "Eingebundene JSON-Ressourcen; mehrere möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false },
     "peers":                
        { "label":           "",
          "description":     "CSS-only-Ressourcen; mehrere möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false },
     "messages":             
        { "label":           "",
          "description":     "Benötigte Systemnachrichten; mehrere möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false },
     "package":              
        { "label":           "",
          "description":     "package-Unterstützung",
          "type":            "boolean",
          "required":        false,
          "default":         "0",
          "example":         "1" },
     "supportsUrlLoad":      
        { "label":           "",
          "description":     "Aufruf über URL unterstützen",
          "type":            "boolean",
          "required":        false,
          "default":         "0",
          "example":         "1" },
     "skins":                
        { "label":           "Skins",
          "description":     "Skin; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false,
          "suggestedvalues": <strong class="error"><span class="scribunto-error mw-scribunto-error-94f855ec">Lua-Fehler in Modul:MediaWikiGadgetDefinition, Zeile 462: attempt to index field &#039;data&#039; (a nil value)</span></strong> },
     "rights":               
        { "label":           "Rechte",
          "description":     "Erforderliche Rechte; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false,
          "example":         "protect" },
     "actions":              
        { "label":           "Aktivitäten",
          "description":     "Seiten-Operation; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false,
          "suggestedvalues": <strong class="error"><span class="scribunto-error mw-scribunto-error-94f855ec">Lua-Fehler in Modul:MediaWikiGadgetDefinition, Zeile 462: attempt to index field &#039;data&#039; (a nil value)</span></strong> },
     "namespaces":           
        { "label":           "Namensräume",
          "description":     "Namensraum-Nummern; mehrere möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false },
     "contentmodels":        
        { "label":           "Inhaltsmodelle",
          "description":     "Content Model der Seite; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false,
          "suggestedvalues": <strong class="error"><span class="scribunto-error mw-scribunto-error-94f855ec">Lua-Fehler in Modul:MediaWikiGadgetDefinition, Zeile 462: attempt to index field &#039;data&#039; (a nil value)</span></strong>,
          "default":         "wikitext" },
     "pageprops":            
        { "label":           "",
          "description":     "",
          "description":     "Seiten-Eigenschaften; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false },
     "transcludes":          
        { "label":           "",
          "description":     "Eingebundene Seiten; Mehrfachauswahl möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false },
     "groups":               
        { "label":           "",
          "description":     "; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false },
     "userlangs":            
        { "label":           "",
          "description":     "Sprachcode der Benutzersprache; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false },
     "contentlangs":         
        { "label":           "",
          "description":     "Sprachcode der Seiteninhaltssprache; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "required":        false },
     "categories":           
        { "label":           "",
          "description":     "Eingetragen in Kategorie; Mehrfachauswahl möglich, durch Pipe getrennt",
          "type":            "line",
          "required":        false,
          "aliases":         [ "category" ] },
     "type":                 
        { "label":           "",
          "description":     "Ressourcentyp",
          "type":            "line",
          "required":        false,
          "suggestedvalues": [ "general", "styles" ] },
     "targets":              
        { "label":           "Geräte",
          "description":     "Geräte-Modus; Mehrfachauswahl möglich, durch Leerzeichen, Komma oder Pipe getrennt",
          "type":            "line",
          "suggestedvalues": [ "desktop", "mobile" ],
          "default":         "desktop",
          "deprecated":      "Skins verwenden" },
     "top":                  
        { "label":           "",
          "description":     "Vorrangig laden",
          "type":            "boolean",
          "required":        false,
          "default":         "0",
          "example":         "1",
          "deprecated":      true },
     "Comment":              
        { "label":           "",
          "description":     "Freier Kommentar",
          "type":            "content",
          "required":        false },
     "Überschrift":              
        { "label":           "",
          "description":     "Abschnittsüberschrift",
          "type":            "content",
          "required":        false,
          "default":         "Profil",
          "example":         "Definition" },
     "Überschrifts&shy;stufe":              
        { "label":           "",
          "description":     "Level der Abschnittsüberschrift, bei <code>-</code> keinen Abschnitt",
          "type":            "number",
          "required":        false,
          "suggestedvalues": [ "2", "3", "-" ],
          "default":         "-",
          "example":         "3" }
            },
  "format": "block"
}

Kopiervorlagen

{{MediaWikiGadgetDefinition
 |ID=
 |ResourceLoader=1
 |default=
 |hidden=
 |skins=
 |rights=
 |actions=
 |namespaces=
 |contentmodels=
 |pageprops=
 |transcludes=
 |groups=
 |userlangs=
 |dependencies=
 |scripts=
 |styles=
 |datas=
 |messages=
 |Comment=
}}

Beispiele

{{MediaWikiGadgetDefinition
 |ID=
 |ResourceLoader=1
 |default=1
 |hidden=1
 |actions=view
 |namespaces=4
 |scripts=desktopHauptseite.js
 |styles=desktopHauptseite.css
}}

Beispiel 1

{{MediaWikiGadgetDefinition
 |ID=prettytable
 |ResourceLoader=1
 |default=1
 |hidden=1
 |actions=view edit
 |namespaces=1 2 3 4 5 100 101
 |styles=prettytable.css
}}