Règles de style

De Sydonie

Quand on rédige un template, il convient de respecter quelques règles concernant l'enveloppe des résultats et les déclarations de classes pour les styles, afin de garantir une homogénéité sur toutes les applications.

Éviter les micro templates

Il est certes possible de faire des templates comportant peu de mots, un simple titre,... Mais l'expérience montre que ce n'est pas une bonne pratique.

Il est préférable de créer des templates consistants, qui peuvent éventuellement être repris et utilisés comme base de travail par un développeur dans une application précise.

Malgré le risque de dividis, qui est amoindri si on respecte la règle précédente, il est préférable d'encadrer le sortie HTML d'un template par une division (ou un autre élément structurel tel nav). Et d'affecter une classe de style à cette division. Ceci permet ensuite au graphiste-intégrateur de repérer les descendants de cette division et d'y affecter les règles de style.

Noms de classes standardisés

Il convient d'éviter de donner à chaque template une classe de style spécifique. Il y a de nombreux processus et activités qui sont utilisées par de nombreux objets ou des interactions récurrentes.

Parmi ces noms standard de classes :

  • uiMessage : message de retour informant l'utilisateur que le système est en train de réaliser une action ("nous avons bien enregistré...", "merci de ...", "un mail vous a été envoyé...")
  • uiError : une classe qui s'ajoute à la précédente quand le message d'interface est destiné à indiquer une erreur
  • mainForm : pour des dvision appartenant à des formulaires qui sont placés dans la zone principale (pour les distinguer des formulaires, en général stylés différemment, qui apparaîssent dans le header ou les colonnes d'une page).

Organisation des répertoires de templates

Chaque classe d'objet de Sydonie dispose potentiellement d'un répertoire de templates. Il est préférable d'organiser ce répertoires en sous-dossier cohérents, ayant des noms standardisés (et éventuellement certains dossiers représentant la logique des actions portées sur cet objet qui sont alors spécifiques).

Ceci est décrit dans la page Nommage des templates, best practices