Fandom Developers Wiki
mNo edit summary
Tag: rte-source
m (Bring back examples, reword again)
Tag: sourceedit
Line 3: Line 3:
   
 
== '''This manual is assuming the following''' ==
 
== '''This manual is assuming the following''' ==
* Your wiki is [http://YOURWIKINAME.wikia.com '''YOURWIKINAME'''.wikia.com]. When following links in the manual, don't forget to replace '''YOURWIKINAME.wikia.com''' with the URL of your wiki. For example, if your wiki is Disney Wiki, the correct link would be [http://disney.wikia.com '''disney'''.wikia.com].
+
* Your wiki is [http://YOURWIKI.wikia.com '''YOURWIKI'''.wikia.com]. When following links in the manual, don't forget to replace '''YOURWIKI.wikia.com''' with the URL of your wiki. For example, if your wiki is Disney Wiki, the correct link would be [http://disney.wikia.com '''disney'''.wikia.com].
 
* You already have a Discord server. If you don't, read about creating one [https://support.discordapp.com/hc/en-us/articles/204849977-How-do-I-create-a-server- here.]
 
* You already have a Discord server. If you don't, read about creating one [https://support.discordapp.com/hc/en-us/articles/204849977-How-do-I-create-a-server- here.]
 
* You are an [[Help:User rights#Administrators|administrator]] of the wiki and an administrator of the Discord server you are trying to embed into the page.
 
* You are an [[Help:User rights#Administrators|administrator]] of the wiki and an administrator of the Discord server you are trying to embed into the page.
Line 10: Line 10:
 
== Step 1: Ensure JavaScript is enabled ==
 
== Step 1: Ensure JavaScript is enabled ==
 
DiscordIntegrator won't work if JavaScript isn't enabled on your wiki.
 
DiscordIntegrator won't work if JavaScript isn't enabled on your wiki.
# Go to http://YOURWIKINAME.wikia.com/wiki/MediaWiki:Common.js.
+
# Go to http://YOURWIKI.wikia.com/wiki/MediaWiki:Common.js.
 
# If a banner on the top of the page appears saying "''Custom JavaScript is disabled on this wiki.''", you should use [[Special:Contact/general|this contact form]] to contact Staff to enable JavaScript on your wiki. Responses from Staff for enabling JavaScript usually come after 1-2 days, not counting weekend.
 
# If a banner on the top of the page appears saying "''Custom JavaScript is disabled on this wiki.''", you should use [[Special:Contact/general|this contact form]] to contact Staff to enable JavaScript on your wiki. Responses from Staff for enabling JavaScript usually come after 1-2 days, not counting weekend.
 
# '''Do not proceed further until JavaScript has been enabled on your wiki.'''
 
# '''Do not proceed further until JavaScript has been enabled on your wiki.'''
Line 16: Line 16:
 
== Step 2: Import DiscordIntegrator ==
 
== Step 2: Import DiscordIntegrator ==
 
DiscordIntegrator script needs to be imported to your wiki through [[Help:ImportJS|ImportJS]] in order to work.
 
DiscordIntegrator script needs to be imported to your wiki through [[Help:ImportJS|ImportJS]] in order to work.
# Go to http://YOURWIKINAME.wikia.com/wiki/MediaWiki:ImportJS?action=edit&useeditor=source.
+
# Go to http://YOURWIKI.wikia.com/wiki/MediaWiki:ImportJS?action=edit&useeditor=source.
 
# Paste <code>dev:DiscordIntegrator/code.js</code> at the bottom of the page.
 
# Paste <code>dev:DiscordIntegrator/code.js</code> at the bottom of the page.
# Click the publish button or equivalent if its has been renamed
+
# Click on the Publish button to save the page.
   
 
== Step 3: Enable Discord widget ==
 
== Step 3: Enable Discord widget ==
Line 38: Line 38:
 
# Open [{{fullurl:Template:DiscordIntegrator|action=edit&useeditor=source}} this page].
 
# Open [{{fullurl:Template:DiscordIntegrator|action=edit&useeditor=source}} this page].
 
# Select all text in the editor box and copy it.
 
# Select all text in the editor box and copy it.
# Go to http://YOURWIKINAME.wikia.com/wiki/Template:DiscordIntegrator?action=edit&useeditor=source.
+
# Go to http://YOURWIKI.wikia.com/wiki/Template:DiscordIntegrator?action=edit&useeditor=source.
 
# Paste the previously copied text into it.
 
# Paste the previously copied text into it.
# Click the publish button or equivalent if its has been renamed
+
# Click on the Publish button to save the page.
   
 
== Step 5: Use the DiscordIntegrator template ==
 
== Step 5: Use the DiscordIntegrator template ==
Line 46: Line 46:
 
<pre>
 
<pre>
 
{{DiscordIntegrator
 
{{DiscordIntegrator
|id = YOUR SERVER ID
+
|id = <YOUR SERVER ID>
 
|width = 500px
 
|width = 500px
 
|height = 500px
 
|height = 500px
 
}}
 
}}
 
</pre>
 
</pre>
where <code>YOUR SERVER ID</code> should be replaced by the server ID you copied and saved in step 3.
+
where <code>&lt;YOUR SERVER ID></code> should be replaced by the server ID you copied and saved in step 3. For example, '''and this is just an example''', if you wanted to embed Dev Wiki's Discord server (whose server ID is <code>246075715714416641</code>), you would use:
  +
<pre>
  +
{{DiscordIntegrator
  +
|id = 246075715714416641
  +
|width = 500px
  +
|height = 500px
  +
}}
  +
</pre>
  +
which will result in:
  +
<center>
  +
{{DiscordIntegrator
  +
|id = 246075715714416641
  +
|width = 500px
  +
|height = 500px
  +
}}
  +
</center>
   
 
== Step 6: Put the widget into the sidebar ==
 
== Step 6: Put the widget into the sidebar ==
# Go to http://YOURWIKINAME.wikia.com/wiki/MediaWiki:Custom-DiscordIntegrator-config-id?action=edit&useeditor=source.
+
# Go to http://YOURWIKI.wikia.com/wiki/MediaWiki:Custom-DiscordIntegrator-config-id?action=edit&useeditor=source.
 
# Paste your server ID you copied in step 3 into it.
 
# Paste your server ID you copied in step 3 into it.
  +
# Save the page.
# Click the publish button or equivalent if its has been renamed
 
   
 
== '''I still don't understand!''' ==
 
== '''I still don't understand!''' ==

Revision as of 21:15, 9 September 2017

This is a step-by step manual on how to install DiscordIntegrator. It will only outline the important parts and not go into advanced configuration.

This manual is assuming the following

  • Your wiki is YOURWIKI.wikia.com. When following links in the manual, don't forget to replace YOURWIKI.wikia.com with the URL of your wiki. For example, if your wiki is Disney Wiki, the correct link would be disney.wikia.com.
  • You already have a Discord server. If you don't, read about creating one here.
  • You are an administrator of the wiki and an administrator of the Discord server you are trying to embed into the page.
  • You've read the documentation page thoroughly at least twice and still didn't understand how to embed a Discord widget into your wiki.

Step 1: Ensure JavaScript is enabled

DiscordIntegrator won't work if JavaScript isn't enabled on your wiki.

  1. Go to http://YOURWIKI.wikia.com/wiki/MediaWiki:Common.js.
  2. If a banner on the top of the page appears saying "Custom JavaScript is disabled on this wiki.", you should use this contact form to contact Staff to enable JavaScript on your wiki. Responses from Staff for enabling JavaScript usually come after 1-2 days, not counting weekend.
  3. Do not proceed further until JavaScript has been enabled on your wiki.

Step 2: Import DiscordIntegrator

DiscordIntegrator script needs to be imported to your wiki through ImportJS in order to work.

  1. Go to http://YOURWIKI.wikia.com/wiki/MediaWiki:ImportJS?action=edit&useeditor=source.
  2. Paste dev:DiscordIntegrator/code.js at the bottom of the page.
  3. Click on the Publish button to save the page.

Step 3: Enable Discord widget

Discord widget needs to be enabled on your Discord server in order for DiscordIntegrator to be able to embed a widget for your Discord server.

  1. Open Discord.
  2. Select your server on the server list.
  3. Click on the server title above the channel list to see the dropdown with Server Settings. You should see something like this:
    DiscordIntegrator-1
  4. Click on the Server Settings option.
  5. Look at the sidebar of the Server Settings and you should see a Widget option, like this:
    DiscordIntegrator-2
  6. Click on the Widget option.
  7. You should see a screen like this:
    DiscordIntegrator-3
  8. If the checkbox next to the Enable Server Widget is just like in the picture above, click on it to enable the server widget.
  9. Select a channel from the Instant Invite Channel dropdown to make the widget invite people into that channel. This means that when people click on the Connect button on your Discord widget, they will arrive in that channel. If there is no channel set in this option, the Connect button won't appear, so if you want people to be able to join your server through the widget, set this option to a channel.
  10. Click on the Copy button in the Server ID section to copy your server ID, and save your server ID somewhere because it will be used for embedding the widget later.
  11. When properly set up, your server settings should look something like:
    DiscordIntegrator-4

Step 4: Create a DiscordIntegrator template

For easier use of DiscordIntegrator, you would have to have a template for embedding Discord widgets into pages. If you don't want to embed the Discord widget into pages and just want to embed it into the wiki's sidebar, skip directly to step 6.

  1. Open this page.
  2. Select all text in the editor box and copy it.
  3. Go to http://YOURWIKI.wikia.com/wiki/Template:DiscordIntegrator?action=edit&useeditor=source.
  4. Paste the previously copied text into it.
  5. Click on the Publish button to save the page.

Step 5: Use the DiscordIntegrator template

Now you should be able to embed the widget into pages by using source mode to insert the following into pages:

{{DiscordIntegrator
|id     = <YOUR SERVER ID>
|width  = 500px
|height = 500px
}}

where <YOUR SERVER ID> should be replaced by the server ID you copied and saved in step 3. For example, and this is just an example, if you wanted to embed Dev Wiki's Discord server (whose server ID is 246075715714416641), you would use:

{{DiscordIntegrator
|id     = 246075715714416641
|width  = 500px
|height = 500px
}}

which will result in:

If you see this, your JavaScript might be disabled or DiscordIntegrator plugin isn't working. If the latter, please contact a wiki administrator.

Step 6: Put the widget into the sidebar

  1. Go to http://YOURWIKI.wikia.com/wiki/MediaWiki:Custom-DiscordIntegrator-config-id?action=edit&useeditor=source.
  2. Paste your server ID you copied in step 3 into it.
  3. Save the page.

I still don't understand!

If that's the case, use the talk page to ask questions on how to set up the widget or enter the Wikia Developers Discord server and ask for help on setting DiscordIntegrator up over there. Don't forget to note which step are you stuck on and provide the URL to your wiki.