Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Clean theme: Difference between revisions

From MoodleDocs
Themes
m (Updating contents ready for name change. :))
Line 1: Line 1:
{{Template:Themes}}{{Moodle 2.5}}This document describes how to copy and customise the Simple (bootstrap) theme so that you can build on this to create a theme of your own. It assumes you have some understanding of how themes work within Moodle 2.5, as well as a basic understanding of HTML and CSS. Also, because of the rapid development within Moodle, resulting in a number of versions available namely 2.3.x and 2.4.x, and 2.5.x it is important to understand that this tutorial is only valid for the Moodle 2.5+ Simple theme.
{{Template:Themes}}{{Moodle 2.5}}This document describes how to copy and customise the Clean (bootstrapbase) theme so that you can build on this to create a theme of your own. It assumes you have some understanding of how themes work within Moodle 2.5, as well as a basic understanding of HTML and CSS. Also, because of the rapid development within Moodle, resulting in a number of versions available namely 2.3.x and 2.4.x, and 2.5.x it is important to understand that this tutorial is only valid for the Moodle 2.5+ Clean theme.


==Getting started==
==Getting started==


From your Moodle '''theme''' directory '''right click''' on '''simple''' and then '''''copy''' and  '''paste''''' back into your Moodle '''theme''' directory. You should now have a folder called '''Copy of simple'''. If you '''right click''' this folder you are given the option to '''Rename''' it. So rename this folder to your choosen theme name, using only lower case letters, and if needed, underscores. For the purpose of this tutorial we will call the theme 'simple2'.
From your Moodle '''theme''' directory '''right click''' on the '''clean''' theme and then '''''copy''' and  '''paste''''' back into your Moodle '''theme''' directory. You should now have a folder called '''Copy of clean'''. If you '''right click''' this folder you are given the option to '''Rename''' it. So rename this folder to your choosen theme name, using only lower case letters, and if needed, underscores. For the purpose of this tutorial we will call the theme 'cleantheme'.


On opening 'simple2' your you will find several files and sub-directories which have files within them.
On opening 'cleantheme' you will find several files and sub-directories which have files within them.


These are:
These are:
Line 23: Line 23:
==Renaming Elements==
==Renaming Elements==


The problem when '''copying''' a theme is that you need to rename all those instances where the old theme name occurs, in this case '''simple'''. So using the above list as a guide, search through and change all the instances of the theme name 'simple' to 'simple2'. This includes the filename of the lang/en/theme_simple.php. You need to change this to 'theme_simple2.php'.
The problem when '''cloning''' a theme is that you need to rename all those instances where the old theme name occurs, in this case '''simple'''. So using the above list as a guide, search through and change all the instances of the theme name 'simple' to 'simple2'. This includes the filename of the lang/en/theme_simple.php. You need to change this to 'theme_cleantheme.php'.


==Installing your theme==
==Installing your theme==
Line 29: Line 29:
Once all the changes to the name have been made, you can safely install the theme. If you are already logged in just refreshing the browser should trigger your Moodle site to begin the install 'Plugins Check'. If not then navigate to Administration > Notifications.
Once all the changes to the name have been made, you can safely install the theme. If you are already logged in just refreshing the browser should trigger your Moodle site to begin the install 'Plugins Check'. If not then navigate to Administration > Notifications.


Once your theme is successfully installed you can select it and begin to modify it using the custom settings page found by navigating to Administration > Site Administration > Appearance > Themes >> and then click on (Simple2) or whatever you renamed it to, from the list of theme names that appear at this point in the side block.
Once your theme is successfully installed you can select it and begin to modify it using the custom settings page found by navigating to Administration > Site Administration > Appearance > Themes >> and then click on (Cleantheme) or whatever you renamed your theme to, from the list of theme names that appear at this point in the side block.

Revision as of 09:47, 25 April 2013

Moodle 2.5 This document describes how to copy and customise the Clean (bootstrapbase) theme so that you can build on this to create a theme of your own. It assumes you have some understanding of how themes work within Moodle 2.5, as well as a basic understanding of HTML and CSS. Also, because of the rapid development within Moodle, resulting in a number of versions available namely 2.3.x and 2.4.x, and 2.5.x it is important to understand that this tutorial is only valid for the Moodle 2.5+ Clean theme.

Getting started

From your Moodle theme directory right click on the clean theme and then copy and paste back into your Moodle theme directory. You should now have a folder called Copy of clean. If you right click this folder you are given the option to Rename it. So rename this folder to your choosen theme name, using only lower case letters, and if needed, underscores. For the purpose of this tutorial we will call the theme 'cleantheme'.

On opening 'cleantheme' you will find several files and sub-directories which have files within them.

These are:

config.php
Where all the theme configurations are made. (contains some elements that require renaming)
lib.php
Where all the functions for the themes settings are found. (contains some elements that require renaming)
settings.php
Where all the setting for this theme are created. (contains some elements that require renaming)
version.php
Where the version number and plugin componant information is kept. (contains some elements that require renaming)
/lang/
This directory contains all language sub-directories for other languages if and when you want to add them.
/lang/en/
This sub-directory contains your language files, in this case English.
/lang/en/theme_simple.php
This file contains all the language strings for your theme. (contains some elements that require renaming as well as the filename itself)
/layout/
This directory contains all the layout files for this theme.
/layout/general.php
Layout file for front page and general pages combined.
/style/
This directory contains all the CSS files for this theme.
/style/custom.css
This is where all the settings CSS is generated.
/pix/
This directory contains a screen shot of this theme as well as a favicon and any images used in the theme.

Renaming Elements

The problem when cloning a theme is that you need to rename all those instances where the old theme name occurs, in this case simple. So using the above list as a guide, search through and change all the instances of the theme name 'simple' to 'simple2'. This includes the filename of the lang/en/theme_simple.php. You need to change this to 'theme_cleantheme.php'.

Installing your theme

Once all the changes to the name have been made, you can safely install the theme. If you are already logged in just refreshing the browser should trigger your Moodle site to begin the install 'Plugins Check'. If not then navigate to Administration > Notifications.

Once your theme is successfully installed you can select it and begin to modify it using the custom settings page found by navigating to Administration > Site Administration > Appearance > Themes >> and then click on (Cleantheme) or whatever you renamed your theme to, from the list of theme names that appear at this point in the side block.

Retrieved from "https://docs.moodle.org/dev/index.php?title=Clean_theme&oldid=39349"
Powered by MediaWiki