|
|
| Zeile 1: |
Zeile 1: |
| − | <big>'''Peilsender - MediaWiki'''</big>
| + | {{InstallationNav}} |
| − | {{interface message}}
| + | Welcome to the '''[[MediaWiki]] installation guide''' which provides instructions on how to manually install and configure MediaWiki on a web server. Note that some users may find MediaWiki [[software appliances]] a convenient alternative to manual installation. |
| | | | |
| − | [[Image:Example sidebar.png|thumb|Sidebar example]]
| + | The first part of this guide gives broad general instructions, while the last section contains a list of appendices that give more detailed installation notes for specific system configurations and other less common uses of the software. |
| − | '''[[MediaWiki:Sidebar]]''' defines the navigation bar, which provides links to the most important locations in the wiki and supplies site administrators with a place to add a persistent collection of links. For instance, most wikis will link to their community discussion page and some useful tools.
| |
| | | | |
| − | The default Monobook [[Manual:Skins|skin]] places the navigation bar on the top-left (top-right for right-to-left languages) along with the search bar and toolbox, but the placement may be different in other skins.
| + | == Quick installation guide == |
| | | | |
| − | ==Customize the sidebar==
| + | For experienced users only, here is the quick version of the installation instructions. Most users will want to read the more detailed version, [[#Main installation guide|below]]. |
| − | As an administrator, [[Help:Editing|edit]] the wiki page "[[MediaWiki:Sidebar]]". (The ''editinterface'' permission needs to be enabled and is enabled for administrators by default; for information on assigning it to other groups, see [[Manual:User rights]].) You may need to use the syntax ''//yourdomain/yourwiki/index.php?title=MediaWiki:Sidebar&action=edit'' if you use long URLs.
| |
| | | | |
| − | If you are sure you are logged in with the relevant rights but do not see the ''edit'' link, click on the ''create'' tab at the top of the page - this will take you to the edit page.
| + | # Check that your system meets the [[Manual:Installation requirements|minimum requirements]] (web server, PHP5, and either MySQL4 or PostgreSQL 8.0). |
| | + | # [[Download|Download MediaWiki]] <small>{{MW stable release link|(direct link to latest version)}}</small> and extract the archive to a web-accessible folder on your server. |
| | + | # Point your browser to the <code>config</code> directory (e.g., <tt>http://localhost/mediawiki/config/index.php</tt>). |
| | + | # [[Manual:Config script|Follow the on-screen instructions]] to complete the process. |
| | | | |
| − | Example sidebar code:
| + | These instructions are deliberately brief. There is a lot that could go wrong, so if in any doubt, you are advised to read the full instructions below. |
| − | [[Image:Example sidebar.png|thumb|Sidebar example]]
| |
| − | <pre>
| |
| − | * navigation
| |
| − | ** mainpage|mainpage
| |
| − | ** Special:Recentchanges|Recent changes
| |
| − | * new heading
| |
| − | ** portal-url|portal
| |
| − | ** http://www.mediawiki.org|MediaWiki home
| |
| − | </pre>
| |
| | | | |
| − | ===Headings=== | + | == Main installation guide == |
| − | The navigation bar can be split into sections, each with a heading of its own. The heading for each section is taken from the first-level list element ("navigation" and "new heading" in the example above).
| |
| | | | |
| − | If this text corresponds to the name of an interface message (an existing page of that title in the MediaWiki namespace), then the text of that page is used as a label; otherwise, the header title is used as-is.
| + | * Before installation |
| | + | ** [[Manual:What is MediaWiki?|Read what MediaWiki is]] |
| | + | ** [[Manual:MediaWiki feature list|Check the MediaWiki feature list]] |
| | + | ** [[Manual:Installation requirements|Installation requirements]] - Check these before going any further! |
| | + | * [[Manual:Installing MediaWiki|Installing MediaWiki]] |
| | + | * Configuring MediaWiki: |
| | + | ** [[Manual:Config script|Initial configuration]] (using the configuration script) |
| | + | ** [[Manual:Configuring MediaWiki|Further configuration]] |
| | + | ** [[Manual:Extensions|Installing extensions]] |
| | | | |
| − | '''Bug:''' only the first section will be shown in the Classic, Cologne Blue, and Simple skins ([[bugzilla:2557|bug 2557]]).<br />
| + | == Appendices == |
| − | '''Bug:''' no sidebar is shown in the Nostalgia skin ([[bugzilla:10794|bug 10794]]).
| |
| | | | |
| − | ===Links=== | + | === Advanced uses === |
| − | Second-level list elements are links ("mainpage|mainpage" in the example above), where the format is:
| + | The following pages give instructions about how to install/configure MediaWiki for other, less common purposes. |
| − | <pre>** target|link text</pre>
| + | * [[Download from SVN|Installing from Subversion]] |
| | + | * [[Manual:Wiki on a stick|Installing MediaWiki on a memory stick]] |
| | | | |
| − | ; target
| + | === Advanced configuration === |
| − | : The link target can be the name of an interface message (page in the MediaWiki namespace) or wiki page, or an external link. In either case, the [[Help:Links|link]] can be internal, interwiki, or external. In some cases (such as links with the "&" character), an interface message is necessary. The link target cannot be made dependent on the interface language set in the preferences.
| |
| | | | |
| − | :Algorithm followed:
| + | The following pages cover some of the more advanced configuration options: |
| − | :# Get the target text.
| + | * [[Manual:Configuration|Advanced configuration]] |
| − | :# If there is an existing or default interface message with that name, use the content of that message instead of the target text. | + | * [[Manual:Administrators|Wiki administration]] |
| − | :# If the output from the previous step is a valid url (beginning with http:// or other [[Manual:$wgUrlProtocols|url protocol]]), the link will point to that url.
| |
| − | :# Else, it will treat it as the link target of a wikilink (linking to that page name or interwiki). | |
| − | :# In case it would end up linking to '-', the whole entry is removed from the sidebar (that's useful for removing an entry on all languages by changing the message holding the link).
| |
| | | | |
| | + | === MediaWiki Help === |
| | + | The following page explains how to get a copy of the MediaWiki help pages on your own wiki |
| | + | * [[Project:PD help/Copying|Copying help pages]] |
| | | | |
| − | : Examples:
| + | === System-specific instructions === |
| − | :* "<code>** '''portal-url'''|portal</code>" uses the text of [[MediaWiki:Portal-url]] (which contains "{{MediaWiki:Portal-url}}").
| |
| − | :* "<code>** '''Special:Recentchanges'''|Recent changes</code>" links to [[Special:Recentchanges]], since there is no interface message of that name.
| |
| − | :* "<code>** '''w:Foo'''|Some interwiki page</code>" links to [[w:Foo]] for the same reason.
| |
| − | :* "<code>** '''http://www.mediawiki.org'''|MediaWiki home</code>" links to http://www.mediawiki.org for the same reason.
| |
| | | | |
| | + | The following pages give more detailed installation instructions aimed at specific systems: |
| | | | |
| − | ; text
| + | * [[Manual:Running MediaWiki on FreeBSD|FreeBSD]] |
| − | : The link text can be the name of an interface message (page in the MediaWiki namespace) or plain text. | + | * [[Manual:Running MediaWiki on Linux|GNU/Linux]] |
| − | :* If the link text is the name of an existing or default interface message, the content of that message will be used. MediaWiki will check for localized versions; for example, if the current language is fr (French) and the link text is the interface message "forum", it will check for "forum/fr" before using "forum". | + | ** [[Manual:Running MediaWiki on Debian GNU/Linux|Debian]] |
| − | :* Otherwise, the link text is used as the target as-is. | + | ** [[Manual:Running MediaWiki on Fedora|Fedora]] |
| − | :* Notice that the link text is '''not''' optional as in normal wiki links. If the link text is missing, <u>the item is ignored</u>. | + | ** [[Manual:Running MediaWiki on Gentoo Linux|Gentoo]] |
| | + | ** [[Manual:Running MediaWiki on Mandriva|Mandriva]] |
| | + | ** [[Manual:Running MediaWiki on Red Hat Linux|Red Hat Enterprise Linux]] |
| | + | ** [[Manual:Running MediaWiki on Slackware Linux|Slackware]] |
| | + | ** [[Manual:Running MediaWiki on SuSE Linux 9.3|SuSE 9.3]] |
| | + | ** [[Manual:Running MediaWiki on Ubuntu|Ubuntu]] |
| | + | ** [[Manual:Running MediaWiki on Damnsmalllinux|Damnsmalllinux]] |
| | + | * [[Manual:Running MediaWiki on Mac OS X|Mac OS X]] |
| | + | * [[Manual:Running MediaWiki on NetWare|NetWare]] |
| | + | * [[Manual:Running MediaWiki on Solaris|Solaris]] |
| | + | ** [[Manual:Running MediaWiki on Solaris 10|Solaris 10]] |
| | + | ** [[Manual:Running MediaWiki on Solaris 9|Solaris 9]] |
| | + | * [[Manual:Running MediaWiki on Windows|Windows]] |
| | + | ** [[Manual:Installing MediaWiki on Windows XP|Windows XP]] |
| | + | ** [[Manual:Installing MediaWiki on Windows Server 2003|Windows Server 2003]] |
| | + | ** [[Manual:Installing MediaWiki on Windows Server 2008|Windows Server 2008]] |
| | + | ** [[Manual:Newcomers guide to installing on Windows|Newcomers guide]] |
| | + | ** [[Manual:Streamlined Windows Install Guide|Streamlined Guide]] |
| | + | ** [[Manual:Simple Windows Apache Installation|Simple Windows Apache Installation]] |
| | | | |
| − | : Examples:
| + | == See also == |
| − | :* <code>** mainpage|'''mainpage'''</code> uses [[MediaWiki:Mainpage]] (which contains "{{:MediaWiki:Mainpage}}").
| |
| − | :* <code>** Special:Recentchanges|'''Recent changes'''</code> uses "Recent changes", since there is no interface message of that name.
| |
| | | | |
| − | ===Order of elements===
| + | * [[Software appliances|MediaWiki software appliances]] |
| − | By default, the sidebar consists of elements in this order: navigation, search, toolbox, languages. The order can be changed (in [[rev:37232|MediaWiki 1.13+]]) by adding special keywords (SEARCH, TOOLBOX and LANGUAGES) to [[MediaWiki:Sidebar]] using the heading syntax. For example, the following code moves the search box to the top of the sidebar:
| + | * [[Manual:Before installing| Before installing]] |
| − | <pre>
| + | * [[Manual:Upgrading|Upgrading]] |
| − | * SEARCH | + | * [[Manual:Uninstallation|Uninstallation]] |
| | + | * [[Manual:FAQ|FAQ]] |
| | | | |
| − | * navigation
| + | {{Languages|Manual:Installation guide}} |
| − | ** mainpage|mainpage
| + | [[Category:Installation|{{PAGENAME}}]] |
| − | ** Special:Recentchanges|Recent changes
| |
| − | * new heading
| |
| − | ** portal-url|portal
| |
| − | ** http://www.mediawiki.org|MediaWiki home
| |
| − | </pre>
| |
| − | | |
| − | ==Advanced customization==
| |
| − | The sidebar can be fully customized by implementing [[w:JavaScript|JavaScript]] or [[w:Cascading Style Sheets|Cascading Style Sheets]], or by editing the [[w:PHP|PHP]] files directly. Before using these methods, note that:
| |
| − | * JavaScript is fragile: it will not work for users with JavaScript disabled, and scripts frequently fail in different browsers or skins.
| |
| − | * Editing the PHP files can easily cause unexpected errors, and your changes will be lost in the next update unless you manually change the new files.
| |
| − | | |
| − | ===Force UI-messages to follow content===
| |
| − | Some pages should sometimes follow the content language, especially for multilingual sites. This can be controlled with the setting [[Manual:$wgForceUIMsgAsContentMsg|$wgForceUIMsgAsContentMsg]]. Each message overridden in this way must be explicitly given, for example to let the sidebar link to versions given by the content language for the main page and the portal page add the following to <code>LocalSettings.php</code>
| |
| − | ; code
| |
| − | <div style="margin-left:2em;"><source lang="javascript">
| |
| − | $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
| |
| − | </source></div>
| |
| − | | |
| − | ===Add or remove sections (JavaScript)===
| |
| − | The ''toolbox'', which appears ''under'' the search bar, is a dynamic element and cannot be easily customized without the use of skinning extensions (otherwise it requires programming in PHP.) If you still want to do so, you can copy skins/MonoBook.php, creating a new [[skins|skin]]. You can then make a custom skin to generate these links in your preferred fashion.
| |
| − | | |
| − | Another javascript solution is below.
| |
| − | | |
| − | For this solution to work on the entire mediawiki site, this script has to be copied to [[MediaWiki:Common.js]] ([[MediaWiki:Common.js]] is available for Mediawiki 1.9 +).
| |
| − | | |
| − | For this solution to work only for a specific user, add this script to [[Special:Mypage/monobook.js]] (or another js-page, depending on your prefered [[meta:Help:User style|skin]]).
| |
| − | | |
| − | Now simply configure which link should appear in which section. You also can remove some links if you want to.
| |
| − | | |
| − | ; code
| |
| − | <div style="margin-left:2em;"><source lang="javascript">
| |
| − | function ModifySidebar(action, section, name, link) {
| |
| − | try {
| |
| − | switch (section) {
| |
| − | case "languages":
| |
| − | var target = "p-lang";
| |
| − | break;
| |
| − | case "toolbox":
| |
| − | var target = "p-tb";
| |
| − | break;
| |
| − | case "navigation":
| |
| − | var target = "p-navigation";
| |
| − | break;
| |
| − | default:
| |
| − | var target = "p-" + section;
| |
| − | break;
| |
| − | }
| |
| − | | |
| − | if (action == "add") {
| |
| − | var node = document.getElementById(target)
| |
| − | .getElementsByTagName('div')[0]
| |
| − | .getElementsByTagName('ul')[0];
| |
| − | | |
| − | var aNode = document.createElement('a');
| |
| − | var liNode = document.createElement('li');
| |
| − | | |
| − | aNode.appendChild(document.createTextNode(name));
| |
| − | aNode.setAttribute('href', link);
| |
| − | liNode.appendChild(aNode);
| |
| − | liNode.className='plainlinks';
| |
| − | node.appendChild(liNode);
| |
| − | }
| |
| − | | |
| − | if (action == "remove") {
| |
| − | var list = document.getElementById(target)
| |
| − | .getElementsByTagName('div')[0]
| |
| − | .getElementsByTagName('ul')[0];
| |
| − | | |
| − | var listelements = list.getElementsByTagName('li');
| |
| − | | |
| − | for (var i = 0; i < listelements.length; i++) {
| |
| − | if (listelements[i].getElementsByTagName('a')[0].innerHTML == name ||
| |
| − | listelements[i].getElementsByTagName('a')[0].href == link) {
| |
| − | | |
| − | list.removeChild(listelements[i]);
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | | |
| − | } catch(e) {
| |
| − | // lets just ignore what's happened
| |
| − | return;
| |
| − | }
| |
| − | }
| |
| − | | |
| − | function CustomizeModificationsOfSidebar() {
| |
| − | //adds [[Special:CategoryTree]] to toolbox
| |
| − | ModifySidebar("add", "toolbox", "CategoryTree", "http://en.wikipedia.org/wiki/Special:CategoryTree");
| |
| − | //removes [[Special:Upload]] from toolbox
| |
| − | ModifySidebar("remove", "toolbox", "Upload file", "http://en.wikipedia.org/wiki/Special:Upload");
| |
| − | }
| |
| − | | |
| − | addOnloadHook(CustomizeModificationsOfSidebar);
| |
| − | </source></div>
| |
| − | | |
| − | ; Usage
| |
| − | : <tt>function CustomizeModificationsOfSidebar()</tt> has to be customized for adding or removing links in specific sections:
| |
| − | | |
| − | : <tt>ModifySidebar("''action''", "''section''", "''name''", "''link''");</tt>
| |
| − | | |
| − | {| class="prettytable" style="margin-left:2em;"
| |
| − | ! parameter
| |
| − | ! value
| |
| − | |-
| |
| − | | <tt>action</tt>
| |
| − | | ''add'' to add a link; ''remove'' to remove a link
| |
| − | |-
| |
| − | | <tt>section</tt>
| |
| − | | ''navigation'', ''toolbox'', ''languages'' but also any other existing customized section; the given link will be added to or removed from this section
| |
| − | |-
| |
| − | | <tt>name</tt>
| |
| − | | contains the text of the link
| |
| − | |-
| |
| − | | <tt>link</tt>
| |
| − | | contains the URL of the link
| |
| − | |}
| |
| − | | |
| − | ; restricting modifications to specific usergroups
| |
| − | <div style="margin-left:2em;">
| |
| − | If you want to restrict the modification of the links to a specific usergroup (e.g. ''bureaucrat''), change
| |
| − | <source lang="javascript">addOnloadHook(CustomizeModificationsOfSidebar);</source>
| |
| − | to
| |
| − | <source lang="javascript">
| |
| − | if (isArray(wgUserGroups)) {
| |
| − | if (wgUserGroups.Contains('bureaucrat')) {
| |
| − | addOnloadHook(CustomizeModificationsOfSidebar);
| |
| − | }
| |
| − | }
| |
| − | </source>
| |
| − | and add
| |
| − | <source lang="javascript">
| |
| − | function isObject(obj) {
| |
| − | if (typeof obj == "object" && obj != null)
| |
| − | return true;
| |
| − | else
| |
| − | return false;
| |
| − | }
| |
| − | | |
| − | function isArray(obj) {
| |
| − | if (isObject(obj)) {
| |
| − | if (obj.constructor.toString().indexOf("Array") == -1)
| |
| − | return false;
| |
| − | else
| |
| − | return true;
| |
| − | }
| |
| − | else
| |
| − | return false;
| |
| − | }
| |
| − | | |
| − | Array.prototype.Contains = function(element,strict) {
| |
| − | for(i in this) {
| |
| − | if(this[i] == element && !strict) return true;
| |
| − | else if(this[i] === element) return true;
| |
| − | }
| |
| − | return false;
| |
| − | }
| |
| − | </source>
| |
| − | | |
| − | For restricting the modifications to IPs instead of a specific usergroup use
| |
| − | <source lang="javascript">
| |
| − | if (!isArray(wgUserGroups)) {
| |
| − | addOnloadHook(CustomizeModificationsOfSidebar);
| |
| − | }
| |
| − | </source>
| |
| − | </div>
| |
| − | | |
| − | ===Sidebar width (CSS)===
| |
| − | * '''Bug:''' only works with the default MonoBook skin.
| |
| − | | |
| − | You can change the width of your sidebar by adding the following CSS rules to your [[MediaWiki:Common.css]] article ([[MediaWiki:Monobook.css]] if pre 1.9), note that this is an '''article''' not a file. This changes the width to 15em, the actions position and portlet width should be an em or so less, so I've set them to 14em in this example.
| |
| − | <source lang="css">
| |
| − | #column-content { margin-left: -15em }
| |
| − | #column-content #content { margin-left: 15em }
| |
| − | #p-logo a, #p-logo a:hover { width: 15em }
| |
| − | .portlet { width: 14em }
| |
| − | #p-cactions { left: 14em }
| |
| − | </source>
| |
| − | | |
| − | ===Change sidebar content when logged in (PHP)===
| |
| − | To get anonymous users to have their own sidebars change <tt>includes/Skin.php</tt>. There is a function called <tt>buildSidebar</tt>. Edit this function to check for <tt>$wgUser->isLoggedIn()</tt> and call a different system message than <tt>sidebar</tt>.
| |
| − | | |
| − | <source lang="php">
| |
| − | if ($wgUser->isLoggedIn()) {
| |
| − | $lines = explode( "\n", wfMsgForContent( 'sidebar' ) );
| |
| − | } else {
| |
| − | $lines = explode( "\n", wfMsgForContent( 'anon_sidebar' ) );
| |
| − | }
| |
| − | </source>
| |
| − | | |
| − | Then in your Wiki, go to <tt>MediaWiki:anon_sidebar</tt> and create your new sidebar. You may need to add <tt>$wgUser</tt> to the list of global variables in the <tt>buildSidebar()</tt>.
| |
| − | | |
| − | You'll also have to add $wgUser in the globals declaration of the function.
| |
| − | | |
| − | A better solution is to modify the sidebar per hook. You don't have to change the Skin.php for this. Just create a simple extension like this one:
| |
| − | | |
| − | <source lang="php">
| |
| − | <?php
| |
| − | $wgHooks['SkinBuildSidebar'][] = 'efHideSidebar';
| |
| − | | |
| − | function efHideSidebar($skin, &$bar) {
| |
| − | global $wgUser;
| |
| − | // Hide sidebar for anonymous users
| |
| − | if (!$wgUser->isLoggedIn()) {
| |
| − | $url = Title::makeTitle(NS_SPECIAL, wfMsg('login'))->getLocalUrl();
| |
| − | $bar = array(
| |
| − | navigation => array(
| |
| − | array(text => 'Login',
| |
| − | href => $url,
| |
| − | id => 'n-login',
| |
| − | active => '')
| |
| − | )
| |
| − | );
| |
| − | }
| |
| − | return true;
| |
| − | }
| |
| − | </source>
| |
| − | | |
| − | ===Allow wiki markup (PHP)===
| |
| − | Many people on support desk have been asking about how to put arbitrary wikitext into the side bar. You can hack your ''skins/Monobook.php'' file (if you're using monobook) and replace the following section of code. <!-- May someone please update this? It seems that the code has changed... -->
| |
| − | ==== MediaWiki < 1.13.2 ====
| |
| − | Replace this:
| |
| − | <source lang=php>
| |
| − | <?php foreach ($this->data['sidebar'] as $bar => $cont) { ?>
| |
| − | <div class='portlet' id='p-<?php echo Sanitizer::escapeId($bar) ?>'<?php echo $skin->tooltip('p-'.$bar) ?>>
| |
| − | <h5><?php $out = wfMsg( $bar ); if (wfEmptyMsg($bar, $out)) echo $bar; else echo $out; ?></h5>
| |
| − | <div class='pBody'>
| |
| − | <ul>
| |
| − | <?php foreach($cont as $key => $val) { ?>
| |
| − | <li id="<?php echo Sanitizer::escapeId($val['id']) ?>"<?php
| |
| − | if ( $val['active'] ) { ?> class="active" <?php }
| |
| − | ?>><a href="<?php echo htmlspecialchars($val['href']) ?>"<?php echo ... </li>
| |
| − | <?php } ?>
| |
| − | </ul>
| |
| − | </div>
| |
| − | </div>
| |
| − | <?php } ?>
| |
| − | </source>
| |
| − | with this...
| |
| − | <source lang=php>
| |
| − | <?php
| |
| − | global $wgUser,$wgTitle,$wgParser;
| |
| − | $side = new Article(Title::newFromText('Sidebar',NS_MEDIAWIKI));
| |
| − | if (is_object($wgParser)) { $psr = $wgParser; $opt = $wgParser->mOptions; }
| |
| − | else { $psr = new Parser; $opt = NULL; }
| |
| − | if (!is_object($opt)) $opt = ParserOptions::newFromUser($wgUser);
| |
| − | $wikitext = "__NOEDITSECTION____NOTOC__\n";
| |
| − | $wikitext .= $side->fetchContent();
| |
| − | $html = $psr->parse($wikitext,$wgTitle,$opt,true,true)->getText();
| |
| − | echo preg_replace("/<li>\\s*<\\/li>/",'',$html);
| |
| − | ?>
| |
| − | </source>
| |
| − | | |
| − | | |
| − | If php4 on your sys
| |
| − | <source lang=php>
| |
| − | $html = $psr->parse($wikitext,$wgTitle,$opt,true,true);
| |
| − | $html = $psr->mOutput->getText();
| |
| − | </source>
| |
| − | | |
| − | ==== MediaWiki 1.13.2 ====
| |
| − | Replace this:
| |
| − | <source lang=php>
| |
| − | $sidebar = $this->data['sidebar'];
| |
| − | if ( !isset( $sidebar['SEARCH'] ) ) $sidebar['SEARCH'] = true;
| |
| − | if ( !isset( $sidebar['TOOLBOX'] ) ) $sidebar['TOOLBOX'] = true;
| |
| − | if ( !isset( $sidebar['LANGUAGES'] ) ) $sidebar['LANGUAGES'] = true;
| |
| − | foreach ($sidebar as $boxName => $cont) {
| |
| − | if ( $boxName == 'SEARCH' ) {
| |
| − | $this->searchBox();
| |
| − | } elseif ( $boxName == 'TOOLBOX' ) {
| |
| − | $this->toolbox();
| |
| − | } elseif ( $boxName == 'LANGUAGES' ) {
| |
| − | $this->languageBox();
| |
| − | } else {
| |
| − | $this->customBox( $boxName, $cont );
| |
| − | }
| |
| − | }
| |
| − | | |
| − | </source>
| |
| − | with this:
| |
| − | <source lang="php">
| |
| − | global $wgParser, $wgUser, $wgTitle;
| |
| − | if (!is_object($wgParser)) {
| |
| − | $wgParser = new Parser;
| |
| − | $opt = $wgParser->mOptions;
| |
| − | } | |
| − | if (!is_object($opt)) {
| |
| − | $opt = ParserOptions::newFromUser($wgUser);
| |
| − | } | |
| − | echo $wgParser->parse(wfMsgForContent( 'sidebar' ),$wgTitle,$opt,true,true)->getText();
| |
| − | $this->searchBox();
| |
| − | $this->toolbox();
| |
| − | $this->languageBox();
| |
| − | </source>
| |
| − | | |
| − | ==== Content of MediaWiki:Sidebar ====
| |
| − | That will allow the [[MediaWiki:Sidebar]] article to be proper wikitext. You will need to include the 'pBody' div tag to ensure the portlet is styled correctly, so your [[MediaWiki:Sidebar]] article will need to look something like the following example after the change:
| |
| − | <pre>
| |
| − | <div class="portlet">
| |
| − | <h5>Navigation</h5>
| |
| − | <div class='pBody'>
| |
| − | *[[Main Page]]
| |
| − | *[[Community portal]]
| |
| − | *[{{fullurl:Special:Recentchanges}} Recent changes]
| |
| − | *[[Sandbox]]
| |
| − | *[[Help]]
| |
| − | </div>
| |
| − | </div>
| |
| − | </pre>
| |
| − | | |
| − | ===Add a banner to the sidebar (PHP)===
| |
| − | You can add one or more banners to the sidebar by hacking your ''skins/Monobook.php'' file (if you're using monobook) to include the following piece of code.
| |
| − | | |
| − | Find (line 188):
| |
| − | <source lang="php">
| |
| − | ?>
| |
| − | </div><!-- end of the left (by default at least) column -->
| |
| − | </source>
| |
| − | | |
| − | Include:
| |
| − | <source lang="php">
| |
| − | ?>
| |
| − | <!-- begin of banner1 -->
| |
| − | <div class='generated-sidebar portlet'>
| |
| − | <h5><?php $this->msg('sidebar-banner1-headingtext') ?></h5>
| |
| − | <div style="border: 1px solid #B0B0B0; background-color: #FFFFFF;">
| |
| − | <a href="<?php $this->msg('sidebar-banner1-url') ?>">
| |
| − | <img width="100%" title="<?php $this->msg('sidebar-banner1-alttext') ?>"
| |
| − | alt="<?php $this->msg('sidebar-banner1-alttext') ?>"
| |
| − | src="<?php $this->msg('sidebar-banner1-imgsrc') ?>" /></a>
| |
| − | </div></div>
| |
| − | <!-- end of banner1 -->
| |
| − | </div><!-- end of the left (by default at least) column -->
| |
| − | </source>
| |
| − | | |
| − | Now in your Wiki, create four System messages: (i.e. articles named MediaWiki:sidebar-banner1-...)
| |
| − | | |
| − | {| class="prettytable"
| |
| − | ! parameter
| |
| − | ! value
| |
| − | |-
| |
| − | | <tt>sidebar-banner1-headingtext</tt>
| |
| − | | The text that will be displayed as the banner heading ("advertisement", "sponsor" etc.)
| |
| − | |-
| |
| − | | <tt>sidebar-banner1-url</tt>
| |
| − | | The destination URL of this banner
| |
| − | |-
| |
| − | | <tt>sidebar-banner1-alttext</tt> | |
| − | | Content of the '''alt=""''' parameter of an HTML <img> tag: any title for the destination site
| |
| − | |-
| |
| − | | <tt>sidebar-banner1-imgsrc</tt>
| |
| − | | Content of the '''src=""''' parameter of an HTML <img> tag: the URL of the banner image. It may be the address of an image uploaded to your Wiki ([[magic words]] may be used, e.g. <tt><nowiki>{{filepath:banner1.png}}</nowiki></tt>), or the address of an external image
| |
| − | |}
| |
| − | | |
| − | To add more banners, just repeat the process renaming "banner1" to "banner2" etc.
| |
| − | | |
| − | ==Troubleshooting==
| |
| − | ===Changes not showing up===
| |
| − | MediaWiki aggressively caches content if possible, which often causes the navigation bar to persist after changes. [[Manual:Purge|Purging the cache]] of affected pages should correct the situation. To perform a mass-purge of all caches at once, [http://www.freebsd.org/cgi/man.cgi?query=touch touch] the <tt>'''LocalSettings.php'''</tt> file or [http://www.mysql.org/doc/refman/5.0/en/truncate.html truncate] the <tt>'''objectcache'''</tt> table in your database (you may have to do both).
| |
| − | | |
| − | You also need to have [[Manual:%24wgUseDatabaseMessages|$wgUseDatabaseMessages]] set to <tt>true</tt>.
| |
| − | | |
| − | ===Lowercase link labels===
| |
| − | If your links are not being capitalized as intended, try adding spaces around the bar character; for example:
| |
| − | <pre>** http://www.example.com/download.php?file=44555 | Download</pre>
| |
| − | | |
| − | ===Sections disappear or show unexpected content===
| |
| − | If a section does not display or displays unexpected content, check that the header text isn't the name of an interface message by searching [[Special:Allmessages]]. If it is, use a different header text, or create a new interface message and use it.
| |
| − | | |
| − | For example, if you want to use "Sidebar" as header text, create the interface message "MediaWiki:Sidebar-header" containing only "Sidebar". Then, use <code><nowiki>* sidebar-header</nowiki></code> as header.
| |
| − | | |
| − | Sections are not displayed if there are no links of the form <code>** target|link text</code> (e.g. when the target was forgotten).
| |
| − | | |
| − | ===Broken links after updating [[Special:Version]]===
| |
| − | This will happen e.g., each time there are newer translations for your
| |
| − | site language's sidebar items. One could add new redirect pages each
| |
| − | time, but a better solution would be to use one's own sidebar item names
| |
| − | instead of trying to keep track of the current MediaWiki translations.
| |
| − | | |
| − | ===Ancient version of MediaWiki===
| |
| − | If you have a pre-release version of 1.5 Beta, or earlier, it is still possible in some cases to edit the sidebar:
| |
| − | *Prior to 1.5 branching (between [[rev:9150]] and [[rev:9177]]) the message utilized was briefly '''MediaWiki:Navbar'''.
| |
| − | *Before this, version 1.4 had (from [[rev:5528]] to [[rev:9150]]) a global variable, titled [[Manual:$wgNavigationLinks|$wgNavigationLinks]].
| |
| − | | |
| − | ==See also==
| |
| − | * [[Sidebar]]
| |
| − | * [[Quickbar]]
| |
| − | * [[w:User:Mike Dillon/Sidebar]]
| |
| − | * [[Extension:CustomSidebar]]
| |
| − | | |
| − | {{Languages|Manual:Interface/Sidebar}}
| |
