Linea21

{{>toc}}

h1. Personnalisation de l'interface

h2. Les thèmes

Pour ajouter un thème, procéder en 4 étapes :

* dupliquer le dossier _/templates/public/default/_ et renommer le (par exemple en _/templates/public/montheme/_ ).

* Editer le fichier de configuration /config/define_release.ini, chercher la variable globale *THEME_LIST_PUBLIC* et agréger la nouvelle valeur comme suit : "linea21|montheme". Le _pipeline_ est le séparateur de thème.

* Rendez-vous sur l'interface d'administration, menu _configuration_. Dépliez l'onglet _look'n feel_. Votre nouveau thème apparaît et vous pouvez désormais le sélectionner.

* Modifiez les fichiers contenus dans _/templates/public/montheme/_ à votre convenance.

h2. Les templates et l'override

Vous souhaitez modifier une page ou ajouter dynamiquement du contenu en créant vos propres fonctions, c'est possible. Tous les fichiers contenus dans _/public/dist/_ peuvent être réécris. 

La logique de l'application est simple : Si l'utilisateur a défini son fichier alors celui-ci est prioritaire sur le fichier par défaut. 

Par exemple, pour la page d'accueil, linea21 charge par défaut le fichier _/public/dist/tpl_home.php_. Si vous souhaitez modifier ce fichier, copiez _tpl_home.php_ dans _/templates/public/montheme/_ et faites vos modifications. Rafraîchissez la page depuis votre navigateur, vous constaterez que les changements ont étés pris en compte.

Vous pouvez redéfinir de la même façon un fichier de l'application en utilisant un dossier d'override.

Attention, ce dossier doit contenir la même arborescence que le fichier d'origine.

Par exemple pour redéfinir le fichier de configuration de tinyMCE pour votre thème admin contenu dont le chemin est /lib/js/tinyMCE/jscripts/tiny_mce/config.js

recréer la même arborescence dans le répertoire de votre thème pour personnaliser ce fichier ce qui donnera : /templates/admin/montheme/override/lib/js/tinyMCE/jscripts/tiny_mce/config.js

h2. Le fichier _display.php_

Il est possible d'implémenter vos propres fonctions d'affichage, définir des traitements ou même re-définir les fonctions livrées avec l'application.

Prenons un exemple concret :

Je souhaite pouvoir utiliser ma propre fonction hello_world() dans le module d'actualités.

Je créer donc le fichier /templates/montheme/override/news/display.php avec le code suivant :

<pre>

<code class="php">

include_once('../news/display.php');

// no need if the default module file is included

// include_once(themePath('../news/' . SQL . '.inc.php'));

function hello_world() {

  return 'hello World !';

}

function DisplayOneNews($news_id) [

  echo hello_world();

  // la suite de mon traitement

}

</code></pre>

La première ligne de code me permet d'inclure les méthodes de base (sans avoir à les redéfinir - *version >= 1.4* ).

J'inclue le fichier SQL si je choisis de ne pas faire appel au fichier de référence du module. Dans le cas contraire (comme dans cet exemple), il est appelé automatiquement.

Je définis ma fonction hello_world() jusqu'alors inexistante.

Enfin, je re-définis la fonction DisplayOneNews() afin qu'elle réalise l'appel à ma fonction précédemment définie. Le "comportement de PHP concernant les fonctions conditionnelles":http://www.php.net/manual/fr/functions.user-defined.php va donner la priorité à la fonction définie par l'utilisateur.

h2. Ajout ou remplacement de texte existant

*

Uniquement en version >= 1.4*

Il est possible d'ajouter ou modifier des textes existants. Vous pouvez le faire directement dans vos templates ou bien en changeant directement la valeur des fichiers de l'application. Mais cela n'est ni très propre ni évolutif!

2 méthodes s'offrent alors à vous. Chacune d'entre elles disposant d'avantages et inconvénients :

 - la première consiste à créer un fichier dans le dossier _/languages/XX/_ (ou XX est le code de langue - par exemple _fr_ ). Les variables définies sont partagées par l'interface d'administration et l'interface publique. Vos variables sont connus de l'application quelque soit le thème que vous utilisez. Vous devrez penser à sauvegarder ce fichier quand vous migrerez vers une nouvelle version de l'application.

 - la seconde place les fichiers définis par l'utilisateur au sein du dossier template (par exemple _/templates/public/montheme/override/languages/fr_). Cela permet de donner des valeurs différentes aux variables selon l'interface (publique ou administration). Cela signifie aussi que vous ne retrouverez plus vos variables si vous changez de thème. L'avantage est que vos fichiers ne se mélangent pas à ceux de l'application, permettant ainsi une migration plus aisée.

Quelque soit la méthode utilisée (et notez que les deux peuvent être combinées), la règle de nommage des fichiers est unique : ils doivent être préfixé du caractère _ (underscore).

Je crée, par exemple, un fichier _/languages/fr/_myfile.php_ contenant :

<pre>

<code class="php">

_def('news', 'widget_meteo', 'Voir la météo');

_def('menu_alt', 'search_here', 'terme de recherche');

</code></pre>

Première ligne, j'ajoute une variable jusque là inexistante. L'appel de la fonction *_t('news', 'widget_meteo')* m'affichera "_Voir la météo_".

La ligne 2 redéfinit une valeur existante. L'appel de *_t('menu_alt', 'search_here')* ne me renverra plus la valeur "_Votre recherche ici..._" (par défaut) mais "_terme de recherche_".

En cas de mise à jour de l'application, copier-coller les fichiers utilisateurs afin de restaurer vos valeurs.

Par ailleurs, afin de vous laisser organiser votre application, il est possible de créer autant de fichiers que vous le souhaitez afin de mieux les différencier :

<pre>

/languages/fr/_input_news.php

/languages/fr/_input_project.php

/languages/fr/_input_workshop.php

[...]

</code></pre>

h2. Editeurs WYSIWYG

Dans l'interface d'administration, vous pouvez remplacer les champs de saisie simples par un Editeur WYSIWYG de votre choix parmis "CKEditor":http://ckeditor.com/, "Tiny MCE":http://tinymce.moxiecode.com/ et "FckEditor":http://www.fckeditor.net/.

Pour activer l'édition WYSIWYG depuis le module de configuration de l'interface d'administration, remplacez la valeur de la constante *RICH_TEXT_EDITOR* (par défaut à cke) par *cke*, *fck*,*tinymce* ou *0* (désactivé).

Par défaut, un interface simple est proposée pour chacun de ces éditeurs. Référez vous à leur documentation respective pour paramétrer votre éditeur en fonction de vos besoins.

* http://ckeditor.com/

* http://tinymce.moxiecode.com/

* http://www.fckeditor.net/

Les fichiers de configuration se trouvent dans _/lib/js/_ :

* pour CKeditor : _/lib/js/ckeditor/config.js_

* pour tinyMCE : _/lib/js/tinymce/jscripts/tiny_mce/config.js_ (voir le tutoriel de "configuration [[TinyMCE]]":http://dev.linea21.com/wiki/tinymce réalisé par "Eribar":http://dev.linea21.com/wiki/user/eribar)

* pour FCKeditor : _/lib/js/fckeditor/fckconfig.js_

Référez-vous au système "d'override":http://dev.linea21.com/wiki/Personnalisation%20de%20l%27interface#Lestemplatesetloverride afin d'assurer la pérennité de votre configuration personnelle.

Si aucun éditeur WYSIWYG n'est activé, le système autorisera seulement les balises HTML contenu dans la constante ALLOWABLE_TAGS.

*Attention:* le système de templates fournis nativement avec Linea21 n'est pas compatible à 100 % avec l'activation des éditeurs WYSIWYG. Si vous activez un éditeur WYSIWYG et vous souhaitez ajouter des images, préférez la prise en charge des images par l'éditeur lui-même.