BootStrap v2 pour SPIP

Documentation source http://spipr.nursit.com/bootstrap

Présentation

PNG - 39.6 ko

BootStrap est un framework qui facilite et accélère le développement Front-End. Il inclue

  • une base CSS très complète (au format LESS) configurée à partir d’un fichier de variables
  • un ensemble de conventions de structure HTML et de nommage de classes
  • des librairies javascripts simples pour les fonctions les plus courantes

BootStrap dispose d’une documentation détaillée qui facilite sa prise en main.

BootStrap pour SPIP

Un plugin BootStrap pour SPIP facilite l’intégration de BootStrap v2. Le plugin intègre toutes les CSS de BootStrap (v2.3.2) et y ajoute une couche d’adaptation à SPIP.

Adaptation au markup de SPIP

Le plugin intègre les CSS de BootStrap sans modification, mais y ajoute une couche d’adaptation au HTML générée par SPIP. Ainsi, les formulaires de SPIP qui utilisent un markup HTML différent de celui proposé par BootStrap bénéficient tout de même des styles de BootStrap. Si vous ajoutez vos propres formulaires, vous pouvez aussi bien utiliser le markup de BootStrap ou celui de SPIP, selon vos habitudes.

Les tableaux générés par SPIP à partir du contenu éditorial héritent aussi des styles de BootStrap.

De plus le plugin adapte le markup de la pagination de SPIP pour qu’elle bénéficie des styles de BootStrap.

Typographie

La typographie proposée nativement par SPIP dans son squelette par défaut est de meilleure facture que celle de BootStrap. Elle est également plus accessible car implémentée en em et non en px.
Le plugin BootStrap pour SPIP reprend donc la partie typographie de SPIP pour ces raisons.

#grid
PNG - 8.3 ko

Le plugin BootStrap pour SPIP intègre également l’outil de visualisation de la grille #grid. Il permet aux webmestres d’afficher la grille utilisée. Il est configuré pour se caler par défaut sur les 3 grilles de BootStrap (en fonction de la largeur de l’écran) et vous pouvez donc directement l’utiliser.

LESS
PNG - 12.5 ko

Pour permettre de travailler directement dans les feuilles de styles au format LESS sans passer par une étape de compilation manuelle, le plugin BootStrap nécessite le plugin LessCSS pour SPIP qui se charge de compiler automatiquement à la volée les feuilles LESS au format CSS.

BootStrap dans SPIPr

Tous les styles de BootStrap sont inclus dans les pages du squelette SPIPr, et il est donc possible d’utiliser l’ensemble du markup proposé dans la documentation de BootStrap et de bénéficier des styles et affichages prévus.
Dans le cas des formulaires, il est possible aussi d’utiliser la convention de balisage proposée dans SPIP, qui est intégralement prise en charge par l’adaptation de BootStrap à SPIP.

En revanche, la plupart des javascripts de BootStrap ne sont pas intégrés par défaut et vous devrez donc les ajouter dans vos squelettes pour utiliser les fonctionnalités correspondantes de BootStrap.

Page de démonstration

Le plugin BootStrap pour SPIP intègre plusieurs pages de démonstration dans le dossier demo/.

La page principale de démonstration est visible à l’adresse spip.php?page=demo/bootstrap [1]. Cette page reprend tous les éléments d’interface pris en charge par BootStrap, ainsi qu’une charte typographique qui permet de vérifier l’affichage de tous les enrichissements typographiques usuels.

PNG - 68.2 ko
Page de démonstration du plugin BootStrap

Organisation des fichiers

Le plugin BootStrap pour SPIP est organisé en deux sous dossiers bootstrap/ et bootstrap2spip/ :

 bootstrap/
 	 bootstrap/
 	 	 css/
 	 	 	 fichiers LESS de BootStrap
 	 	 img/
 	 	 	 images glyphicons de BootStrap
 	 	 js/
 	 	 	 fichiers javascripts de BootStrap
 	 bootstrap2spip/
 	 	 css/
 	 	 	 surcharges des fichiers LESS de BootStrap
 	 	 	 boot-theme.less feuille vide dispo pour la personnalisation
 	 	 	 bootswatch.less feuille vide dispo pour la personnalisation
 	 	 	 spip.css quelques styles spécifiques au code généré par SPIP
 	 	 	 spip.list.less styles du module de liste
 	 	 	 spip.comment.less styles des commentaires
 	 	 formulaires/
 	 	 	 charter.html formulaire SPIP de démonstration
 	 	 	 recherche.html formulaire de recherche SPIP adapté à BootStrap
 	 	 js/
 	 	 	 hashgrid.js #grid
 	 	 	 html5.js support de HTML5 pour les vieux navigateurs
 	 	 modeles/
 	 	 	 modèles de pagination SPIP adaptés à BootStrap

Surcharges des feuilles LESS

Le dossier bootstrap2spip/ contient des feuilles de style LESS qui surchargent celles de BootStrap. Voyons un exemple concret avec la feuille alerts.less :

Ici on voit que la surcharge pour SPIP utilise complètement le fichier natif de BootStrap en lui ajoutant simplement quelques définitions qui héritent de BootStrap. C’est le cas de la plupart des surcharges du dossier bootstrap2spip/ à l’exception de la typographie complètement reprise de SPIP.

Utiliser la surcharge

Lors de la compilation des fichiers LESS, le plugin LessCSS interprète chaque directive @import en recherchant le fichier demandé dans le chemin de SPIP, incluant les plugins et le dossier squelettes/.

Ainsi, si vous écrivez @import "css/alerts.less", SPIP va rechercher le fichier css/alerts.less dans squelettes/ puis dans tous les dossiers déclarés par les plugins.
Dans le plugin BootStrap, la recherche se fera d’abord dans le dossier bootstrap2spip/ pour voir si une surcharge spécifique à SPIP existe, puis dans bootstrap/ pour prendre le fichier natif de BootStrap sinon.

Vous pouvez donc personnaliser finement les surcharges de BootStrap de la façon suivante :
Par exemple

  • vous pouvez annuler l’adaptation à SPIP pour le fichier css/alerts.css en mettant le contenu suivant dans squelettes/css/alerts.css :
  • vous pouvez compléter l’adaptation à SPIP avec vos propres compléments. Pour le fichier css/alerts.css, en mettant le contenu suivant dans squelettes/css/alerts.css :

De manière générale, il faut éviter de surcharger des fichiers LESS de BootStrap pour bénéficier des mises à jour de ces fichiers lors de la mise à jour du plugin.

Pour la personnalisation de son site, il est préférable d’utiliser les 2 fichiers css/boot-theme.less et css/bootswatch.less qui ont été ajoutés et sont par défaut vides. Ils permettent d’ajouter des personnalisations CSS de BootStrap, qui seront compilées avec l’ensemble des feuilles de BootStrap (ce qui permet d’utiliser tous les mixins de BootStrap).

Images dans les feuilles LESS

Un point auquel il faut faire attention avec les feuilles LESS concerne les chemins relatifs vers les images de décoration : le fonctionnement est différent de ce qu’on peut avoir l’habitude dans les feuilles CSS.

Dans une feuille CSS, si on utilie le code url(../img/deco.png) le chemin relatif ../img/deco.png s’interprète par rapport à l’emplacement du fichier CSS.

Dans une feuille LESS, avec le même code, le chemin relatif s’interprète par rapport à l’emplacement du fichier LESS principal compilé. Cela fait une différence importante lorsque la directive @import est utilisée.
En effet, dans ce cas c’est toujours l’emplacement du fichier principal, celui qui fait les @import, qui est pris en référence, et non l’emplacement du fichiers inclus, même si c’est lui qui référence l’image.

Dans le cas de BootStrap, cela veut dire que c’est l’emplacement du fichier bootstrap.less qui est pris en compte. Ainsi, pour utiliser une image dans un fichier LESS personalisé de BootStrap, il convient de donner un chemin relatif par rapport au fichier bootstrap.less.

La solution consiste alors à copier le fichier bootstrap.less dans votre dossier squelettes/, à côté de votre fichier personnalisé, sans oublier d’y copier aussi le dossier img/ avec les glyphicons. C’est assez peu pratique, et de manière générale c’est évitable en ajoutant les images de décoration dans un fichier LESS qui n’est pas inclus par bootstrap.less mais directement par le squelette SPIPr.

Notes

[1il faut avoir le statut de webmestre pour voir cette page

[2Attention à la version de BootStrap que les outils supportent : lorsque c’est une version plus ancienne que celle utilisée par SPIPr, certaines variables peuvent manquer dans les feuilles générées