Extension:TemplateStyles
![]() État de la version : stable |
|
---|---|
Implémentation | Balise , ContentHandler , Accroche |
Description | Permet, à partir d'un modèle, de charger des feuilles de styles CSS normalisées (sanitized CSS). |
Auteur(s) | |
Dernière version | Continuous updates |
Politique de compatibilité | Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière. |
MediaWiki | 1.30+ |
PHP | 7.3+ |
Licence | Licence publique générale GNU v2.0 ou supérieur |
Téléchargement | |
|
|
<templatestyles src=... /> |
|
Traduire l’extension TemplateStyles sur translatewiki.net si elle y est disponible | |
Problèmes | Tâches ouvertes · Signaler un bogue |
L'extension TemplateStyles introduit une balise <templatestyles>
pour spécifier qu'une feuille de style doit être chargée d'une page wiki.
En l'insérant dans un modèle celui-ci pourra avoir des styles personnalisés sans avoir à les mettre dans MediaWiki:Common.css .
Voir Aide:TemplateStyles pour les instructions concernant l'utilisation de l'extension en tant qu'éditeur sur un wiki.
Utilisation
D'abord la page CSS doit être créée. Par défaut toute sous-page de l'espace de noms Template ayant un titre qui se termine par « .css » sera créée avec le CSS normalisé content model si elle ne contient pas d'erreurs de syntaxe.
L'ensemble des espaces de noms peut être ajusté avec $wgTemplateStylesNamespaces
, ou Special:ChangeContentModel peut être utilisé sur toute page.
Puis dans le wikicode du modèle, ajoutez la balise <templatestyles src="..." />
pour charger les styles.
Le CSS savegardé en utilisant le modèle de contenu CSS normalisé correspond strictement aux règles de validité : le CSS non valide, les règles 'at' non reconnues, et les propriétés, ou les valeurs de proriété non reconnues ou non prises en charge, ne pourront pas être sauvegardées. Si du CSS non valide est néanmoins sauvegardé, les constructions en faute seront retirées lorsque le CSS sera envoyé au navigateur.
La valeur de l'attribut src
sur la balise est le titre de la page, par défaut dans l'espace de noms Template
.
(This default can be changed via $wgTemplateStylesDefaultNamespace
.)
Par exemple, <templatestyles src="Example/styles.css" />
va charger la page « Template:Example/styles.css ».
Ceci va échouer si cette page n'existe pas ou si elle a un modèle de contenu différent de CSS normalisé.
Les styles peuvent être étendus dans la page en utilisant le paramètre facultatif wrapper
dans la balise, par exemple <templatestyles src="Example/styles.css" wrapper="div.example" />
étend les styles chargés dans n'importe quel <div class="example">
à l'intérieur du contenu principal analysé.
Toute séquence de sélection CSS simple peut être utilisée pour le paramètre wrapper
.
Ceci est fait pour permettre la comparaison côte à côte de la version courante d'un modèle avec celle du bac à sable.
L'utilisation du CSS normalisé se fait comme la transclusion des modèles, et apparaît comme une transclusion sur Special:WhatLinksHere .
Mises en garde
- Les styles ajoutés par TemplateStyles sont étendus dans
.mw-parser-output
pour éviter de falsifier l'interface utilisateur en dehors du contenu principal analysé.
- Pour utiliser TemplateStyles pour mettre en forme quelque chose comme w:MediaWiki:Protectedpagetext, vous devrez inclure le contenu du message dans
<div class="mw-parser-output">...</div>
.
- Pour utiliser TemplateStyles pour mettre en forme quelque chose comme w:MediaWiki:Protectedpagetext, vous devrez inclure le contenu du message dans
- Les styles doivent être écrits pour cibler des classes CSS spécifiques, et tout ce qui génère des éléments avec ces classes doit s'assurer d'inclure également les styles lui-même plutôt que de s'appuyer sur un autre modèle pour le faire.
- Les styles inclus par un modèle peuvent actuellement affecter le contenu de la page en dehors du contenu généré par ce modèle, mais cette capacité peut être supprimée à l'avenir et ne doit pas être invoquée. (See discussion from phab:T155813#2996589 and in phab:T176272.)
- L'inclusion de styles sur un modèle qui affecte le contenu en dehors de ce modèle entraînera la non-application de ces styles lors de la modification d'une section qui ne contient pas ce modèle. Exemple: inclure des styles sur une infobox qui affectent tous les tableaux de la page, lors de la modification d'une section qui ne contient pas l'infobox, ces tableaux ne seront pas stylisés lors de la prévisualisation de cette section.
- TemplateStyles autorisent certaines propriétés CSS non standard. Les demandes pour prendre en charge des propriétés supplémentaires doivent être faites dans les projets css-sanitizer et TemplateStyles de Phabricator.
- Les demandes doivent inclure des liens vers des documents de suivi des normes (par exemple sur w3.org) décrivant la syntaxe des propriétés demandées, et une analyse de la prise en charge du navigateur actuel pour les propriétés (par exemple, un lien vers une page caniuse.com à propos des propriétés).
- Les propriétés préfixées par le fournisseur (par exemple, tout élément commençant par
-webkit-
,-moz-
ou-ms-
) sont susceptibles d'être refusées si elles ne sont pas nécessaires pour les navigateurs modernes.
- Les règles
@font-face
doivent utiliser unfont-family
préfixé avec TemplateStyles. Ceci devrait grandement empêcher de redéfinir les fontes utilisées partout dans le document. - Pour cibler des styles basés sur les habillages, utilisez un sélecteur tel que
body.skin-vector .myClass
; la spécification de l'élémentbody
est nécessaire et doit être suivie d'un combinateur descendant (par exemple 'espace'). Les autres classes sur les élémentsbody
ouhtml
peuvent être ciblées de la même manière. 1.32+
Installation
- Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé
TemplateStyles
dans votre dossierextensions/
. - Seulement lorsque vous installez à partir de Git, exécutez Composer pour installer les dépendances PHP, en entrant
composer install --no-dev
après vous être positionné dans le répertoire de l'extension. (Voir tâche T173141 pour des complications potentielles.) - Ajoutez le code suivant à la fin de votre fichier
LocalSettings.php
:wfLoadExtension( 'TemplateStyles' );
- Configurez selon les besoins.
Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Vagrant installation:
- Si vous utilisez Vagrant , installez avec
vagrant roles enable templatestyles --provision
Configuration
Paramètre | Valeur par défaut | Commentaire |
---|---|---|
$wgTemplateStylesAllowedUrls
|
[
"audio" => [
"<^https://upload\\.wikimedia\\.org/wikipedia/commons/>"
],
"image" => [
"<^https://upload\\.wikimedia\\.org/wikipedia/commons/>"
],
"svg" => [
"<^https://upload\\.wikimedia\\.org/wikipedia/commons/[^?#]*\\.svg(?:[?#]|$)>"
],
"font" => [],
"namespace" => [
"<.>"
],
"css" => []
]
|
expressions régulières compatibles Perl (PCRE) correspondant aux URLs autorisées pour les différents types de références externes.
Les clés sont des types de références externes , les valeurs sont des tableaux d'expressions régulières (comprenant les délimiteurs) correspondant aux URLs autorisées. Les types de références externes actuels sont :
|
$wgTemplateStylesNamespaces
|
[ NS_TEMPLATE => true ]
|
Espaces de noms dans lesquels initialiser le modèle de contenu CSS normalisé pour les titres se terminant par .css .
Activer ceci pour 2 (utilisateur) ou 8 (MediaWiki) est une mauvaise idée, car cela produira un conflit avec les fichiers CSS normaux dans ces espaces de noms. |
$wgTemplateStylesPropertyBlacklist
|
[]
|
propriétés à mettre en liste noire en règles de style CSS.
L'accroche TemplateStylesPropertySanitizer permet un contrôle plus fin. |
$wgTemplateStylesAtRuleBlacklist
|
[]
|
règles 'at' à mettre en liste noire dans les feuilles de style.
Accroche TemplateStylesStylesheetSanitizer pour un contrôle plus fin. |
$wgTemplateStylesUseCodeEditor
|
true
|
indique s'il faut activer Extension:CodeEditor pour le type de contenu CSS normalisé. |
$wgTemplateStylesAutoParseContent
|
true
|
S'il est à true , le modèle de contenu CSS normalisé sera ajouté à $wgTextModelsToParse si le modèle de contenu CSS est déjà présent dans ce tableau.
S'il est à |
$wgTemplateStylesMaxStylesheetSize
|
102400
|
taille maximale (en octets) d'une feuile de style; illimité si null .
|
$wgTemplateStylesDefaultNamespace
|
NS_TEMPLATE
|
The default namespace for the src attribute of the <templatestyles> tag.
|
Autres dépendances
$wgTidyConfig
doit être configuré pour ne pas utiliser le rangement ou RemexHtml.
Si utilisé avec l'un des pilotes Raggett, une balise <templatestyles />
au milieu d'un paragraphe (y compris dans un modèle en ligne) provoquera la rupture du paragraphe à ce point.
Les autres pilotes n'ont pas été testés pour ce problème.
Erreurs possibles
Si vous rencontrez une erreur durant l'importation de pages d'un autre wiki par exemple, vous pouvez essayer d'activer $wgShowExceptionDetails dans votre LocalSettings.php
pour déterminer si vous êtes dans le cas des erreurs ci-dessous.
Class 'Wikimedia\CSS\Parser\Parser' not found
- This means a required library has not been installed. Cette erreur peut apparaître lorsque l'on essaie d'importer une page CSS du wiki ou lorsque l'on modifie le modèle de contenu d'une page avec le CSS normalisé. Il existe depuis le 16 avril 2020, un bogue ouvert dans le distributeur d'extensions qui nécessite que $1 soit exécuté dans le sous-répertoire de l'extension même lorsque celle-ci n'est pas installée à partir de Git.
Import failed: The content model 'sanitized-css' is not registered on this wiki.
- Happens when you try to import a wiki page created via TemplateStyles, but TemplateStyles is not installed on your wiki.
Voir aussi
- Aide:TemplateStyles
- css-sanitizer - utilisé pour la normalisation du CSS.
- phab:T483 « Appel à commentaires pour autoriser la mise en forme à partir de modèles » (concerne la possibilité de déployer cette extension sur les wikis Wikimedia)
- phab:T56864 « ResourceLoader: implémente la prise en charge de LESS dans les modules wiki (utilisateur et site), pour supporter par exemple MediaWiki:Common.less »
- phab:T155813 « Décide des méthodes de stockage et de diffusion pour le CSS de TemplateStyles »
- Il est maintenant plus facile de fabriquer du contenu pour les appareils mobiles : architecture du web dynamique à l'échelle de Wikipedia sur le blog Wikimedia.
- Extension:TemplateStylesExtender
![]() | Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki. |
![]() | This extension is included in the following packages and/or wiki farms: |
- Stable extensions/fr
- Tag extensions/fr
- ContentHandler extensions/fr
- Hook extensions/fr
- GPL licensed extensions/fr
- Extensions in Wikimedia version control/fr
- CodeEditorGetPageLanguage extensions/fr
- ContentHandlerDefaultModelFor extensions/fr
- ParserClearState extensions/fr
- ParserFirstCallInit extensions/fr
- All extensions/fr
- Extensions requiring Composer with git/fr
- Extensions used on Wikimedia/fr
- Extensions included in BlueSpice/fr
- Extensions included in MyWikis/fr
- Metadata/fr
- CSS/fr