m (Undo revision 77443 by GetdunkedonB (talk)) |
DjinnScythe (talk | contribs) m (→Sidebar: missing word "id" on the config. Is it not what you want to? If not, revert it.) Tag: Visual edit |
||
Line 59: | Line 59: | ||
=== Sidebar === |
=== Sidebar === |
||
− | The script can be configured to add the widget to the sidebar of the wiki on [[Help:Layout|Oasis]] skin through editing several MediaWiki pages. Any MediaWiki page relating to the configuration of DiscordIntegrator starts with <code>MediaWiki:Custom-DiscordIntegrator-config-</code> and after it goes the name of the configuration option. For example, to configure the ID of the server, you'd need to go to <code>[[MediaWiki:Custom-DiscordIntegrator-config-id]]</code>. |
+ | The script can be configured to add the widget to the sidebar of the wiki on [[Help:Layout|Oasis]] skin through editing several MediaWiki pages. Any MediaWiki page relating to the configuration of DiscordIntegrator starts with <code>MediaWiki:Custom-DiscordIntegrator-config-id</code> and after it goes the name of the configuration option. For example, to configure the ID of the server, you'd need to go to <code>[[MediaWiki:Custom-DiscordIntegrator-config-id]]</code>. |
The widget will appear in the siderail, ''only'' if the ID of the server is set in configuration options. Configuration options have same names as configuration options when adding the widget to content, except with the addition of a few parameters: |
The widget will appear in the siderail, ''only'' if the ID of the server is set in configuration options. Configuration options have same names as configuration options when adding the widget to content, except with the addition of a few parameters: |
||
Line 128: | Line 128: | ||
; I see "Template loop detected<nowiki>:</nowiki> Template:DiscordIntegrator"! |
; I see "Template loop detected<nowiki>:</nowiki> Template:DiscordIntegrator"! |
||
: Then you didn't copy the template correctly. |
: Then you didn't copy the template correctly. |
||
− | : You need to copy [{{fullurl:Template:DiscordIntegrator|action=raw}} e |
+ | : You need to copy [{{fullurl:Template:DiscordIntegrator|action=raw}} e 'template p] ] onto the '''template page of the same name on your wiki.''' |
: As an example, on [[w:c:diepio|Diep.io Wiki]] that template would be located [[w:c:diepio:Template:DiscordIntegrator|here]]. |
: As an example, on [[w:c:diepio|Diep.io Wiki]] that template would be located [[w:c:diepio:Template:DiscordIntegrator|here]]. |
||
: After copying the template contents, you would have to use that template to make the Discord widget display on wiki pages. General information about template usage can be found [[w:Help:Templates|here]]. |
: After copying the template contents, you would have to use that template to make the Discord widget display on wiki pages. General information about template usage can be found [[w:Help:Templates|here]]. |
Revision as of 01:23, 23 May 2018
DiscordIntegrator allows integrating a Discord widget into your sidebar or content. The Discord widget is able to show all online users in a server, the users game activity, anyone in a voice channel and etc.
If, after reading the documentation, you still don't understand how to set DiscordIntegrator up, read the step-by-step manual.
Installation
To install this script, go to your wiki's MediaWiki:ImportJS page. If you don't know where your wiki's ImportJS page is, just copy this link http://dev.wikia.com/wiki/MediaWiki:ImportJS
and replace "dev" with the name of your wiki. For example, if your wiki is the Disney Wiki you would go to http://disney.wikia.com/wiki/MediaWiki:ImportJS
.
Once you have arrived at your wiki's ImportJS page, click the "Edit" button and insert:
dev:DiscordIntegrator/code.js
into the page.
Note: DiscordIntegrator configuration and importing does not require any JavaScript review in order to function normally.
Configuration
Enabling the widget
The widget can be enabled by Discord server administrators by going through the settings screen of their Discord server and going to the "Widget" settings section. To enable embedding a widget to your server, tick the "Enable Widget" box. If you wish for users to be able to connect to your server through the widget, you should also select a chat room in the "Instant invite channel" option.
Important: The server ID that can be found in the widget settings section is very important for setting up the widget, which is explained in sections below and in the template.
Content
After the script is installed through the methods explained above, it is possible to make the widget show up in the page content. It is advised to create a template on your wiki and copy the contents of {{DiscordIntegrator}}
to it. After that, the template can be used as:
{{DiscordIntegrator | id = 246075715714416641 | theme = light | width = 500px | height = 500px }}
which gives:
Note: DiscordIntegrator does not work on the mobile skin, which will display an error message instead of the Discord widget. To prevent the widget from displaying on the mobile skin, you can set the template type of the widget to a template type that doesn't display on mobile (such as Navbox).
For more complicated usage you can check the DiscordIntegrator template documentation itself.
Sidebar
The script can be configured to add the widget to the sidebar of the wiki on Oasis skin through editing several MediaWiki pages. Any MediaWiki page relating to the configuration of DiscordIntegrator starts with MediaWiki:Custom-DiscordIntegrator-config-id
and after it goes the name of the configuration option. For example, to configure the ID of the server, you'd need to go to MediaWiki:Custom-DiscordIntegrator-config-id
.
The widget will appear in the siderail, only if the ID of the server is set in configuration options. Configuration options have same names as configuration options when adding the widget to content, except with the addition of a few parameters:
Option | Type | What it changes | Default |
---|---|---|---|
id | Number | ID of your Discord server to embed | None |
title | String | Title of the module on the sidebar | None |
moduleHeight | String | Height of the module in the sidebar | 500px |
text | String | Text above the widget | None |
footer | String | Text below the widget | None |
theme | dark or light
|
Theme of the widget in the sidebar | dark
|
width | Number of pixels (Xpx ) or percent (Y% )
|
Width of the Discord widget | 100%
|
height | Number of pixels (Xpx ) or percent (Y% )
|
Height of the Discord widget | 90%
|
logged-in | Boolean | If the widget should be displayed only to logged-in users | None |
An example of the widget can be seen in the sidebar on this page.
Frequently Asked Questions
- Can I change the colors on the widget?
- Currently, no. The widget is an iframe, therefore its style cannot be changed.
- The widget is loading infinitely.
- That means you didn't enable the widget in your server settings.
- Enable the widget as said in the Enabling the widget section and refresh the page.
- Sometimes it might take a minute or two for the widget to register it's enabled.
- The widget in the sidebar is still loading infinitely!
- Wait a bit for Discord's cache to refresh
- While you wait, check if you posted the server ID into MediaWiki:Custom-DiscordIntegrator-config-id.
- If you put the whole DiscordIntegrator template there, that won't work. Make sure it's only the server ID there.
- I see "Template loop detected: Template
- DiscordIntegrator"!
- Then you didn't copy the template correctly.
- You need to copy e 'template p ] onto the template page of the same name on your wiki.
- As an example, on Diep.io Wiki that template would be located here.
- After copying the template contents, you would have to use that template to make the Discord widget display on wiki pages. General information about template usage can be found here.