Differences

This shows you the differences between two versions of the page.

Link to this comparison view

documentation:white-pages:0.4:config_general [2019/07/16 19:35] (current)
Line 1: Line 1:
 +====== General parameters ======
  
 +===== Configuration files =====
 +
 +To configure White Pages, you need to create a //local// configuration file named ''​config.inc.local.php''​ in ''​white-pages/​conf''​. For example :
 +<file php><?​php
 +// Override config.inc.php parameters below
 +
 +?></​file>​
 +
 +White Pages default configuration file is ''​white-pages/​conf/​config.inc.php''​. It includes ''​config.inc.local.php''​. Consequently,​ you can override all parameters in ''​config.inc.local.php''​. This prevents you to be disturbed by an upgrade.
 +
 +===== Language =====
 +
 +==== Lang ====
 +
 +<note tip>Lang is selected from browser configuration. If no matching language is found, the default language is used.</​note>​
 +
 +Available languages are:
 +  * {{:​documentation:​self-service-password:​us.png|}} English (en)
 +  * {{:​documentation:​self-service-password:​fr.png|}} French (fr)
 +
 +Set one of them in ''​$lang'':​
 +<file php>
 +$lang = "​en";​
 +</​file>​
 +
 +<​note>​Messages are translated in ''​white-pages/​lang/​LANG.inc.php''​ files, but you can define new messages or override some messages by creating a ''​white-pages/​conf/​LANG.inc.php''​ file.</​note>​
 +==== Date ====
 +
 +If you use the ''​date''​ value displayer, you can configure here date specifiers (see [[http://​php.net/​strftime|strftime reference]]):​
 +<file php>
 +$date_specifiers = "​%Y-%m-%d %H:%M:%S (%Z)";
 +</​file>​
 +
 +===== Graphics =====
 +
 +==== Logo ====
 +
 +You change the default logo with your own. Set the path to your logo in ''​$logo'':​
 +<file php>
 +$logo = "​images/​ltb-logo.png";​
 +</​file>​
 +
 +==== Background ====
 +
 +You change the background image with your own. Set the path to image in ''​$background_image'':​
 +<file php>
 +$background_image = "​images/​unsplash-space.jpeg";​
 +</​file>​
 +
 +
 +==== Hover effect ====
 +
 +You can define which [[http://​ianlunn.github.io/​Hover/​|Hover]] effect is applied to search result and gallery boxes:
 +<file php>
 +$hover_effect = "​grow";​
 +</​file>​
 +
 +==== Custom CSS ====
 +
 +To easily customize CSS, you can use a separate CSS file:
 +<file php>
 +$custom_css = "​css/​custom.css";​
 +</​file>​
 +
 +==== Footer ====
 +
 +You can hide the footer bar:
 +<file php>
 +$display_footer = false;
 +</​file>​
 +
 +===== Default page =====
 +
 +By default, the welcome page is displayed. To change this:
 +<file php>
 +$default_page = "​gallery";​
 +</​file>​
 +
 +===== Debug =====
 +
 +You can turn on debug mode with ''​$debug'':​
 +<file php>
 +$debug = true;
 +</​file>​
 +
 +===== Smarty =====
 +
 +You need to define where Smarty is installed:
 +<file php>
 +define("​SMARTY",​ "/​usr/​share/​php/​smarty3/​Smarty.class.php"​);​
 +</​file>​