Extension:MagicNumberedHeadings

MediaWiki extensions manual - list

MagicNumberedHeadings Release status: stable
Implementation	Extended syntax
Description	Adds MagicWord __NUMBEREDHEADINGS__ to force autonumbering of the headings of a page
Author(s)	Purodha Blissenbach (Purodhatalk)
Last version	1.11 (2007-09-06)
MediaWiki	1.11+
License	GPL
Download	Code
Example	KrefeldWiki
Hooks used ParserBeforeInternalParse MagicWordwgVariableIDs MagicWordMagicWords LanguageGetMagic
Check usage and version matrix

The MagicNumberedHeadings extension adds MagicWord __NUMBEREDHEADINGS__ to force autonumbering of the headings of a page. I was created so as to resolve bug 3254.

This extension adds a Magic Word __NUMBEREDHEADINGS__ to the parser. If an article contains this MagicWord, automatic numbering of the headings in this page is performed, regardless of the user preference setting.

Usage

• Add "__NUMBEREDHEADINGS__" to any article.

Installation

Download the code, see below, into this file:

$IP/extensions/MagicNumberedHeadings/MagicNumberedHeadings.php

Note, $IP is the MediaWiki installation directory.

Parameters

None - beyond multilingual (i18n) versions of the MagicWord.

Changes to LocalSettings.php

Add this line towards the end of your $IP/LocalSettings.php

require_once($IP.'/extensions/MagicNumberedHeadings/MagicNumberedHeadings.php');

Note, $IP is the MediaWiki installation directory.

Code

<?php
/**
 * @copyright Copyright © 2007, Purodha Blissenabch.
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, version 2
 * of the License.
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * See the GNU General Public License for more details.
 */
 
/**
 * This extension realizes a new MagicWord __NUMBEREDHEADINGS__.
 * If an article contains this MagicWord, numbering of the
 * headings is performed regardless of the user preference setting.
 * 
 * How to use:
 * * include this extension in LocalSettings.php: 
 *   require_once($IP.'/extensions/MagicNoNumberedHeadings.php');
 * * Add "__NUMBEREDHEADINGS__" to any article of your choice.
 * 
 * @author Purodha Blissenbach
 * @version $Revision: 1.11
 */
 
if (!defined('MEDIAWIKI')) {
        die("This requires the MediaWiki enviroment.");
}
 
$wgExtensionCredits['parserhook'][] = array(
        'name' => 'MagicNumberedHeadings',
        'version' => '1.11',
        'author' => 'Purodha Blissenbach',
        'url' => 'https://www.mediawiki.org/wiki/Extension:MagicNumberedHeadings',
        'description' => 'Adds MagicWord "<nowiki>__NUMBEREDHEADINGS__</nowiki>"',
);
$wgHooks['MagicWordMagicWords'][] = 'MagicNumberedHeadingsMagicWordMagicWords';
$wgHooks['MagicWordwgVariableIDs'][] = 'MagicNumberedHeadingsMagicWordwgVariableIDs';
$wgHooks['LanguageGetMagic'][] = 'MagicNumberedHeadingsLanguageGetMagic';
$wgHooks['ParserBeforeInternalParse'][] = 'MagicNumberedHeadingsParserBeforeInternalParse';
 
function MagicNumberedHeadingsMagicWordMagicWords(&$magicWords)
{
        $magicWords[] = 'MAG_NUMBEREDHEADINGS';
        return true;
}
 
function MagicNumberedHeadingsMagicWordwgVariableIDs(&$wgVariableIDs)
{
        $wgVariableIDs[] = MAG_NUMBEREDHEADINGS;
        return true;
}
 
function MagicNumberedHeadingsLanguageGetMagic(&$magicWords, $langCode)
{
        switch($langCode)
        {
                case 'de' :
                        $magicWords[MAG_NUMBEREDHEADINGS] = array( 0, '__ÜBERSCHRIFTENNUMMERIERUNG__', '__NUMBEREDHEADINGS__' );
                        break;
                case 'ksh' :
                        $magicWords[MAG_NUMBEREDHEADINGS] = array( 0, '__ÖVVERSCHRIFTENUMMERIERE__', '__NUMBEREDHEADINGS__' );
                        break;
                default :
                        $magicWords[MAG_NUMBEREDHEADINGS] = array( 0, '__NUMBEREDHEADINGS__' );
        }
        return true;
}
 
function MagicNumberedHeadingsParserBeforeInternalParse($parser, $text, $stripState)
{
        if (MagicWord::get( MAG_NUMBEREDHEADINGS )->matchAndRemove( $text ) )
        {
                $parser->mOptions->mNumberHeadings = (TRUE);
        }
        return true;
}

Wikis using the extension

• KrefeldWiki

See also

Related extensions:

• Extension:MagicNoNumberedHeadings
• Extension:PSINoTocNum

Bugzilla:

• Bug 3254