]> git.mxchange.org Git - friendica.git/blob - doc/themes.md
2nd iteration of the theming docs
[friendica.git] / doc / themes.md
1 # Themes
2
3 * [Home](help)
4
5 To change the look of friendica you have to touch the themes.
6 The current default theme is [duepunto zero](https://github.com/friendica/friendica/tree/master/view/theme/duepuntozero) but there are numerous others.
7 Have a look at [friendica-themes.com](http://friendica-themes.com) for an overview of the existing themes.
8 In case none of them suits your needs, there are several ways to change a theme.
9
10 You can either directly work on an existing theme.
11 But you might loose your changes when the theme is updated by the friendica team.
12
13 If you are almost happy with an existing theme, the easiest way to cover your needs is to create a new theme, inheritating most of the properties of the parent theme and change just minor stuff.
14 The beloow for a more detailed description of theme heritage.
15
16 Some themes also allow users to select *variants* of the theme.
17 Those theme variants most often contain an additional [CSS](https://en.wikipedia.org/wiki/CSS) file to override some styling of the default theme values.
18 From the themes in the main repository *duepunto zero* and *vier* are using this methods for variations.
19 Quattro is using a slightly different approach.
20
21 Third you can start your theme from scratch.
22 Which is the most complex way to change friendicas look.
23 But it leaves you the most freedom.
24 So below for a *detailed* description and the meaning of some special files.
25
26 ### Styling
27
28 If you want to change the styling of a theme, have a look at the themes CSS file.
29 In most cases, you can found these in
30
31     /view/theme/**your-theme-name**/style.css
32
33 sometimes, there is also a file called style.php in the theme directory.
34 This is only needed if the theme allowes the user to change certain things of the theme dynamically.
35 Say the font size or set a background image.
36
37 ### Templates
38
39 If you want to change the structure of the theme, you need to change the templates used by the theme.
40 Friendica themes are using [SMARTY3](http://www.smarty.net/) for templating.
41 The default template can be found in
42
43     /view/templates
44
45 if you want to override any template within your theme create your version of the template in
46
47     /view/theme/**your-theme-name**/templates
48
49 any template that exists there will be used instead of the default one.
50
51 ### Javascript
52
53 The same rule applies to the JavaScript files found in
54
55     /js
56
57 they will be overwritten by files in
58
59     /view/theme/**your-theme-name**/js.
60
61 ## Expand an existing Theme
62
63 ### Theme Variations
64
65 Many themes are more *theme families* then only one theme.
66 *duepunto zero* and *vier* allow easily to add new theme variation.
67 We will go through the process of creating a new variation for *duepunto zero*.
68 The same  (well almost, some names change) procedure applies to the *vier* theme.
69 And similar steps are needed for *quattro* but this theme is using [lessc](http://lesscss.org/#docs) to maintaine the CSS files..
70
71 In
72
73     /view/theme/duepuntozero/deriv
74
75 you find a couple of CSS files that define color derivations from the duepunto theme.
76 These resemble some of the now as unsupported marked themes, that were inherited by the duepunto theme.
77 Darkzero and Easter Bunny for example.
78
79 The selection of the colorset is done in a combination of a template for a new form in the settings and aome functions in the theme.php file.
80 The template (theme_settings.tpl)
81
82     {{include file="field_select.tpl" field=$colorset}}
83     <div class="settings-submit-wrapper">
84         <input type="submit" value="{{$submit}}" class="settings-submit" name="duepuntozero-settings-submit" />
85     </div>
86
87 defines a formular consisting of a [select](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select) pull-down which contains all aviable variants and s submit button.
88 See the documentation about [SMARTY3 templates](/help/snarty3-templates.md) for a summary of friendica specific blocks other then the select element.
89 But we don't really need to change anything at the template itself.
90
91 The template alone wont work though.
92 You make friendica aware of its existance and tell it how to use the template file, by defining a config.php file.
93 It needs to define at lest the following functions
94
95 * theme_content
96 * theme_post
97
98 and may also define functions for the admin interface
99
100 * theme_admin
101 * theme_admin_post.
102
103 theme_content and theme_admin are used to make the form available in the settings, repectively the admin panel.
104 The _post functions handle the processing of the send form, in this case they save to selected variand in friendicas database.
105
106 To make your own variation appear in the menu, all you need to do is to create a new CSS file in the deriv directoy and include it in the array in the config.php:
107
108     $colorset = array(
109         'default'=>t('default'),
110         'greenzero'=>t('greenzero'),
111         'purplezero'=>t('purplezero'),
112         'easterbunny'=>t('easterbunny'),
113         'darkzero'=>t('darkzero'),
114         'comix'=>t('comix'),
115         'slackr'=>t('slackr'),
116     );
117
118 the 1st part of the line is the name of the CSS file (without the .css) the 2nd part is the common name of the variant.
119 Calling the t() function with the common name makes the string translateable.
120 The selected 1st part will be saved in the database by the theme_post function.
121
122     function theme_post(&$a){
123         // non local users shall not pass
124         if(! local_user())
125             return;
126         // if the one specific submit button was pressed then proceed
127         if (isset($_POST['duepuntozero-settings-submit'])){
128             // and save the selection key into the personal config of the user
129             set_pconfig(local_user(), 'duepuntozero', 'colorset', $_POST['duepuntozero_colorset']);
130         }
131     }
132
133 Now that this information is set in the database, what should friendica do with it?
134 For this, have a look at the theme.php file of the *duepunto zero*.
135 There you'll find somethink alike
136
137         $colorset = get_pconfig( local_user(), 'duepuntozero','colorset');
138         if (!$colorset)
139             $colorset = get_config('duepuntozero', 'colorset');
140         if ($colorset) {
141             if ($colorset == 'greenzero')
142                 $a->page['htmlhead'] .= '<link rel="stylesheet" href="view/theme/duepuntozero/deriv/greenzero.css" type="text/css" media="screen" />'."\n";
143             /* some more variants */
144         }
145
146 which tells friendica to get the personal config of a user.
147 Check if it is set and if not look for the global config.
148 And finally if a config for the colorset was found, apply it by adding a link to the CSS file into the HTML header of the page.
149 So you'll just need to add a if selection, fitting your variant keyword and link to the CSS file of it.
150
151 Done.
152 Now you can use the variant on your system.
153 But remember once the theme.php or the config.php you have to readd your variant to them.
154 If you think your color variation could be benifical for other friendica users as well, feel free to generate a pull request at github so we can include your work into the repository.
155
156 ### Inheritation
157
158 Say, you like the duepuntozero but you want to have the content of the outer columns  left and right exchanged.
159 That would be not a color variation as shown above.
160 Instead we will create a new theme, duepuntozero_lr, inherit the properties of duepuntozero and make small changes to the underlying php files.
161
162 So create a directory called duepunto_lr and create a file called theme.php with your favorite text editor.
163 The content of this file should be something like
164
165     <?php
166     /* meta informations for the theme, see below */
167     function duepuntozero_lr_init(&$a) {
168         $a-> theme_info = array(
169             'extends' => 'duepuntozero'.
170         );
171         set_template_engine($a, 'smarty3');
172         /* and more stuff e.g. the JavaScript function for the header */
173     }
174
175 Next take the default.php file found in the /view direcotry and exchange the aside and right_aside elements.
176 So the central part of the file now looks like this:
177
178     <body>
179         <?php if(x($page,'nav')) echo $page['nav']; ?>
180         <aside><?php if(x($page,'right_aside')) echo $page['right_aside']; ?></aside>
181         <section><?php if(x($page,'content')) echo $page['content']; ?>
182                 <div id="page-footer"></div>
183         </section>
184         <right_aside><?php if(x($page,'aside')) echo $page['aside']; ?></right_aside>
185         <footer><?php if(x($page,'footer')) echo $page['footer']; ?></footer>
186     </body>
187
188 Finally we need a style.css file, inheriting the definitions from the parent theme and containing out changes for the new theme.
189 ***Note***:You need to create the style.css and at lest import the base CSS file from the parent theme.
190
191     @import url('../duepuntozero/style.css');
192
193 Done.
194 But I agree it is not really useful at this state.
195 Nevertheless, to use it, you just need to activate in the admin panel.
196 That done, you can select it in the settings like any other activated theme.
197
198 ## Creating a Theme from Scratch
199
200 Keep patient.
201 Basically what you have to do is identifying which template you have to change so it looks more like what you want.
202 Adopt the CSS of the theme accordingly.
203 And iterate the process until you have the theme the way you want it.
204
205 *Use the source Luke.*
206
207 ## Special Files
208
209 ### unsupported
210
211 If a file (which might be empty) exists in the theme directory, the theme is marked as *unsupported*.
212 An unsupported theme may not be selected by a user in the settings.
213 Users who are already using it wont notice anything.
214
215 ### README(.md)
216
217 The contents of this file, with or without the .md which indicates [Markdown](https://daringfireball.net/projects/markdown/) syntax, will be displayed at most repository hosting services and in the theme page within the admin panel of friendica.
218
219 This file should contain information you want to let others know about your theme.
220
221 ### screenshot.[png|jpg]
222
223 If you want to have a preview image of your theme displayed in the settings you should take a screenshot and save it with this name.
224 Supported formats are PNG and JPEG.
225
226 ### theme.php
227
228 This is the main definition file of the theme.
229 In the header of that file, some meta information are stored.
230 For example, have a look at the theme.php of the *quattro* theme:
231
232     <?php
233     /**
234      * Name: Quattro
235      * Version: 0.6
236      * Author: Fabio <http://kirgroup.com/profile/fabrixxm>
237      * Maintainer: Fabio <http://kirgroup.com/profile/fabrixxm>
238      * Maintainer: Tobias <https://f.diekershoff.de/profile/tobias>
239      */
240
241 You see the definition of the themes name, it's version and the initial author of the theme.
242 These three information should be listed.
243 If the original author is not anymore working on the theme, but a maintainer has taken over, the maintainer should be listed as well.
244 The information from the theme header will be displayed in the admin panelö.
245
246 Next crucial part of the theme.php file is a definition of an init function.
247 The name of the function is <theme-name>_init.
248 So in the case of quattro it is
249
250     function quattro_init(&$a) {
251       $a->theme_info = array();
252       set_template_engine($a, 'smarty3');
253     }
254
255 Here we have set the basic theme information, in this case they are empthy.
256 But the array needs to be set.
257 And we have set the template engine that should be used by friendica for this theme.
258 At the moment you should use the *smarty3* engine.
259 There once was a friendica specific templating engine as well but that is not used anymore.
260 If you like to use another templating engine, please implement it.
261
262 When you want to inherit stuff from another theme you have to *announce* this in the theme_info:
263
264     $a->theme_info = array(
265       'extends' => 'duepuntozero',
266     );
267
268 which declares *duepuntozero* as parent of the theme.
269
270 If you want to add something to the HTML header of the theme, one way to do so is by adding it to the theme.php file.
271 To do so, add something alike
272
273     $a->page['htmlhead'] .= <<< EOT
274     /* stuff you want to add to the header */
275     EOT;
276
277 The $a variable holds the friendica application.
278 So you can access the properties of this friendica session from the theme.php file as well.
279
280 ### default.php
281
282 This file covers the structure of the underlying HTML layout.
283 The default file is in
284
285     /view/default.php
286
287 if you want to change it, say adding a 4th column for banners of your favourite FLOSS projects, place a new default.php file in your theme directory.
288 As with the theme.php file, you can use the properties of the $a variable with holds the friendica application to decide what content is displayed.