Installation

Usage

When installed, a "CatNav" link will appear in the bottom wiki bar. Clicking it would lead you to Special:CatNav, where the feature is found.

CatNav's main component consists of 2 textareas, each is a whitespace-separated list of category names:

• An "Include" textarea: list here categories from which you'd like to collect pages for the navigation. A page will only be listed if it contains each one of the specified categories. You must specify at least 1 category
• An "Exclude" textarea: if you prefer not to list pages from certain categories, you can list them here. This textarea is optional, and you can leave it blank

When you're done, click the "generate" button. If results are found, they will be listed below CatNav's form, with each page represented by a square thumbnail with a title. If there are too many results, they would be divided into subpages.

In addition, there are some extra options:

• A "favorites" menu above the textareas lets you add frequently-used categories to your favorites. Whenever you enter CatNav in that specific wiki, you favorite categories would be loaded. Left-clicking a category adds it to the Include textarea, and right-clicking it adds it to the Exclude textarea. You can add new favorites and delete items from your favorites.
• Selecting the number of rows each navigation subpage has (the width is determined by your screen size)
• The option to list only mainspace pages, or pages from all namespaces (default is articles)
• Sorting options

Settings

The script always defines a window.CatNav object, with an init method for re-initializing its interface at any given time. You can use it as a function callback, or call CatNav.init at any given moment.

Debug mode

General console events are logged in a local array. If you're interested in them being displayed in the browser's console, add the following line above the import:

window.CatNav = {debug: true};

Events

You can use custom DOM events to know whenever something happens in CatNav's page. Each event is meant to be triggered by a specific element (using addEventListener or jQuery's .on(), for example). The available events are the following:

Global favorites

You can also set a list of favorite categories through the Community Central, through Special:MyPage/catnav.css. Pressing the "import" button would import all favorite categories associated with the current wiki to the local storage in your device (but for changing the global settings, you'd have to edit the global page).

Note that if you already have favorite categories in a given wiki and then press the "import" button, it would not delete favorite categories that do not appear in your global settings for the given wiki, but will just add categories that weren't favorite beforehand.

The syntax is the following:

  a line that starts with space(s) is a comment. you can also leave a line empty

  to declare favorite categories first declare the wiki that they belong to
  to do that, start a line with a '@', followed by the wiki's subdomain
  (use the '<lang>.' prefix if needed)
@clubpenguin
  any category below this line will be from [[w:c:clubpenguin]]
  to declare a category, start a line with a '#'
#Clothing
  the upper line is related to [[w:c:clubpenguin:Category:Clothing]]
#Puffles
#Parties
#Characters/Penguin Band
  ^ you can also use subcategories


  to declare categories for another wiki, re-declare the subdomain. e.g., the Spanish Runescape Wiki:
@es.runescape
#Armaduras Híbridas

Notes

• You can declare the same wiki twice, but it's advisable to save all the categories for each wiki together, for an easier category managing.
• Make sure not to list categories without declaring their associated wikis first.
• Make sure that the declared wiki's subdomain is valid. Invalid URL characters will result in an error, but merely invalid wiki subdomains may silently get through.
• Comments can be written by starting the line with any character other than "@" or "#", but please only use spaces as comment line starters, to reserve other characters for possible future updates. Using other characters for comments could create an unexpected behavior in the future.

In case the wiki on which you store your favorite categories imports/exports (more info on the global favorites section) is not the Community Central, you can define that in the following manner:

window.CatNav = window.CatNav || {};
window.CatNav.storage = [wikiUrl, scriptPath];

• wikiUrl is the full wiki URL (e.g. "https://community.fandom.com")
• scriptPath is the URL path to scripts on that wiki (empty string in the case of Fandom). You can check it with wgScriptPath

Note that CatNav's functionality relies on Fandom's API, so it will currently not work with non-Fandom wikis (e.g. Wikimedia wikis, such as Wikipedia and Commons).

Credits and special thanks

• Chiến Thần Vương - suggested adding sorting options and favorite categories, as well as submitting a few small script tweaks
• Dai ca superman - for sending multiple crucial bug reports
• RianL110 - for sending bug reports
• Aspallar - notifying and providing an API syntax fix for the when UCP is implemented
• CrescentHusky12 - sending bug report related to non-alphabetic sorting methods
• Magiczocker - implementing i18n & major cleanup

Changelog