Extension:Uniwiki Generic Edit Page

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
Uniwiki Generic Edit Page

Release status: experimental

Implementation Page action, Skin, Ajax
Description Suppliments the edit page with something more usable
Author(s) Merrick Schaefer,
Mark Johnston,
Evan Wheeler,
Adam Mckaig (Uniwikitalk)
Last version 0.1 (2008-07-18)
MediaWiki 1.12.0
License GPLv3
Download From Subversion
Parameters

$wgSectionBox, $wgCategoryBox, $wgAddSection, $wgAddCategory, $wgSuggestCategory, $wgSuggestCategoryRecipient

Hooks used
BeforePageDisplay

EditPage::showEditForm:fields
SkinTemplateOutputPageBeforeExec
SkinTemplateSetupPageCss
SkinTemplateOutputPageBeforeExec
EditPage::attemptSave
EditPage::showEditForm:initial

Extension (Results)
1.13.5 1.14.0 trunk
r49205
MediaWiki 1.13.5 - Partial -
1.14.0 - Partial -
trunk
r49205
- - Yes
Configure Supported from 1.15.
MediaWiki Testing
Check usage and version matrix
Bugs: list open list all report

Contents

What can this extension do? [edit]

This extension is primarily focused on increasing the usability of MediaWiki's user interface. It replaces the default editing page of Mediawiki with a section-based editor, designed to substantially simplify the editing process for beginners without forcing experienced users to use a "dumbed-down" editor. Although the extension is very much a work in progress, the changes have been refined by feedback from iterative usability testing, and significantly improve the editing process - especially in conjunction with the other Uniwiki extensions.

More Specifically... [edit]

The extension first breaks the page up into sections based on level one and level two headers (=h1= and ==h2==). It provides an text input for the header titles and a text area for the text below that header so that they can be edited easily. The extension also allows for the deletion of sections on the page by deselecting the checkbox for that section in the right-hand margin. These sections (the labels of the checkboxes) can also be clicked and dragged to reorder the sections on the page. New sections can be added to the page via the input box under the section box in the right-hand margin. New sections appear at the end of the page and the titles default to level 2 headers (i.e. == section title ==). A list of all categories is displayed in the right-hand margin and can be added or deleted from the page via the associated checkboxes. New categories can be addded via an input box in the right-hand margin. There is a button for switching between this mode and the original MediaWiki editing interface if one wishes to go back and see the raw wiki markup. The functionality of this extension is further "extended" via the Uniwiki Layouts extension and is explained therein.

Installation [edit]

Create a subdirectory in your extensions directory:
(we do this to make it easy to distribute all Uniwiki extensions as a bundle)

cd /your/wiki/extensions
mkdir uniwiki

Download the extension and its dependencies using subversion:

cd /your/wiki/extensions/uniwiki
svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/uniwiki/Javascript
svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/uniwiki/MooTools12core
svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/uniwiki/GenericEditPage

Add the following to LocalSettings.php:

require_once("$IP/extensions/uniwiki/Javascript/Javascript.php");
require_once("$IP/extensions/uniwiki/MooTools12core/MooTools12core.php");
require_once("$IP/extensions/uniwiki/GenericEditPage/GenericEditPage.php");

Configuration parameters [edit]

$wgSectionBox      = true;  # (bool) Controls the visibility of the Section Box in the right-hand margin
$wgCategoryBox     = true;  # (bool) Controls the visibility of the Category Box in the right-hand margin
$wgAddSection      = true;  # (bool) Allow visitors to add a new section to the page via an input in the right-hand margin
$wgAddCategory     = true;  # (bool) Allow visitors to add categories to the page via an input in the right have margin
$wgSuggestCategory = false; # (bool) Provide a form for visitors to suggest a new category via a field in the right hand margin
# note: The $wgAddCategory and $wgSuggestCategory can be enabled at the same time, although it doesn't really make sense to do so.

$wgSuggestCategoryRecipient = $wgEmergencyContact; # (string) The recipient of the emails about category suggestions

$wgUseCategoryPage          = false; # (bool) Get a list of Categories from $wgCategoryPage
$wgCategoryPage             = "MediaWiki:Editpagetags"; # (string) The page where you can define a list of categories that will be used when $wgUseCategoryPage is set to true
$wgRequireCategory          = false; # (bool) Does a user have to select (at least) one category?
$wgAllowSimilarTitles       = true; # (bool) If false, sections with a title that's already in use will not be saved

Installing the entire Uniwiki bundle [edit]

Download all of the Uniwiki extensions using Subversion:

cd /your/wiki/extensions
svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/uniwiki uniwiki

Add the following to LocalSettings.php:

# uniwiki
# =======
$uw = "$IP/extensions/uniwiki";
require_once("$uw/CssHooks/CssHooks.php");
require_once("$uw/Javascript/Javascript.php");
require_once("$uw/MooTools12core/MooTools12core.php");
require_once("$uw/AutoCreateCategoryPages/AutoCreateCategoryPages.php");
require_once("$uw/GenericEditPage/GenericEditPage.php");
require_once("$uw/CatBoxAtTop/CatBoxAtTop.php");
require_once("$uw/CustomToolbar/CustomToolbar.php");
require_once("$uw/Layouts/Layouts.php");
require_once("$uw/Authors/Authors.php");
require_once("$uw/CreatePage/CreatePage.php");

Internationalizing Uniwiki extensions [edit]

The Uniwiki extensions are available in several languages already, and it is very easy to add a new language. Each extension that has interface text includes a .i18n file with the internationalized system messages. Follow the instructions here to add the new language to the file.

See also [edit]

Sites using uniwiki extensions
Other extensions from the Uniwiki bundle