Changes: MibbitIRC

Revision as of 18:35, 18 January 2014

This script places a pre-created Mibbit chatroom into a page with a certain div on it. This can be on any page: however, you only have one chat that it automatically connects to.

Installation

Step 1: Importation

This script is easy to use: first, place the following line into MediaWiki:Common.js:

importArticle({type:'script', article:'w:c:dev:MibbitIRC/code.js'});

This isn't enough to make anything show up--it's enough to input the widget, and nothing more. You need to specify what channels and server to use!

Step 2:The variables

Two different variables are required for the script.

    var ServerIdentify = "<the name of your server>";

The above specifies what server your IRC chat is on--to find out this and the contents of the next variable, go to menu > link to channel. The link it gives you will have &server= on it somewhere; copy the text after &server= for your server variable. Copy the link after ?channel=23% for your channel variable.

var ChannelIdentify = "<the name of your channel>";

the second variable.

This should set up your on-wiki channel; if you want to change the width, you should consider importing the whole script.

Step 3: The Div

Now, you need to insert it. Find the page you want to use, and insert the following div:

<div id="JRChatReplace">
text
</div>

Note: this is under construction and may be faulty.

Great thanks to Sactage for figuring out how to use the variables in the URL.

Alternate Configuration

This script currently is faulty when configured with the above method; thus, a different method should instead be used until this script is ready for normal configuration.

Copy the entire script within Code.js.
Follow step 2; however, place the two varables within the function--above the first variable declaration, but below any lines above it-- like this.

    var ServerIdentify = "servername";
    var ChannelIdentify = "channelname";
    var replace = document.getElementById("JRChatReplace");

The above should be what your variables look like.

Now, follow step 3. The script should be working well.

Note: this is probably possible with verbatim, but w/e

@@ Line 11: / Line 11: @@
 ==Installation==
+===Step 1: Importation===
 This script is easy to use: first, place the following line into MediaWiki:Common.js:
 <source lang="javascript">
@@ Line 18: / Line 19: @@
 This isn't enough to make anything show up--it's enough to input the widget, and nothing more. You need to specify what channels and server to use!
-===The variables===
+===Step 2:The variables===
 Two different variables are required for the script.
 <source lang="javascript">
-var ServerIdentify = "<the name of your server>";
+    var ServerIdentify = "<the name of your server>";
 </source>
@@ Line 35: / Line 36: @@
 This should set up your on-wiki channel; if you want to change the width, you should consider importing the whole script.
+===Step 3: The Div===
 Now, you need to insert it. Find the page you want to use, and insert the following div:
 <syntaxhighlight lang="html5">
@@ Line 44: / Line 46: @@
 ''Great thanks to Sactage for figuring out how to use the variables in the URL.''
+==Alternate Configuration==
+This script currently is faulty when configured with the above method; thus, a different method should instead be used until this script is ready for normal configuration.
+* Copy the entire script within [[/code.js|Code.js]].
+* Follow step 2; however, place the two varables within the function--above the first variable declaration, but below any lines above it-- like this.
+<source lang="javascript">
+    var ServerIdentify = "servername";
+    var ChannelIdentify = "channelname";
+    var replace = document.getElementById("JRChatReplace");
+</source>
+The above should be what your variables look like.
+* Now, follow step 3. The script should be working well.
+<small> ''Note: this is probably possible with verbatim, but w/e'' </small>