MDL-40455: theme_formfactor: Move slash comments to be before code (not after) add...
[moodle.git] / theme / formfactor / config.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Configuration for Moodle's formfactor theme.
19  *
20  * DO NOT MODIFY THIS THEME!
21  * COPY IT FIRST, THEN RENAME THE COPY AND MODIFY IT INSTEAD.
22  *
23  * For full information about creating Moodle themes, see:
24  *  http://docs.moodle.org/dev/Themes_2.0
25  *
26  * @package   theme_formfactor
27  * @copyright 2010 Patrick Malley
28  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 // Name of the theme, and most likely the name
32 // of the directory in which this file resides.
34 $THEME->name = 'formfactor';
36 // Which existing theme(s) in the /theme/ directory
37 // do you want this theme to extend?
38 // A theme can extend any number of themes. So rather
39 // than creating an entirely new theme and copying all
40 // of the CSS, you can simply create a new theme,
41 // by extending the theme you like and just add the
42 // changes you want to your theme.
44 $THEME->parents = array('canvas','base');
46 // Name of the stylesheet(s) you've including in
47 // this theme's /styles/ directory.
49 $THEME->sheets = array(
50     'selected',
51     'core',
52     'course',
53     'mods',
54     'blocks'
55 );
57 // Do you want to use the new navigation dock?
59 $THEME->enable_dock = false;
61 // An array of stylesheets to include within the
62 // body of the editor.
64 $THEME->editor_sheets = array('editor');
66 // These are all of the possible layouts in Moodle. The
67 // simplest way to do this is to keep the theme and file
68 // variables the same for every layout. Including them
69 // all in this way allows some flexibility down the road
70 // if you want to add a different layout template to a
71 // specific page.
73 $THEME->layouts = array(
74     // Most backwards compatible layout without the blocks - this is the layout used by default
75     'base' => array(
76         'file' => 'general.php',
77         'regions' => array(),
78     ),
79     // Standard layout with blocks, this is recommended for most pages with general information
80     'standard' => array(
81         'file' => 'general.php',
82         'regions' => array('side-pre', 'side-post'),
83         'defaultregion' => 'side-pre',
84     ),
85     // Main course page
86     'course' => array(
87         'file' => 'general.php',
88         'regions' => array('side-pre', 'side-post'),
89         'defaultregion' => 'side-pre',
90         'options' => array('langmenu'=>true),
91     ),
92     'coursecategory' => array(
93         'file' => 'general.php',
94         'regions' => array('side-pre', 'side-post'),
95         'defaultregion' => 'side-pre',
96     ),
97     // part of course, typical for modules - default page layout if $cm specified in require_login()
98     'incourse' => array(
99         'file' => 'general.php',
100         'regions' => array('side-pre', 'side-post'),
101         'defaultregion' => 'side-pre',
102     ),
103     // The site home page.
104     'frontpage' => array(
105         'file' => 'frontpage.php',
106         'regions' => array('side-pre', 'side-post'),
107         'defaultregion' => 'side-pre',
108     ),
109     // Server administration scripts.
110     'admin' => array(
111         'file' => 'general.php',
112         'regions' => array('side-pre'),
113         'defaultregion' => 'side-pre',
114     ),
115     // My dashboard page
116     'mydashboard' => array(
117         'file' => 'general.php',
118         'regions' => array('side-pre', 'side-post'),
119         'defaultregion' => 'side-pre',
120         'options' => array('langmenu'=>true),
121     ),
122     // My public page
123     'mypublic' => array(
124         'file' => 'general.php',
125         'regions' => array('side-pre', 'side-post'),
126         'defaultregion' => 'side-pre',
127     ),
128     'login' => array(
129         'file' => 'general.php',
130         'regions' => array(),
131         'options' => array('langmenu'=>true),
132     ),
134     // Pages that appear in pop-up windows - no navigation, no blocks, no header.
135     'popup' => array(
136         'file' => 'general.php',
137         'regions' => array(),
138         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true, 'nologininfo'=>true, 'nocourseheaderfooter'=>true),
139     ),
140     // No blocks and minimal footer - used for legacy frame layouts only!
141     'frametop' => array(
142         'file' => 'general.php',
143         'regions' => array(),
144         'options' => array('nofooter'=>true, 'nocoursefooter'=>true),
145     ),
146     // Embeded pages, like iframe/object embeded in moodleform - it needs as much space as possible
147     'embedded' => array(
148         'file' => 'embedded.php',
149         'regions' => array(),
150         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true, 'nocourseheaderfooter'=>true),
151     ),
152     // Used during upgrade and install, and for the 'This site is undergoing maintenance' message.
153     // This must not have any blocks, and it is good idea if it does not have links to
154     // other places - for example there should not be a home link in the footer...
155     'maintenance' => array(
156         'file' => 'general.php',
157         'regions' => array(),
158         'options' => array('noblocks'=>true, 'nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true, 'nocourseheaderfooter'=>true),
159     ),
160     // Should display the content and basic headers only.
161     'print' => array(
162         'file' => 'general.php',
163         'regions' => array(),
164         'options' => array('noblocks'=>true, 'nofooter'=>true, 'nonavbar'=>false, 'nocustommenu'=>true, 'nocourseheaderfooter'=>true),
165     ),
166     // The pagelayout used when a redirection is occuring.
167     'redirect' => array(
168         'file' => 'embedded.php',
169         'regions' => array(),
170         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true, 'nocourseheaderfooter'=>true),
171     ),
172     // The pagelayout used for reports.
173     'report' => array(
174         'file' => 'report.php',
175         'regions' => array('side-pre'),
176         'defaultregion' => 'side-pre',
177     ),
178     // The pagelayout used for safebrowser and securewindow.
179     'secure' => array(
180         'file' => 'general.php',
181         'regions' => array('side-pre', 'side-post'),
182         'defaultregion' => 'side-pre',
183         'options' => array('nofooter'=>true, 'nonavbar'=>true, 'nocustommenu'=>true, 'nologinlinks'=>true, 'nocourseheaderfooter'=>true),
184     ),
185 );