Difference between revisions of "MediaWiki/Theming"

From Freephile Wiki
Jump to navigation Jump to search
(adds section with link to preferences)
(adds styling, icons, templates sections; adds link to softwarekombinat.de)
Line 5: Line 5:
 
or just dive into all the [http://meta.wikimedia.org/wiki/Gallery_of_user_styles examples of user styles]
 
or just dive into all the [http://meta.wikimedia.org/wiki/Gallery_of_user_styles examples of user styles]
  
 
+
== How to change the Logo ==
== How to chage the Logo ==
 
 
 
 
You can change the Logo of the wiki by altering the $wgLogo variable in LocalSettings.php to the name of the image you want to use as a logo.
 
You can change the Logo of the wiki by altering the $wgLogo variable in LocalSettings.php to the name of the image you want to use as a logo.
 
Please note that this logo should be placed in the /skins/common/images/ folder.
 
Please note that this logo should be placed in the /skins/common/images/ folder.
Line 13: Line 11:
 
$wgLogo            = "$wgStylePath/common/images/freephile_sm_logo.gif";
 
$wgLogo            = "$wgStylePath/common/images/freephile_sm_logo.gif";
 
</pre>
 
</pre>
 
  
 
== How to change the favicon ==
 
== How to change the favicon ==
Line 20: Line 17:
 
$wgFavicon          =  "http://www.freephile.com/images/logos/favicon.ico";
 
$wgFavicon          =  "http://www.freephile.com/images/logos/favicon.ico";
 
</pre>
 
</pre>
 +
 +
 +
== Styling ==
 +
A user can completely affect the styling of the wiki they are using by applying user-defined styling to the site. [[meta:Help:User_style]]
 +
 +
== Icons and Graphics ==
 +
See the Nuvola2 project
 +
http://commons.wikimedia.org/wiki/Nuvola_icons_for_KDE_3.x
 +
http://commons.wikimedia.org/wiki/Commons:Project_Nuvola_2.0%2B
 +
 +
== How to use Templates for information design, consistency, and utility ==
 +
The [[Templates|template]] system allows you to create re-usable interface elements such as 'sidebars', 'callouts' or 'info boxes' and almost limitless utility.  The [[Wikipedia:Template:Ambox|Ambox template]] is an example of a template that you'll probably want to use in your local wiki system.
  
 
== How to change the navigation ==
 
== How to change the navigation ==
The navigation system is a system message like many aspects of the Mediawiki system.  This means that you don't actually have to change 'code' to affect the menu.  You can simply edit a special page in the mediawiki system.  Edits to this page get stored in the database like every other page edit which provides built-in versioning etc.  However, it can also mean that pushing changes from a development machine to a server can be more challenging than pushing 'code' changes.  
+
The navigation system is setup through a special type called an 'interface message'.  (The interface message system is also used for many other aspects of the Mediawiki system.) This means that you don't actually have to change 'code' to affect the menu.  You can simply edit a special page in the mediawiki system.  Edits to this page get stored in the database like every other page edit which provides built-in versioning etc.  However, it can also mean that pushing changes from a development machine to a server can be more challenging than pushing 'code' changes.  
  
In any case, to change the nav, you will want to edit the '''MediaWiki:Sidebar''' page. (e.g. <nowiki>http://example.com/wiki/index.php/MediaWiki:Sidebar</nowiki>)  There are rules and conventions which apply here, and you can [http://www.mediawiki.org/wiki/Manual:Navigation_bar find more help in the documentation].  In case you are going to change the location of blocks like the search box or toolbox in your theme, you'll want to edit them out of the default navigation box.
+
In any case, to change the nav, you will want to edit the '''MediaWiki:Sidebar''' page. (e.g. <nowiki>http://example.com/wiki/index.php/MediaWiki:Sidebar</nowiki>) The right to edit this page is normally restricted to administrators, so if you want to delegate the responsibility for this, you will want to look at the user permissions system. There are rules and conventions which apply here, and you can [[MediaWiki:Manual:Navigation_bar | find more help in the documentation]].  In case you are going to change the location of blocks like the '''search''' box or '''toolbox''' (which normally show up in the sidebar) by making a custom theme, you'll want to coordinate those changes with the sidebar.
  
 
== How to make your own skin ==
 
== How to make your own skin ==
Line 74: Line 83:
  
 
== Resources ==
 
== Resources ==
 +
The skinning manual http://www.mediawiki.org/wiki/Manual:Skinning is probably the most comprehensive and best introduction to how the skin system works aside from digging into [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/skins/ the code in the 'skins' directory].
 +
 +
http://www.softwarekombinat.de/wiki/Customize_mediawiki has one of the best 'howto's that I found.
 +
 
The [http://meta.wikimedia.org/wiki/Layout_design_document Layout Design Document] might cover some relevant info, but a quick glance makes it seem that it's circa 2004.
 
The [http://meta.wikimedia.org/wiki/Layout_design_document Layout Design Document] might cover some relevant info, but a quick glance makes it seem that it's circa 2004.
 
The skinning manual http://www.mediawiki.org/wiki/Manual:Skinning is probably the most comprehensive and best introduction to how the skin system works aside from digging into [http://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/skins/ the code in the 'skins' directory].
 

Revision as of 11:12, 7 October 2008

You can change the look and layout of your Mediawiki site. The place to start is the wikimedia groups' meta pages.

There is the design document and the info on skins or just dive into all the examples of user styles

[edit | edit source]

You can change the Logo of the wiki by altering the $wgLogo variable in LocalSettings.php to the name of the image you want to use as a logo. Please note that this logo should be placed in the /skins/common/images/ folder.

$wgLogo             = "$wgStylePath/common/images/freephile_sm_logo.gif";

How to change the favicon[edit | edit source]

You can change the icon that is displayed in the address bar of your browser by setting a value for $wgFavicon in the LocalSettings.php file

$wgFavicon          =  "http://www.freephile.com/images/logos/favicon.ico";


Styling[edit | edit source]

A user can completely affect the styling of the wiki they are using by applying user-defined styling to the site. meta:Help:User_style

Icons and Graphics[edit | edit source]

See the Nuvola2 project http://commons.wikimedia.org/wiki/Nuvola_icons_for_KDE_3.x http://commons.wikimedia.org/wiki/Commons:Project_Nuvola_2.0%2B

How to use Templates for information design, consistency, and utility[edit | edit source]

The template system allows you to create re-usable interface elements such as 'sidebars', 'callouts' or 'info boxes' and almost limitless utility. The Ambox template is an example of a template that you'll probably want to use in your local wiki system.

How to change the navigation[edit | edit source]

The navigation system is setup through a special type called an 'interface message'. (The interface message system is also used for many other aspects of the Mediawiki system.) This means that you don't actually have to change 'code' to affect the menu. You can simply edit a special page in the mediawiki system. Edits to this page get stored in the database like every other page edit which provides built-in versioning etc. However, it can also mean that pushing changes from a development machine to a server can be more challenging than pushing 'code' changes.

In any case, to change the nav, you will want to edit the MediaWiki:Sidebar page. (e.g. http://example.com/wiki/index.php/MediaWiki:Sidebar) The right to edit this page is normally restricted to administrators, so if you want to delegate the responsibility for this, you will want to look at the user permissions system. There are rules and conventions which apply here, and you can find more help in the documentation. In case you are going to change the location of blocks like the search box or toolbox (which normally show up in the sidebar) by making a custom theme, you'll want to coordinate those changes with the sidebar.

How to make your own skin[edit | edit source]

A skin generally has it's own directory, plus two setup files. If you wanted to create a skin called 'Happy' you would have

happy
Happy.php
Happy.deps.php

in the 'skins' directory.

The easiest way to create your skin is to copy the monobook skin and start from there.

You can create a skin all by yourself by following the steps provided below:

  1. Go to your mediawiki 'skins' directory;
  2. Copy the monobook directory and name it with the name of your skin: happy;
  3. Copy the MonoBook.php file and name it with the name of your skin: Happy.php;
  4. Edit Happy.php and change the class name to SkinHappy:
    class SkinHappy extends SkinTemplate;
    
  5. In Happy.php, change the template class to have your skin name together with the word 'Template':
    class HappyTemplate extends QuickTemplate;
    
  6. Also in Happy.php, make the references to the skin match the names:
        $this->skinname  = 'happy'; // matches the physical directory name
        $this->stylename = 'happy'; // matches the physical directory name
        $this->template  = 'HappyTemplate'; // matches the template class name
  1. In your happy directory edit the image and CSS files until your heart is content;
  2. Edit and customise Happy.php as you please;

Making your Skin Available[edit | edit source]

To make your skin available sitewide, and the default skin, set it in LocalSettings.php e.g. set $wgDefaultSkin = 'happy'.

To let your users decide which skin they can use, you can enable user preferences.

Offering/Using multiple skins[edit | edit source]

If you have multiple skins available, you can preview and switch between them by visiting your user preferences. Since a given skin can be specified in the querystring, you can even bookmark a certain 'look' for easy comparison with a new theme. e.g. http://freephile.com/wiki/index.php?title=Main_Page&useskin=monobook

Nice Examples[edit | edit source]

The skin used on this site is based on the excellent work of Paul Gu

I've seen some other projects that have nice mediawiki skins, but I never bothered to write them down. A quick search reveals several projects by Suse:

  1. http://en.opensuse.org/Welcome_to_openSUSE.org
  2. http://www.mono-project.com/Main_Page
  3. http://beagle-project.org/Main_Page
  4. http://en.opensuse.org/Welcome_to_openSUSE.org

I hesitate to call it a 'nice example' because it doesn't seem all that compelling, but there is the mozilla project wiki https://wiki.mozilla.org/Main_Page I'm fairly certain without checking the wayback machine that developer.mozilla.org used to run mediawiki, with a very nice theme and lots of custom templates and graphics. Now they are running a commercial opensource wiki product.

Resources[edit | edit source]

The skinning manual http://www.mediawiki.org/wiki/Manual:Skinning is probably the most comprehensive and best introduction to how the skin system works aside from digging into the code in the 'skins' directory.

http://www.softwarekombinat.de/wiki/Customize_mediawiki has one of the best 'howto's that I found.

The Layout Design Document might cover some relevant info, but a quick glance makes it seem that it's circa 2004.