aba35fdd7ed8c97b1b7de0ab60985d280caa1dcd
[moodle.git] / theme / base / config.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Configuration for Moodle's base theme.
20  *
21  * This theme is special, and implements a minimalist theme with only
22  * basic layout. It is intended as a base for other themes to build upon.
23  * It is not recommend to actually choose this theme for production sites!
24  *
25  * DO NOT COPY THIS TO START NEW THEMES!
26  * Start with another theme, like "standard".
27  *
28  * For full information about creating Moodle themes, see:
29  *  http://docs.moodle.org/dev/Themes_2.0
30  *
31  * @package   moodlecore
32  * @copyright 2009 Tim Hunt
33  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
36 $THEME->name = 'base';
38 $THEME->parents = array();
40 $THEME->sheets = array(
41     'pagelayout',   /** Must come first: Page layout **/
42     'core',         /** Must come second: General styles **/
43     'admin',
44     'blocks',
45     'calendar',
46     'course',
47     'dock',
48     'grade',
49     'message',
50     'question',
51     'user'
52 );
54 $THEME->editor_sheets = array('editor');
56 $THEME->layouts = array(
57     // Most backwards compatible layout without the blocks - this is the layout used by default
58     'base' => array(
59         'file' => 'general.php',
60         'regions' => array(),
61     ),
62     // Standard layout with blocks, this is recommended for most pages with general information
63     'standard' => array(
64         'file' => 'general.php',
65         'regions' => array('side-pre', 'side-post'),
66         'defaultregion' => 'side-pre',
67     ),
68     // Main course page
69     'course' => array(
70         'file' => 'general.php',
71         'regions' => array('side-pre', 'side-post'),
72         'defaultregion' => 'side-pre',
73         'options' => array('langmenu'=>true),
74     ),
75     'coursecategory' => array(
76         'file' => 'general.php',
77         'regions' => array('side-pre', 'side-post'),
78         'defaultregion' => 'side-pre',
79     ),
80     // part of course, typical for modules - default page layout if $cm specified in require_login()
81     'incourse' => array(
82         'file' => 'general.php',
83         'regions' => array('side-pre', 'side-post'),
84         'defaultregion' => 'side-pre',
85     ),
86     // The site home page.
87     'frontpage' => array(
88         'file' => 'frontpage.php',
89         'regions' => array('side-pre', 'side-post'),
90         'defaultregion' => 'side-pre',
91     ),
92     // Server administration scripts.
93     'admin' => array(
94         'file' => 'general.php',
95         'regions' => array('side-pre'),
96         'defaultregion' => 'side-pre',
97     ),
98     // My dashboard page
99     'mydashboard' => array(
100         'file' => 'general.php',
101         'regions' => array('side-pre', 'side-post'),
102         'defaultregion' => 'side-pre',
103         'options' => array('langmenu'=>true),
104     ),
105     // My public page
106     'mypublic' => array(
107         'file' => 'general.php',
108         'regions' => array('side-pre', 'side-post'),
109         'defaultregion' => 'side-pre',
110     ),
111     'login' => array(
112         'file' => 'general.php',
113         'regions' => array(),
114         'options' => array('langmenu'=>true),
115     ),
117     // Pages that appear in pop-up windows - no navigation, no blocks, no header.
118     'popup' => array(
119         'file' => 'general.php',
120         'regions' => array(),
121         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true, 'nologininfo'=>true),
122     ),
123     // No blocks and minimal footer - used for legacy frame layouts only!
124     'frametop' => array(
125         'file' => 'general.php',
126         'regions' => array(),
127         'options' => array('nofooter'=>true),
128     ),
129     // Embeded pages, like iframe/object embeded in moodleform - it needs as much space as possible
130     'embedded' => array(
131         'file' => 'embedded.php',
132         'regions' => array(),
133         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true),
134     ),
135     // Used during upgrade and install, and for the 'This site is undergoing maintenance' message.
136     // This must not have any blocks, and it is good idea if it does not have links to
137     // other places - for example there should not be a home link in the footer...
138     'maintenance' => array(
139         'file' => 'general.php',
140         'regions' => array(),
141         'options' => array('noblocks'=>true, 'nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true),
142     ),
143     // Should display the content and basic headers only.
144     'print' => array(
145         'file' => 'general.php',
146         'regions' => array(),
147         'options' => array('noblocks'=>true, 'nofooter'=>true, 'nonavbar'=>false, 'nocustommenu'=>true),
148     ),
149     // The pagelayout used when a redirection is occuring.
150     'redirect' => array(
151         'file' => 'embedded.php',
152         'regions' => array(),
153         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true),
154     ),
155     // The pagelayout used for reports
156     'report' => array(
157         'file' => 'report.php',
158         'regions' => array('side-pre'),
159         'defaultregion' => 'side-pre',
160     ),
161 );
163 // We don't want the base theme to be shown on the theme selection screen, by setting
164 // this to true it will only be shown if theme designer mode is switched on.
165 $THEME->hidefromselector = true;
167 /** List of javascript files that need to included on each page */
168 $THEME->javascripts = array();
169 $THEME->javascripts_footer = array();