Fandom

Wikia Developers Wiki

RelatedDiscussionsModule

823pages on
this wiki
Add New Page
Talk12 Share
This script is for PERSONAL use only!

You are free to install this script for yourself, but it is not allowed to be used wiki-wide (e.g., in MediaWiki:Common.js or MediaWiki:Wikia.js), as it would violate Fandom's Terms of Use. (See the customization policy)

RelatedDiscussionsModule moves the 'Related Discussions' feature of the new forums to the rail - making the discussions module more visible without having it get in the way of content.

Installation

If you would like to use the script, add the following either to your global.js on Community Central (to make the script available on all wikis) or to Special:MyPage/wikia.js on specific wikis.

importArticles({
    type: 'script',
    articles: [
        'u:dev:RelatedDiscussionsModule/code.js'
    ]
});
importArticles — Best Practices for installing JavaScript on Fandom
The importArticles statement is designed to combine multiple HTTP requests into a single data transfer, allowing multiple scripts to load and execute faster. If you've been installing several different scripts, your JavaScript file has probably accumulated unnecessary import statements. Click "Expand" to learn how to efficiently batch import scripts to speed up performance and make your code look cleaner. One other approach is by using the MediaWiki:ImportJS.
If your JavaScript file has several lines of code that say importScript, importScriptPage, or importArticles, you may be able to combine them! By batch importing a collection of scripts with a single import, your JavaScript code will load faster and look cleaner. Consider the example below. On the left is an example of what your JavaScript file might currently look like. On the right is how you could improve that code.
Multiple imports — messy and slow One import — clean and efficient
importScriptPage('AjaxRC/code.js','dev');
 
importScript('MediaWiki:localScript.js');
 
importArticle({
  type: 'script',
  article: 'u:dev:FloatingToc/code.js'
});
 
importScriptPage('page1.js', 'wikiname');
 
importScriptPage('page2.js', 'wikiname');
importArticles({
    type: 'script',
    articles: [
        'u:dev:AjaxRC/code.js',
        'MediaWiki:localScript.js',
        'u:dev:FloatingToc/code.js',
        'u:wikiname:page1.js',
        'u:wikiname:page2.js'
    ]
});
Note: In this example, pay close attention to the placement of commas and other punctuation. For people who aren't familiar with programming (and even those who are!), a common mistake when writing code is to accidentally delete, forget, or misplace critical symbols like commas or quotation marks. This can cause a syntax error that breaks the code. Carefully follow the convention shown here when using importArticles.
But there's much more to importArticles than just this! For more examples and advanced usage, see the help page at Help:Including additional JavaScript and CSS.

Localisation

A localized title for the module can be added using the language code as a key and then creating an object for the message. The default title message is "Related Discussions". If you would like to add a translation, please post it on the script's talk page (or add them to MediaWiki:RelatedDiscussionsModule/code.js directly if you are comfortable with doing so).

You can also override the default message (whether in your language, or otherwise). For example, to override the default message used for the English language, add the following above the import statement:

var RelatedDiscussionsConfig = {'en': "YOUR TITLE HERE"}
Using configuration options with Fandom Open Source Library scripts
The instructions on this page describe how to use configuration options with a script. Here on the Fandom Open Source Library, many scripts provide optional configuration settings as a mean to alter or enhance the default behavior of the script. When installing configuration options in your JavaScript file, please note that they need to go above the import statement in order to work — unless the directions say otherwise.
Configuration options load too late, don't work
Proper placement of configuration options
// 1. AjaxRC import statement
importScriptPage('AjaxRC/code.js','dev');
 
// 2. AjaxRC configuration option
var ajaxRefresh = 30000;
// 1. AjaxRC configuration option
var ajaxRefresh = 30000;
 
// 2. AjaxRC import statement
importScriptPage('AjaxRC/code.js','dev');

Updates

7 April 2013
Eladkse: Fixed localization issue.
29 January 2013
Eladkse: Reduced font size of module heading to 17px to fix layout issue caused by the global increase of all module heading in the rail to 18px.
3 December 2012
Eladkse: Fixing flaw with Tab view loading multiple discussion sections. Will ask Staff to have this removed.
2 December 2012
Eladkse: Reverting some code. Adding multi-language script.
Lunarity: Fixed implicit dependency on the Chat module existing. It now functions on any wiki with the new Forums, even if Chat is not enabled.
1 December 2012
Eladkse: Removed page title. May restore at some point, but alignment with discussion button wasn't very elegant.
30 November 2012
Eladkse: Initial release. Code likely to change as forums moves out of beta stages.

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.