TheRON/core
1
0
Fork 0
mirror of https://framagit.org/hubzilla/core.git synced 2026-06-21 00:52:33 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'improve-derived-themes' into 'dev'

Browse Source 
Add 'extends' attribute to theme info

See merge request hubzilla/core!2217
This commit is contained in:
Mario
2025-07-23 07:54:30 +00:00
parent f88d2ba0c4 88227b9155
commit 6f158f37c9
4 changed files with 96 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/en/toc.html
View File

@@ -79,6 +79,7 @@
<div id="developers" class="doco-section">
<div class="vstack">
<a class="" href="/help/developer/developers_guide">Guide</a>
<a href="/help/tutorials/derived_theme">Tutorial: Creating a derived theme</a>
</div>
</div>
</div>

96
doc/en/tutorials/DerivedTheme1.md
View File

@@ -1,96 +0,0 @@
### Creating a Derived Theme
**Lesson 1**
A derived theme takes most of the settings from its "parent" theme and lets you change a few things to your liking without creating an entire theme package.
To create a derived theme, first choose a name. For our example we'll call our theme 'mytheme'. Hopefully you'll be a bit more creative. But throughout this document, wherever you see 'mytheme', replace that with the name you chose.
**Directory Structure**
First you need to create a theme directory structure. We'll keep it simple. We need a php directory and a css directory. Here are the Unix/Linux commands to do this. Assume that 'mywebsite' is your top level hubzilla folder.
cd mywebsite
mkdir view/theme/mytheme
mkdir view/theme/mytheme/css
mkdir view/theme/mytheme/php
Great. Now we need a couple of files. The first one is your theme info file, which describes the theme.
It will be called view/theme/mytheme/php/theme.php (clever name huh?)
Inside it, put the following information - edit as needed
<?php
/**
* * Name: Mytheme
* * Description: Sample Derived theme
* * Version: 1.0
* * Author: Your Name
* * Compat: Red [*]
*
*/
function mytheme_init(&$a) {
App::$theme_info['extends'] = 'redbasic';
}
Remember to rename the mytheme_init function with your theme name. In this case we will be extending the theme 'redbasic'.
Now create another file. We call this a PCSS file, but it's really a PHP file.
The file is called view/theme/mytheme/php/style.php
In it, put the following:
<?php
require_once('view/theme/redbasic/php/style.php');
echo @file_get_contents('view/theme/mytheme/css/style.css');
That's it. This tells the software to read the PCSS information for the redbasic theme first, and then read our CSS file which will just consist of changes we want to make from our parent theme (redbasic).
Now create the actual CSS file for your theme. Put it in view/theme/mytheme/css/style.css (where we just told the software to look for it). For our example, we'll just change the body background color so you can see that it works. You can use any CSS you'd like.
body {
background-color: #DDD;
}
You've just successfully created a derived theme. This needs to be enabled in the admin "themes" panel, and then anybody on the site can use it by selecting it in Settings->Display Settings as their default theme.
**Lesson 2**
If you want to use the redbasic schemas for your derived theme, you have to do a bit more.
Do everything as above, but don't create view/theme/mytheme/php/style.php, but copy instead view/theme/redbasic/php/style.php to view/theme/mytheme/php/style.php. Modify that file and remove (or comment out) these two lines:
if(local_channel() && App::$channel && App::$channel['channel_theme'] != 'redbasic')
set_pconfig(local_channel(), 'redbasic', 'schema', '---');
Also add this line at the bottom:
echo @file_get_contents('view/theme/mytheme/css/style.css');
To show the schema selector you have to copy view/theme/redbasic/tpl/theme_settings.tpl to view/theme/mytheme/tpl/theme_settings.tpl. Modify that file and replace the lines:
{{if $theme == redbasic}}
{{include file="field_select.tpl" field=$schema}}
{{/if}}
with:
{{include file="field_select.tpl" field=$schema}}

89
doc/en/tutorials/derived_theme.md Normal file
View File

@@ -0,0 +1,89 @@
## Creating a Derived Theme
### Lesson 1 – Getting started
A derived theme takes most of the settings from its "parent" theme and lets you change a few things to your liking without creating an entire theme package.
To create a derived theme, first choose a name. For our example we'll call our theme 'mytheme'. Hopefully you'll be a bit more creative. But throughout this document, wherever you see 'mytheme', replace that with the name you chose.
#### Directory Structure
First you need to create a theme directory structure. We'll keep it simple. We need a php directory and a css directory. Here are the Unix/Linux commands to do this. Assume that 'mywebsite' is your top level hubzilla folder.
```
$ cd mywebsite
$ mkdir view/theme/mytheme
$ mkdir view/theme/mytheme/css
$ mkdir view/theme/mytheme/php
```
#### The Theme Info file
Great. Now we need a couple of files. The first one is your theme info file, which describes the theme.
It will be called `view/theme/mytheme/php/theme.php` (clever name huh?)
Inside it, put the following information - edit as needed
```php
<?php
/*
* Name: Mytheme
* Description: Sample Derived theme
* Version: 1.0
* Author: Your Name <your fedi handle (optional)>
* Extends: redbasic
*/
```
Remember to rename the `mytheme_init` function with your theme name. In this case we will be extending the theme 'redbasic'.
#### The PCSS file and style.css
Now create another file. We call this a PCSS file, but it's really a PHP file.
The file is called `view/theme/mytheme/php/style.php`.
In it, put the following:
```php
<?php
define('MY_THEME_ROOT', dirname(__DIR__));
define('PROJECT_THEME_ROOT', PROJECT_BASE . '/view/theme');
require_once(PROJECT_THEME_ROOT . '/redbasic/php/style.php');
echo file_get_contents(MY_THEME_ROOT . '/css/style.css');
```
That's it. This tells the software to read the PCSS information for the redbasic theme first, and then read our CSS file which will just consist of changes we want to make from our parent theme (redbasic).
Now create the actual CSS file for your theme. Put it in `view/theme/mytheme/css/style.css` (where we just told the software to look for it). For our example, we'll just change the body background color so you can see that it works. You can use any CSS you'd like.
```css
body {
background-color: #DDD;
}
```
You've just successfully created a derived theme. This needs to be enabled in the admin "themes" panel, and then anybody on the site can use it by selecting it in Settings->Display Settings as their default theme.
#### Theme configuration and schemas
If you want to keep the various configuration options for the derived theme, you have to add a configuration class for your child theme.
Add another file, this time in `view/theme/mytheme/php/config.php`. Add the following content to it:
```php
<?php
namespace Zotlabs\Theme;
require_once 'view/theme/redbasic/php/config.php';
class MythemeConfig extends RedbasicConfig {
}
```
We leave the class itself empty, so that it will simply inherit the configuration and settings from the parent theme, in this case Redbasic. This will automatically make the settings and scheme selection from Redbasic available to your child theme as well.

10
include/plugin.php
View File

@@ -769,7 +769,8 @@ function get_theme_info($theme){
'experimental' => false,
'unsupported' => false,
'theme_color' => '',
'background_color' => ''
'background_color' => '',
'extends' => '',
);
if(file_exists("view/theme/$theme/experimental"))
@@ -1077,10 +1078,11 @@ function theme_include($file, $root = '') {
$root = $root . '/';
$theme_info = App::$theme_info;
if(array_key_exists('extends',$theme_info))
$parent = $theme_info['extends'];
else
if(empty($theme_info['extends'])) {
$parent = 'NOPATH';
} else {
$parent = $theme_info['extends'];
}
$theme = Zotlabs\Render\Theme::current();
$thname = $theme[0];