havefnubb/hfnuthemes-module

Jelix module allowing to select a theme for the application

v1.6.0 2021-08-21 21:51 UTC

Requires

• php: >=5.6

LGPL-2.1-only

• FoxMask
• Laurent Jouanneau

• admin
• themes
• module
• jelix

README

This is a module for Jelix, to select a theme for the application.

This module is for Jelix 1.7.2 and higher.

It was originally developped into the Havefnubb project.

Setting up the module

The best method is to use Composer.

In a commande line inside your project, execute:

composer require "havefnubb/hfnuthemes-module"

Launch the configurator for your application to enable the module

php dev.php module:configure hfnuthemes

After configuring the module, you should launch the installer of your application to activate the module:

php install/installer.php

Providing a theme

Themes should be installed into app/themes/ (themes bundled with the application) or into var/themes (themes installed by the user).

These directories should contain a directory for each theme, containing templates, as described into the Jelix documentation. Css and images of templates should be installed into www/themes/.

For hfnuthemes, a JSON file theme.json should be saved into each theme directory.

Example of a content of theme.json:

{
  "name": "Default",
  "createddate": "2009-09-01",
  "label": {
    "en_US": "Default Theme",
    "fr_FR": "Thème Principal"
  },
  "description": {
    "en_US": "Default theme  of HaveFnuBB!",
    "fr_FR": "Thème Principal de HaveFnuBB! ",
  },
  "licence": {
    "url": "http://www.gnu.org/licenses/gpl.html",
    "description": "GNU General Public Licence"
  },
  "copyright": "2008-2011 FoxMaSk",
  "creator": {
    "name": "FoxMaSk",
    "email": "[e-mail]",
    "active": true
  },
  "homepageURL": "http://www.havefnubb.jelix.org/",
  "updateURL": "",
  "version": "1.0.1"
}

In the web directory of the theme (for example www/themes/theme_name/), you should save a theme.png file, displaying a screenshot or the logo of the theme.