MoodleDocs - User contributions [en]

Clean theme

2014-02-13T16:06:23Z

Roal: Added link to Discussion in Themes Forum

{{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==

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_clean.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/columns1.php : Layout file for a one column layout (content only).
; /layout/columns2.php : Layout file for a two column layout (side-pre and content).
; /layout/columns3.php : Layout file for a three column layout (side-pre, content and side-post) and the front page.
; /layout/embedded.php : Embedded layout file for embeded pages, like iframe/object embeded in moodleform - it needs as much space as possible.
; /layout/maintenance.php : Maintenance layout file which does not have any blocks, links, or API calls that would lead to database or cache interaction.
; /layout/secure.php : Secure layout file for safebrowser and securewindow.
; /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 '''clean'''. So using the above list as a guide, search through and change all the instances of the theme name 'clean' to 'cleantheme'. This includes the filename of the lang/en/theme_clean.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.

==Include a renderer in a bootstrap based theme==

If you need to override any renderers in your theme, then make sure you override the renderers by extending the parent theme renderers, which in this case is bootstrapbase. For example the class that you need to start your renderer with is as follows...

<code php>
class theme_yourtheme_core_renderer extends theme_bootstrapbase_core_renderer {

}
</code>

...where ''''yourtheme'''' requires you to change it to your theme name otherwise it will not work.

(Please note: The normal recipe <tt>class theme_'''yourtheme'''_core_renderer extends core_renderer</tt> is wrong for themes whose parent theme uses renderers, because this method will ultimately conflict with the parent theme's renderers.)

==See also==

* [http://www.somerandomthoughts.com/blog/2013/05/08/moodle-2-5-and-the-bootstrap-based-theme-clean/ Moodle 2.5 and the Bootstrap based theme – Clean] blog post by Gavin Henrick
* [http://basbrands.nl/blog/2013/05/21/building-with-bootstrap/ Building With Bootstrap] blog post by Bas Brands
* [https://moodle.org/mod/forum/discuss.php?d=239967 Problems cloning "clean" theme] Discussion in ''Themes'' Forum

Roadmap

2007-02-03T19:34:58Z

Roal: note about removement of pre-1.7 DB install/upgrade system

This roadmap collects the best information about upcoming features in Moodle. It is not 100% certain - features may change according to available funding and developers.

== Version 1.8 - Expected February 2007 ==

* [[Accessibility]] - Moodle.com
:: Compliance with all major accessibility standards
* [[Moodle forms library]] - Moodle.com
:: All forms can now use a single API for defining forms consistently and collecting data safely.
* [[Multi Authentication]] - Iñaki Arenaza / Jonathan Harker (Catalyst) / Martin Langhoff (Catalyst)
* [[Development:Customisable user profiles|Customisable User Profiles]] - Pukunui Technology
::Allow fields to be added to the user profile.
* [[Moodle Network]] - Catalyst and Moodle.com
:: Setup peer Moodle installations allowing users to roam across, using comprehensive SSO and transparent remote enrolments. Administrators at the originating Moodle install can see logs of remote activity. You can also run your Moodle in "Hub" mode where any Moodle install can connect and users roam across.
::[[Web Services API]] for Moodle communications. The Moodle Network code includes an XML-RPC call dispatcher that can expose the whole Moodle API to trusted hosts.
* Groups refactor - Juliette White / Nick Freear (OU)
::Groups code will be reorganised to make it more flexible for the future (see 1.9)
* [[Authorize.net Payment Gateway]] enrolment plugin
:: Payment managers can obtain an authorization code over phone from customer's bank if the credit card of the user cannot be captured on the internet directly.

== Version 1.9 - Expected May 2007 ==

* [[Development:Grades|Gradebook development]]
::The gradebook system will be revamped for performance, switching from our older "pull" model to a "push" model where all modules will now publish grades as necessary into a central table.
* [[Metadata]] - Moodle.com
::Build on the keywords in 1.6 to provide metadata for all activities and courses, linkable to standard lists of metadata such as State-based learning outcomes and curricula
* [[Repository API]] - Open University, Moodle.com and Humboldt
::Abstract all file operations to an API that allows plugins for different external repositories
* [[Learning Design export]] - Moodle.com and Open University of The Netherlands
::We plan to have a very simple export for any Moodle course into IMS LD format, as a proof of concept and to help the community start learning about IMS LD.
* [[Development:Groups_documentation_for_module_developers|New groups]] - Open University
::Site-wide groups, reusable groups, and assigning activities to groups are the major improvements being developed
* Blog commenting
:: You'll be able to make comments on blogs! In time, all comments in Moodle will be merged into the same commenting system.
* SCORM 2004?
* Integrate nwiki?
* Integrate Feedback module?

== Version 2.0 - Expected August 2007 ==

* [[IMS Learning Design]] - Moodle.com
::Support for importing/exporting LD, converting Moodle activities and sequences of activities into a standard format for sharing, and importing standard sequences into Moodle courses
* [[Conditional activities]] - Moodle.com
::Allowing dependencies and forced paths through the content
* [[Community hub]] interfaces - Moodle.com and others
::Makes it easy for users to find and navigate other systems and external Moodle repositories, leveraging the Moodle Network in various ways.
* [[Student Information API]]
::API for integrating external systems for managing student information
* Old DB install/upgrade system removed
:: The deprecated system for installing or upgrading database entries used in Moodle < 1.7 will be completely removed, while supporting only the new XML based database scheme introduced in 1.7

''Note: Moodle 2.0 will require PHP 5.1 as a minimum, because of certain improvements not available in PHP 4.''

== Version 2.1 ==

* [[Portfolio API]]
::Interface Moodle activities and repositories to help produce portfolios for internal assessment AND external publication

[[Category:Developer]]
[[Category:Future]]

[[es:Planificación]]
[[fr:Planification]]

XMLDB column types

2007-02-02T09:45:47Z

Roal: FIELD TYPE "date with time" changed to "datetime"

[[XML database schema]] > XMLDB column types
----
This page will show, once finished, one compatibility matrix of column types for each of the RDBMS under which Moodle is expected to work.

== The matrix ==

<table align="center" border="1" cellpadding="5">
<tr>
<th>'''XMLDB Type'''</th>
<th>'''MySQL'''</th>
<th>'''PostgreSQL'''</th>
<th>'''Oracle'''</th>
<th>'''MSSQL</th></tr>
<tr>
<td>int</td>
<td>
:'''BIGINT''' (>9 digits)
:'''INT''' (>6 digits)
:'''MEDIUMINT''' (>4 digits)
:'''SMALLINT''' (>2 digits)
:'''TINYINT''' (<=2 digits)
</td>
<td>
:'''BIGINT''' (>9 digits)
:'''INTEGER''' (>4 digits)
:'''SMALLINT''' (<=4 digits)
</td>
<td>
:'''NUMBER'''
</td>
<td>
:'''BIGINT''' (>9 digits)
:'''INTEGER''' (>4 digits)
:'''SMALLINT''' (<=4 digits)
</td>
</tr>
<tr>
<td>number</td>
<td>
:'''NUMERIC'''
</td>
<td>
:'''NUMERIC'''
</td>
<td>
:'''NUMBER'''
</td>
<td>
:'''DECIMAL'''
</td>
</tr>
<tr>
<td>float</td>
<td>
:'''FLOAT''' (< 6 dec. positions)
:'''DOUBLE''' (>= 6 dec. positions)
</td>
<td>
:'''REAL''' (< 6 dec. positions)
:'''DOUBLE PRECISION''' (>= 6 dec. positions)
</td>
<td>
:'''NUMBER'''
</td>
<td>
:'''REAL''' (< 6 dec. positions)
:'''FLOAT''' (>= 6 dec. positions)
</td>
</tr>
<tr>
<td>char</td>
<td>
:'''VARCHAR'''
</td>
<td>
:'''VARCHAR'''
</td>
<td>
:'''VARCHAR2'''
</td>
<td>
:'''NVARCHAR'''
</td>
</tr>
<tr>
<td>text</td>
<td>
:'''LONGTEXT'''
:'''MEDIUMTEXT'''
:'''TEXT'''
</td>
<td>
:'''TEXT'''
</td>
<td>
:'''CLOB'''
</td>
<td>
:'''NTEXT'''
</td>
</tr>
<tr>
<td>binary</td>
<td>
:'''LONGBLOB'''
:'''MEDIUMBLOB'''
:'''BLOB'''
</td>
<td>
:'''BYTEA'''
</td>
<td>
:'''BLOB'''
</td>
<td>
:'''IMAGE'''
</td>
</tr>
<tr>
<td>datetime</td>
<td>
:'''DATETIME'''
</td>
<td>
:'''TIMESTAMP'''
</td>
<td>
:'''DATE'''
</td>
<td>
:'''DATETIME'''
</td>
</tr>
</table>

== Some official links ==

* MySQL: http://dev.mysql.com/doc/refman/5.0/en/data-types.html
* PostgreSQL: http://www.postgresql.org/docs/7.4/static/datatype.html
* SQL*Server: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/tsqlref/ts_da-db_7msw.asp
* Oracle: http://www.cs.umbc.edu/help/oracle8/server.815/a68003/01_04blt.htm

[[Category:XMLDB]]