FANDOM


AddInsights is a script that assists you in adding your own insights to your wiki, like linking to categories like

  • Anti-bias Cleanup
  • Grammatical Improvement
  • General Improvement

Installation

See also: Help:Including additional CSS and JS, Help:Advanced CSS and JS
  • For site-wide use, an administrator can add the line below to the wiki's MediaWiki:ImportJS page. Note that JavaScript must be enabled on the wiki.
dev:AddInsights/code.js
  • For personal use, add the code snippet below to your global.js page (for use on all wikis) or your common.js page on your wiki (for use on a single wiki). Note that personal JS must be enabled for your account.
importArticles({
    type: 'script',
    articles: [
        'u:dev:AddInsights/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.

Configuration

In your wiki's MediaWiki:Common.js page, add this code snippet:

ItemsToAdd = [
  {
    'Name': 'Sample Page',
    'Page': '',
    'Description': 'You should edit this'
  },
];
AffectsSidebar = true;

AffectsSidebar

  • Setting this to true will enable the custom insights to be displayed on the Wiki Activity page sidebar.
  • Setting this to false will disallow the custom insights to be displayed on the Wiki Activity page sidebar.

ItemsToAdd

This array is where you place all of your custom insights. A sample is already included so you can easily get started. But, what if you wanted to add another? To do this, you just need to copy and paste the sample insight, like this:

ItemsToAdd = [
  {
    'Name': 'Sample Page',
    'Page': '',
    'Description': 'You should edit this'
  },
  {
    'Name': 'Sample Page',
    'Page': '',
    'Description': 'You should edit this'
  },
];

You can add as many of these as you'd like.

Name
This value specifies the insight's display name. If no name is specified, it's placeholder is [ Unnamed ].
Page
This value specifies the page that the insight links to. Wiki interlinking is supported.
Description
This value specifies the description that is shown on the "More Insights" page. If unspecified, it's placeholder is [ No Description ].
Override
If this option is set to true, it will appear in the sidebar regardless of AffectsSidebar option.

Example

Here's an example configuration:

ItemsToAdd = [
  {
    'Name': 'General Improvement',
    'Page': 'Category:General_Improvement',
    'Description': 'These articles need some cleanup work done on them.'
  },
  {
    'Name': 'Grammatical Cleanup',
    'Page': 'Category:Grammar_Cleanup',
    'Description': 'These articles need to be checked for grammar mistakes.'
  },
];
AffectsSidebar = true;

Notes

User talk:UncoveredAgent200 Think this page needs an edit? Leave me a message on my wall and make the suggestion there.

The source is at MediaWiki:AddInsights.js. If you have any improvement suggestions, don't be afraid to message me about that either.

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.