Template:Discord/doc

From Welcome to Elderfield Wiki
Jump to navigation Jump to search
This template allows you to either use DiscordCompact or DiscordWidget to display information about a certain Discord server.

Usage

In order to be able to show a Discord server widget on your wiki, first go to your Discord server and do the following:
  • Open the Server Settings, then go to the Engagement section.
  • Scroll down to Server Widget.
  • Enable the widget.
  • Copy the Server ID.
Then, do the following depending on the type of widget you want to use (compact or full).

Compact widget (default)

Main article: DiscordCompact, [[]] and [[]]
The compact widget is the default one.
To use it, simply add the template with the server ID either as the first parameter or as the id parameter:
  • {{Discord|serverID}}
  • {{Discord|id=serverID}}

Full widget

Main article: DiscordWidget, [[]] and [[]]
To use the full version of the Discord widget, you have to specify full=yes as one of the template parameters, with the ID either as the first parameter or as the id parameter:
  • {{Discord|serverID|full=yes}}
  • {{Discord|full=yes|id=serverID}}
You can further customize the widget with the width, height and other parameters. See the Examples section and the full documentation for DiscordWidget on the Support Wiki.

Examples

Code Result
{{Discord|951501892553424917}}
{{Discord|id=951501892553424917}}
{{Discord|951501892553424917}|full=yes}
{{Discord|full=yes
id = 951501892553424917width = 300pxheight = 500px}} ||

Dependencies


TemplateData

{ "params": { "1": { "aliases": [ "id" ], "label": "Server ID", "description": "The Discord server's ID.", "example": "951501892553424917", "type": "line", "required": true }, "full": { "label": "Use full widget", "example": "yes", "type": "boolean", "description": "Do you want to use the full widget?" }, "width": { "label": "Width (full widget only)", "description": "A custom width for the full widget.", "example": "300px", "type": "line" }, "height": { "label": "Height (full widget only)", "description": "A custom height for the full widget.", "example": "500px", "type": "line" } }, "description": "This template allows you to either use DiscordCompact or DiscordWidget to display information about a certain Discord server.", "paramOrder": [ "1", "full", "width", "height" ], "format": "block" }