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

Importing multiple scripts? This quick guide shows how to combine the imports.
  • For site-wide use, an administrator can add the line below to the wiki's MediaWiki:ImportJS page.
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:MediaWiki:AddInsights/code.js',
    ]
});

Configuration

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

window.ItemsToAdd = [
  {
    'Name': 'Sample Page',
    'Page': '',
    'Description': 'You should edit this'
  },
];
window.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:

window.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:

window.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.'
  },
];
window.AffectsSidebar = true;

Notes

Think this page needs an edit? Leave me a message on my talk page.

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

Community content is available under CC-BY-SA unless otherwise noted.