Extension:ArticleIndex

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
ArticleIndex

Release status:Extension status beta

ImplementationTemplate:Extension#type Tag
DescriptionTemplate:Extension#description Extension appends clickable index of tagged words in an article.
Author(s)Template:Extension#username Josef Martiňák (Jossmarttalk)
Latest versionTemplate:Extension#version 0.4.0 (2014-04-01)
MediaWikiTemplate:Extension#mediawiki 1.17+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0
Download
ExampleTemplate:Extension#example Here
TagsTemplate:Extension#tags

  • <aindex></aindex>
  • <articleindex/>
Hooks usedTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
BeforePageDisplayManual:Hooks/BeforePageDisplay

Translate the ArticleIndex extension if it is available at translatewiki.net

Check usage and version matrix.

The ArticleIndex Extension appends clickable index of tagged words in an article.

Usage[edit]

  • Put the words you want to index to <aindex></aindex> tag.
  • Words in these tags are displayed instead of tag <articleindex/> in alphabet order.
  • Index is grouped by first letters.
  • Clicking the word highlights his occurrences and moves page to the first one.
  • Navigation buttons appears on mouseover on tagged words.
  • It's case insensitive.

Download[edit]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/ArticleIndex/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/ArticleIndex.git

Installation[edit]

  • Download and place the file(s) in a directory called ArticleIndex in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/ArticleIndex/ArticleIndex.php";
    
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Release notes[edit]

Changes in version 0.4.0
  • Migrated I18n from php-files to json-files
Changes in version 0.3.0
  • Added files ArticleIndex.i18n.php and ext.ArticleIndex.css.
  • Indexed words are now case insensitive, they are shown in index in lowercase with first letter capitalized
  • New style of highlighted words
  • New feature - navigation buttons shows on mouseover (previous, next, index)
Changes in version 0.2.0
  • Code - spacey style
  • New function - clicking the word in index moves page to first occurrence of the word