Extension:IndexFunction
This extension is currently not actively maintained! Although it may still work, any bug reports or feature requests will more than likely be ignored. If you are interested in taking on the task of developing and maintaining this extension, you can request repository ownership. As a courtesy, you may want to contact the author. You should also remove this template and list yourself as maintaining the extension in the page's {{extension}} infobox. |
 Release status: unmaintained |
|
|---|---|
 |
|
| Implementation | Parser function, Special page |
| Description | Parser function to create automatic redirects and disambiguation pages |
| Author(s) | Alex Zaddach (Mr.Z-mantalk) |
| Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
| MediaWiki | |
| Database changes | Yes |
| License | GNU General Public License 3.0 |
| Download | |
| Translate the IndexFunction extension if it is available at translatewiki.net | |
| Issues | Open tasks · Report a bug |
The IndexFunction extension provides a parser function that allows to create automatic redirects and disambiguation pages.
UsageEdit
To use the extension, tag pages with {{#index:Index1|Index1|...}}, where "Index1," "Index1", etc. are the titles you wish to index the current page as. (Think of the index in a book, which may contain For X see Y). This will cause Index1 and Index1 to automatically redirect to the page from links and searches. Multiple pages can share the same indexes, instead of redirecting to the page, the titles will redirect to an automatically generated disambiguation page. The page will sort the articles into headings based on the categories that the pages are in.
Titles used as indexes have a couple restrictions - they cannot also exist as pages (if a page is created at the same title as an index, the index will be deleted from the database) and they must be valid page titles.
The appearance of internal links to index titles can be customized using CSS, all links will contain the "mw-index" class.
InstallationEdit
- Download and place the file(s) in a directory called
IndexFunctionin yourextensions/folder. - Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/IndexFunction/IndexFunction.php";
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration parametersEdit
There is one configuration variable and one message that should be configured per-site.
$wgSpecialIndexContext: Used to set the context given on Special:Index auto-disambig pages, can be 1 of 2 options:'extract'(default) - Show an extract from the start of the article'categories'- Show a comma-separated list of categories the article is in
- MediaWiki:index-exclude-categories is used by the automatic disambiguation page to filter out certain categories that should not be used to sort articles, such as maintenance categories and other categories not related to the subject. The format of the page is to put each category on a line, without the category prefix, i.e.
Pages needing cleanup Pages needing proofreading