Modèle:Roadmap/doc

Ce modèle génère une roadmap visuelle pour suivre les fonctionnalités, mises à jour et projets. Il s'intègre au design du skin Citizen et respecte automatiquement les modes clair et sombre.

Utilisation

Le Module:Roadmap est appelé via le Modèle:Roadmap :

{{Roadmap
| titre = Roadmap — Serveur Nefald
| subtitle = Estimations mises à jour en juin 2025
| contenu =
@section ⚔️ Gameplay
item ;; done       ;; Système de classes           ;; desc=Guerrier, mage et assassin   ;; tag=gameplay       ;; date=Jan 2025
item ;; inprogress ;; Économie de base             ;; desc=Monnaies, marchands, échanges ;; tag=gameplay       ;; date=Fév 2025
item ;; planned    ;; Guildes et alliances         ;; desc=Création, membres, guerres   ;; tag=gameplay
item ;; idea       ;; Arène JcJ saisonnière        ;; desc=Tournois avec classement ELO ;; tag=gameplay,event

@section 🗺️ Contenu & Monde
item ;; done       ;; Carte principale Zone 1      ;; tag=contenu        ;; date=Jan 2025
item ;; inprogress ;; Zone 2 — Les Marécages       ;; tag=contenu
item ;; cancelled  ;; Zone aquatique               ;; desc=Reporté indéfiniment         ;; tag=contenu

@section 🛠️ Technique & Wiki
item ;; done       ;; Mise en place du wiki        ;; tag=wiki           ;; date=2025
item ;; inprogress ;; Module Roadmap Lua           ;; tag=wiki
item ;; planned    ;; Bot Discord ↔ Wiki           ;; desc=Synchronisation automatique  ;; tag=technique,discord
}}

Syntaxe

Séparateur

Note: Le séparateur entre les champs d'un item est ;; (double point-virgule), pas le caractère |. En effet, le pipe | est interprété par MediaWiki comme séparateur de paramètre du modèle, ce qui tronque le contenu avant que le module Lua ne le reçoive.

Paramètres du modèle

Paramètre	Obligatoire	Description	Valeur par défaut
titre	Non	Titre affiché en en-tête de la roadmap	Roadmap
subtitle	Non	Sous-titre affiché sous le titre	aucun
contenu	Oui	Contenu de la roadmap (sections et items)	vide
stats	Non	Afficher les statistiques. Mettre non pour masquer	oui
legende	Non	Afficher la légende. Mettre non pour masquer	oui

Sections

Les sections regroupent les items par catégorie. Syntaxe :

@section Titre de la section

Vous pouvez utiliser des émojis dans le titre :

@section ⚔️ Gameplay
@section 🗺️ Contenu & Monde
@section 🛠️ Technique

Items

Chaque item représente une fonctionnalité ou une tâche. Syntaxe :

item ;; statut ;; Titre de l'item ;; option1=valeur ;; option2=valeur

Exemple concret :

item ;; done ;; Système de classes ;; desc=Guerrier, mage et assassin ;; tag=gameplay ;; date=Jan 2025

Statuts disponibles

Statut	Icône	Description	Compté dans la progression
done	✓	Terminé, déployé	✓ Oui
inprogress	◉	En cours de développement	✕ Non
planned	○	Planifié, pas encore commencé	✕ Non
idea	✦	Idée, à l'étude	✕ Non
cancelled	✕	Annulé, abandonné	✕ Non (ignoré du total)

Note: Les items avec le statut cancelled sont exclus du calcul de la barre de progression.

Options des items

Option	Description	Exemple
desc	Description courte sous le titre	desc=Prévu pour 8 joueurs
tag	Tags de catégorisation (séparés par des virgules)	tag=gameplay,event
date	Date ou période	date=Jan 2025
lien	Lien wiki vers une page de détail	lien=Système de classes

Tags disponibles

Les tags suivants ont un style coloré prédéfini :

Tag	Aperçu	Usage recommandé
gameplay	gameplay	Mécaniques de jeu
technique	technique	Infrastructure, serveur
contenu	contenu	Maps, zones, monde
interface	interface	UI/UX
event	event	Événements
wiki	wiki	Pages wiki, documentation
discord	discord	Intégration Discord

Note: Tout tag non listé ci-dessus s'affichera avec un style neutre par défaut (fond gris).

Fonctionnalités automatiques

Barre de progression

La barre se calcule automatiquement :

Progression = items "done" / (total items - items "cancelled") × 100

Les items cancelled sont exclus du calcul pour ne pas fausser le pourcentage.

Statistiques

Le compteur en haut affiche automatiquement le nombre d'items par statut. Seuls les statuts ayant au moins un item sont affichés.

Légende

La légende en bas rappelle la signification de chaque icône/couleur.

Commentaires

Vous pouvez ajouter des commentaires dans le contenu avec -- en début de ligne :

-- Ceci est un commentaire, il sera ignoré
@section Ma section
-- TODO: ajouter plus d'items ici
item ;; done ;; Mon item

Les lignes vides sont également ignorées.

Exemples

Roadmap minimale

{{Roadmap
| titre = Mon Projet
| contenu =
item ;; done       ;; Étape 1
item ;; inprogress ;; Étape 2
item ;; planned    ;; Étape 3
}}

Sans statistiques ni légende

{{Roadmap
| titre = Changelog
| stats = non
| legende = non
| contenu =
item ;; done ;; Correction bug #42 ;; date=15 Jan
item ;; done ;; Nouvelle interface  ;; date=20 Jan
}}

Item inline (hors roadmap)

Vous pouvez afficher un item seul n'importe où avec :

{{#invoke:Roadmap|item|done|Ma fonctionnalité|desc=Terminée hier|tag=gameplay}}

Note: La fonction item inline utilise les pipes classiques | car les paramètres sont passés directement à #invoke, pas dans un champ contenu.

Structure des fichiers

Page	Rôle
Module:Roadmap	Code Lua principal
Modèle:Roadmap	Modèle d'appel
Modèle:Roadmap/doc	Cette documentation
Modèle:Roadmap/styles.css	Feuille de style (TemplateStyles)

Compatibilité

Composant	Version
MediaWiki	1.43+
Skin	Citizen (dark/light mode automatique)
Extensions requises	Scribunto, TemplateStyles

Dépannage

Problème	Cause probable	Solution
Aucun item affiché	au lieu de ;; comme séparateur	par ;; dans le contenu
Pas de couleurs	TemplateStyles non chargé	Vérifier que est dans le Modèle:Roadmap
Item affiché comme texte brut	Syntaxe incorrecte	Vérifier le format item ;; statut ;; titre
Statut non reconnu	Faute de frappe	Le module affiche planned par défaut
Tag sans couleur	Tag non prédéfini	Ajouter le style dans Modèle:Roadmap/styles.css
Dark mode non respecté	CSS avec couleurs fixes	Utiliser var(--color-surface-*) pour les surfaces

Ajouter un nouveau tag

1. Choisir un nom en minuscules sans espaces (ex: pvp)
2. Ajouter dans Modèle:Roadmap/styles.css :

.roadmap-tag-pvp {
  background: #fce4ec;
  color: #880e4f;
}

3. Utiliser dans un item : tag=pvp

Ajouter un nouveau statut

La modification de statuts nécessite l'édition de Module:Roadmap. Dans la table CONFIG.statuts, ajouter :

monstatut = {
  label = "Mon Statut",
  icon  = "★",
  order = 6,
},

Puis ajouter les styles CSS correspondants (.roadmap-badge-monstatut, .roadmap-stat-monstatut, .roadmap-item.roadmap-monstatut).