Fandom

Wikia Developers Wiki

ThreadIndicator

869pages on
this wiki
Add New Page
Talk12 Share

ThreadIndicator is a script that places helpful indicators next to threads in forum boards, indicating whether they're closed or highlighted. This means users no longer need to open the thread to discover it's status and will be able to see directly on the thread list. The indicator can be a picture or plain text.

Suggestions to improve the scripts are fully welcomed on the talkpage. Please also let me know of any bugs as well and I will endeavour to fix them as quickly as possible!

Note: If your wiki has already been converted to use the Discussions feature, and you no longer can enable Special:Forum on your wiki, do not enable this script on your wiki, as /d already includes visible indicators of thread status.

Installation

Add this JavaScript on your wiki:

Global Personal Site-wide
w:Special:Mypage/global.js Special:Mypage/common.js MediaWiki:Common.js
importArticles({
    type: "script",
    articles: [
        "u:dev:MediaWiki:ThreadIndicator/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.


You can also use the ImportJS page on your wiki, but note that it only provides the ability to import the base script with no configuration available. To import using ImportJS, simply add the following to the page: dev:ThreadIndicator/code.js

Configuration

There are some configuration options provided for this script. However, if you don't want to change the configuration from the default, you do not need to use them, and they're provided only for completeness and choice:

Variable name Description Default value
usepics A true/false variable that determines whether images should be used as the indicator. true
padlockImage A URL to an image that will be used as the indicator of a "closed" discussion thread Padlock.png
padlockTitle The text that will be used on the tooltip for the "closed" image above. This thread is closed to new posts
padlockText A plain text output that will be used as the indicator of a "closed" discussion thread. This is also used as the "alternate" text if the picture doesn't load. (Locked)
highlightImage A URL to an image that will be used as the indicator of a "highlighted" discussion thread. Highlighted.png
highlightTitle The text that will be used on the tooltip for the "highlighted"" image above. This thread is highlighted
highlightText A plain text output that will be used as the indicator of a "highlighted" discussion thread. This is also used as the "alternate" text if the picture doesn't load. (Highlighted)

The syntax for using these configuration options goes like this:

window.ThreadIndicator = {
    usepics: true/false,
    padlockImage: "",
    padlockTitle: "",
    padlockText: "",
    highlightImage: "",
    highlightTitle: "",
    highlightText: ""
};

Note that you only need to define the fields you wish to change from the defaults, and they may be defined in any order. However, this definition must precede the importArticles() call!

Updates

3rd June 2016
Initial Release (v1.0.0). — SuperSajuuk

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.