theme/clean/README.txt

   1
   2 /* How to copy and customise this theme.
   3 ----------------------------------------*/
   4
   5 This document describes how to copy and customise the Clean (bootstrapbase) theme so that
   6 you can build on this to create a theme of your own. It assumes you have some
   7 understanding of how themes work within Moodle 2.5, as well as a basic understanding
   8 of HTML and CSS.
   9
  10 Getting started
  11 ---------------
  12
  13 From your Moodle theme directory right click on clean and then copy and paste back
  14 into your Moodle theme directory. You should now have a folder called Copy of clean.
  15 If you right click this folder you are given the option to Rename it. So rename this
  16 folder to your chosen theme name, using only lower case letters, and if needed,
  17 underscores. For the purpose of this tutorial we will call the theme 'cleantheme'.
  18
  19 On opening 'cleantheme' your you will find several files and sub-directories which have
  20 files within them.
  21
  22 These are:
  23
  24 config.php
  25     Where all the theme configurations are made.
  26     (Contains some elements that require renaming).
  27 lib.php
  28     Where all the functions for the themes settings are found.
  29     (Contains some elements that require renaming).
  30 settings.php
  31     Where all the setting for this theme are created.
  32     (Contains some elements that require renaming).
  33 version.php
  34     Where the version number and plugin component information is kept.
  35     (Contains some elements that require renaming).
  36 /lang/
  37     This directory contains all language sub-directories for other languages
  38     if and when you want to add them.
  39 /lang/en/
  40     This sub-directory contains your language files, in this case English.
  41 /lang/en/theme_clean.php
  42     This file contains all the language strings for your theme.
  43     (Contains some elements that require renaming as well as the filename itself).
  44 /layout/
  45     This directory contains all the layout files for this theme.
  46 /layout/columns1.php
  47     Layout file for a one column layout (content only).
  48     (Contains some elements that require renaming).
  49 /layout/columns2.php
  50     Layout file for a two column layout (side-pre and content).
  51     (Contains some elements that require renaming).
  52 /layout/columns3.php
  53     Layout file for a three column layout (side-pre, content and side-post) and the front page.
  54     (Contains some elements that require renaming).
  55 /layout/embedded.php
  56     Embedded layout file for embeded pages, like iframe/object embeded in moodleform.
  57     (Contains some elements that require renaming).
  58 /layout/maintenance.php
  59     Maintenance layout file which does not have any blocks, links, or API calls that would lead to database or cache interaction.
  60     (Contains some elements that require renaming).
  61 /layout/secure.php
  62     Secure layout file for safebrowser and securewindow.
  63     (Contains some elements that require renaming).
  64 /style/
  65     This directory contains all the CSS files for this theme.
  66 /style/custom.css
  67     This is where all the settings CSS is generated.
  68 /pix/
  69     This directory contains a screen shot of this theme as well as a favicon
  70     and any images used in the theme.
  71
  72 Renaming elements
  73 -----------------
  74
  75 The problem when copying a theme is that you need to rename all those instances
  76 where the old theme name occurs, in this case clean. So using the above list as
  77 a guide, search through and change all the instances of the theme name
  78 'clean' to 'cleantheme'. This includes the filename of the lang/en/theme_clean.php.
  79 You need to change this to 'theme_cleantheme.php'.
  80
  81 Installing your theme
  82 ---------------------
  83
  84 Once all the changes to the name have been made, you can safely install the theme.
  85 If you are already logged in just refreshing the browser should trigger your Moodle
  86 site to begin the install 'Plugins Check'.
  87
  88 If not then navigate to Administration > Notifications.
  89
  90 Once your theme is successfully installed you can select it and begin to modify
  91 it using the custom settings page found by navigating to...
  92 Administration > Site Administration > Appearance > Themes >>
  93 and then click on (Cleantheme) or whatever you renamed your theme to,
  94 from the list of theme names that appear at this point in the side block.
  95
  96 Customisation using custom theme settings
  97 -----------------------------------------
  98
  99 The settings page for the Clean theme can be located by navigating to:
 100
 101 Administration > Site Administration > Appearance > Themes > Clean
 102
 103 Moodle documentation
 104 --------------------
 105
 106 Further information can be found on Moodle Docs: http://docs.moodle.org/dev/Clean_theme