Modèle:Documentation/doc - Historique des versions

Hiob le 24 octobre 2025 à 16:23

2025-10-24T16:23:16Z

← Version précédente		Version du 24 octobre 2025 à 16:23
Ligne 39 :		Ligne 39 :
	Les pages <code>/doc</code> dans l’espace de noms <code>Modèle</code> sont automatiquement ajoutées à [[Catégorie:Documentation de modèle]].		Les pages <code>/doc</code> dans l’espace de noms <code>Modèle</code> sont automatiquement ajoutées à [[Catégorie:Documentation de modèle]].

	[[Catégorie:Documentation de modèle~~\|Documentation~~]]		<noinclude>[[Catégorie:Documentation de modèle]]</noinclude>

Hiob le 16 octobre 2025 à 14:05

2025-10-16T14:05:26Z

← Version précédente		Version du 16 octobre 2025 à 14:05
Ligne 1 :		Ligne 1 :
	<noinclude>		<noinclude>
	{{DISPLAYTITLE:Documentation (documentation)}}		{{DISPLAYTITLE:Documentation (documentation)}}
	<!-- NE PAS ~~utiliser~~ {{Documentation}} ici ~~pour éviter les boucles~~ -->		<!-- NE PAS INCLURE {{Documentation}} ici ! -->
	</noinclude>		</noinclude>
	~~<includeonly>~~
	== Description ==		== Description ==
	Ce modèle ~~affiche~~ la documentation ~~des modèles via une~~ sous-page <code>/doc</code>.		Ce modèle permet d’afficher automatiquement la documentation d’un modèle depuis sa sous-page <code>/doc</code>.
	~~Il gère automatiquement :~~
	~~- L'inclusion de la documentation si <code>/doc</code> existe.~~
	~~- Un message d'avertissement sinon.~~
	~~- La catégorisation dans [[Catégorie:Documentation de modèle]]~~.

	==~~= Fonctionnement technique =~~==		== Utilisation ==
	1. ~~Utilise~~ <code>~~{{FULLPAGENAME}}/doc~~</code> ~~pour localiser la documentation.~~		1. Dans le modèle principal (ex: <code>Modèle:Exemple</code>), ajoutez :
	~~2. Applique~~ <~~code~~>{{~~DISPLAYTITLE:...~~}}</~~code~~> ~~pour formater le titre.~~		<pre>{{Documentation}}</pre>
	3. ~~Catégorise uniquement les pages du namespace~~ <code>Modèle~~</code> se terminant par <code>~~/doc</code>.		2. Créez une sous-page <code>Modèle:Exemple/doc</code> avec la documentation.

	== ~~Syntaxe ==~~		== Exemple de structure pour une page /doc ==
	~~<code>{{Documentation}}<~~/~~code>~~

	== ~~Exemple complet ==~~
	~~::: Exemple avec <code>Modèle:Exemple</code>~~
	<pre>		<pre>
	~~// Dans Modèle:Exemple :~~
	~~{{Documentation}}~~
	~~</pre>~~

	~~<pre>~~
	~~// Dans Modèle:Exemple/doc :~~
	<noinclude>		<noinclude>
	{{DISPLAYTITLE:Exemple (documentation)}}		{{DISPLAYTITLE:Exemple (documentation)}}
			</noinclude>
	== Description ==		== Description ==
	Ce modèle fait X et Y.		Ce modèle fait X et Y.

	== Paramètres ==		== Paramètres ==
	~~\| Nom \|~~ Description ~~\| Obligatoire~~ \|		; param1
	\|~~------\|----------------------\|-------------\|~~		: Description du paramètre 1.
	~~\| foo \| Fait quelque chose \| Non \|~~
			; param2
			: Description du paramètre 2.

			== Exemples ==
			<pre>
			{{Exemple
			\| param1 = valeur1
			\| param2 = valeur2}}
			</pre>

	[[Catégorie:Documentation de modèle]]		[[Catégorie:Documentation de modèle]]
	~~</noinclude>~~
	</pre>		</pre>

	== ~~Règles~~ ==		== Catégorisation automatique ==
	- Les ~~sous-~~pages ~~de documentation doivent s'appeler~~ <code>/doc</code>.		Les pages <code>/doc</code> dans l’espace de noms <code>Modèle</code> sont automatiquement ajoutées à [[Catégorie:Documentation de modèle]].
	~~- Toujours encapsuler la documentation~~ dans <code>~~<noinclude>...</noinclude></code>.~~
	~~- Utiliser <code>{{DISPLAYTITLE}}~~</code> ~~pour personnaliser le titre.~~

	~~== Bonnes pratiques ==~~
	~~- Pour les modèles complexes, ajoutez :~~
	~~- Une section <code== Exemples ==</code> avec des cas concrets.~~
	~~- Une section <code== Voir aussi ==</code> pour les modèles liés.~~
	~~- Une~~ [[Catégorie:~~Modèles avancés~~]] ~~si nécessaire.~~

	~~== Dépannage ==~~
	~~- Si la documentation ne s'affiche pas :~~
	~~1. Vérifiez que <code>/doc</code> existe bien.~~
	~~2. Purgez le cache avec <code>?action=purge</code>.~~
	~~3. Vérifiez l'absence de boucles (ex: <code>/doc</code> qui inclut le modèle parent)~~.

	[[Catégorie:Documentation de modèle\|Documentation]]		[[Catégorie:Documentation de modèle\|Documentation]]
	~~</includeonly>~~

Hiob le 16 octobre 2025 à 14:02

2025-10-16T14:02:53Z

← Version précédente		Version du 16 octobre 2025 à 14:02
Ligne 1 :		Ligne 1 :
	<noinclude>		<noinclude>
	{{DISPLAYTITLE:Documentation (documentation)}}		{{DISPLAYTITLE:Documentation (documentation)}}
	<!-- NE PAS ~~INCLURE~~ {{Documentation}} ici pour éviter ~~la récursivité ! -->~~		<!-- NE PAS utiliser {{Documentation}} ici pour éviter les boucles -->
	~~<div class="mw~~-~~documentation~~-~~header" style="..."~~
	~~'''Ce modèle est utilisé sur {{PAGESINCATEGORY:Documentation de modèle\|R}} pages.'''~~
	~~[{{fullurl:Special:WhatLinksHere/Modèle:Documentation\|limit=500}} Voir les utilisations]~~
	~~</div~~>
	</noinclude>		</noinclude>
	<includeonly>		<includeonly>
	== Description ==		== Description ==
	Ce modèle ~~standardise l'affichage de~~ la documentation ~~pour les~~ modèles ~~du wiki~~.		Ce modèle affiche la documentation des modèles via une sous-page <code>/doc</code>.
	Il ~~recherche~~ automatiquement ~~une sous~~-~~page~~ <code>/doc</code> ~~et l~~'~~affiche en bas du~~ modèle ~~parent~~.		Il gère automatiquement :
			- L'inclusion de la documentation si <code>/doc</code> existe.
			- Un message d'avertissement sinon.
			- La catégorisation dans [[Catégorie:Documentation de modèle]].

	=== Fonctionnement ===		=== Fonctionnement technique ===
	1. Si <code>{{FULLPAGENAME}}/doc</code> ~~existe → l'inclut avec un titre adapté~~.		1. Utilise <code>{{FULLPAGENAME}}/doc</code> pour localiser la documentation.
	2. ~~Sinon → affiche un message incitant à créer la documentation~~.		2. Applique <code>{{DISPLAYTITLE:...}}</code> pour formater le titre.
	3. ~~Applique la [[Catégorie:Documentation de modèle]]~~ uniquement ~~aux~~ pages <code>Modèle:*/doc</code>.		3. Catégorise uniquement les pages du namespace <code>Modèle</code> se terminant par <code>/doc</code>.

	== ~~Syntaxes acceptées~~ ==		== Syntaxe ==
	~~\| Dans le modèle parent \| Résultat \|~~		<code>{{Documentation}}</code>
	~~\|-----------------------------\|-------------------------------------------\|~~
	\| <code>{{Documentation}}</code> ~~\| Affiche <code>Modèle:Nom/doc</code> si elle existe. \|~~

	== Exemple ==		== Exemple complet ==
	<~~syntaxhighlight lang="wiki"~~>		::: Exemple avec <code>Modèle:Exemple</code>
	<~~!--~~ Dans Modèle:Exemple ~~-->~~		<pre>
			// Dans Modèle:Exemple :
	{{Documentation}}		{{Documentation}}
	</~~syntaxhighlight~~>		</pre>

	<~~syntaxhighlight lang="wiki"~~>		<pre>
	~~<!--~~ Dans Modèle:Exemple/doc ~~-->~~		// Dans Modèle:Exemple/doc :
	<noinclude>		<noinclude>
	{{DISPLAYTITLE:Exemple (documentation)}}		{{DISPLAYTITLE:Exemple (documentation)}}
	~~{{Documentation}} <!-- Inclut le bloc de catégorisation -->~~
	== Description ==		== Description ==
	...		Ce modèle fait X et Y.
	</noinclude>
	</~~syntaxhighlight~~>		== Paramètres ==
			\| Nom \| Description \| Obligatoire \|
			\|------\|----------------------\|-------------\|
			\| foo \| Fait quelque chose \| Non \|

			[[Catégorie:Documentation de modèle]]
			</noinclude>
			</pre>

	== Règles ~~de nommage~~ ==		== Règles ==
	- Les sous-pages de documentation doivent s'appeler <code>/doc</code> ~~(ex:~~ <code>~~Modèle:Nom~~/~~doc~~</code>).		- Les sous-pages de documentation doivent s'appeler <code>/doc</code>.
	- ~~Le titre doit être défini via~~ <code>{{DISPLAYTITLE~~:Nom (documentation)~~}}</code>.		- Toujours encapsuler la documentation dans <code><noinclude>...</noinclude></code>.
			- Utiliser <code>{{DISPLAYTITLE}}</code> pour personnaliser le titre.

	== Bonnes pratiques ==		== Bonnes pratiques ==
	- ~~Encapsulez toujours la documentation dans <code><noinclude>...</noinclude></code>.~~		- Pour les modèles complexes, ajoutez :
	- ~~Utilisez les sections~~ <code== ~~Paramètres~~ ==</code>, <code== ~~Exemples~~ ==</code>~~, etc~~.		- Une section <code== Exemples ==</code> avec des cas concrets.
	- ~~Pour les modèles complexes, ajoutez une~~ [[Catégorie:Modèles avancés]].		- Une section <code== Voir aussi ==</code> pour les modèles liés.
			- Une [[Catégorie:Modèles avancés]] si nécessaire.

			== Dépannage ==
			- Si la documentation ne s'affiche pas :
			1. Vérifiez que <code>/doc</code> existe bien.
			2. Purgez le cache avec <code>?action=purge</code>.
			3. Vérifiez l'absence de boucles (ex: <code>/doc</code> qui inclut le modèle parent).

	[[Catégorie:Documentation de modèle\|Documentation]]		[[Catégorie:Documentation de modèle\|Documentation]]
	</includeonly>		</includeonly>

Hiob le 16 octobre 2025 à 14:00

2025-10-16T14:00:53Z

Voir les modifications

Hiob le 16 octobre 2025 à 13:58

2025-10-16T13:58:56Z

@@ Ligne 66 : / Ligne 66 : @@
+}
 </pre>
 === Compatibilité avec Lua ===

Hiob : Page créée avec «  {{DISPLAYTITLE:Documentation (documentation)}} {{Documentation}}
'''Ce modèle est utilisé sur {{PAGESINCATEGORY:Modèles utilisant Documentation|R}} pages.''' [{{fullurl:Special:WhatLinksHere/Modèle:Documentation|limit=500}} Voir les utilisa... »

2025-10-16T13:53:58Z

Page créée avec « <noinclude> {{DISPLAYTITLE:Documentation (documentation)}} {{Documentation}} </noinclude> <includeonly> <div class="mw-documentation-header" style=" background-color: #f0f0f0; border-bottom: 1px solid #ddd; padding: 0.5em; margin-bottom: 1em; font-size: 90%; "> '''Ce modèle est utilisé sur {{PAGESINCATEGORY:Modèles utilisant Documentation|R}} pages.''' [{{fullurl:Special:WhatLinksHere/Modèle:Documentation|limit=500}} Voir les utilisa... »

Nouvelle page

<noinclude>
{{DISPLAYTITLE:Documentation (documentation)}}
{{Documentation}}
</noinclude>
<includeonly>
<div class="mw-documentation-header" style="
background-color: #f0f0f0;
border-bottom: 1px solid #ddd;
padding: 0.5em;
margin-bottom: 1em;
font-size: 90%;
">
'''Ce modèle est utilisé sur {{PAGESINCATEGORY:Modèles utilisant Documentation|R}} pages.'''
[{{fullurl:Special:WhatLinksHere/Modèle:Documentation|limit=500}} Voir les utilisations]
</div>

== Description ==
Ce modèle standardise l'affichage de la documentation pour **tous les modèles** du wiki.
Il vérifie automatiquement l'existence d'une sous-page <code>/doc</code> et :
1. **Affiche la documentation** si elle existe.
2. **Affiche un message d'avertissement** si la documentation est manquante, avec un lien pour la créer.

=== Pourquoi utiliser <code>/doc</code> ? ===
- **Convention large** : Adoptée par la plupart des wikis techniques (MediaWiki.org, Fandom, etc.).
- **Compatibilité** : Plus court et plus intuitif que `/Documentation`.
- **Maintenance** : Facilite les scripts de migration ou d'analyse.

== Syntaxe ==
{{msgnw:Documentation}}

=== Paramètres ===
| Nom | Type | Description | Obligatoire |
|-----------|---------|-----------------------------------------------------------------------------|--------------|
| (aucun) | - | Le modèle s'utilise sans paramètre. | Non |

== Exemples ==

=== 1. Modèle avec documentation ===
Si [[Modèle:Exemple/doc]] existe :
<pre>
{{Exemple}}
{{Documentation}}
</pre>
→ Affiche le contenu de <code>Modèle:Exemple/doc</code> dans un cadre dédié.

=== 2. Modèle sans documentation ===
Si [[Modèle:Test/doc]] n'existe pas :
<pre>
{{Test}}
{{Documentation}}
</pre>
→ Affiche un message incitant à créer <code>Modèle:Test/doc</code>.

== Personnalisation ==
=== CSS ===
Les classes suivantes sont disponibles pour le styling :
- <code>.mw-documentation-missing</code> : Conteneur du message "documentation manquante".
- <code>.mw-documentation-notice</code> : Texte du message.
- <code>.mw-documentation-header</code> : En-tête avec le compteur d'utilisations.

Exemple pour modifier les couleurs (à ajouter dans [[MediaWiki:Common.css]]) :
<pre>
.mw-documentation-missing {
background-color: #fff5f5;
border-color: #ffcccc;
}
</pre>

=== Compatibilité avec Lua ===
Pour utiliser ce modèle dans un [[Module:|module Lua]] :
<pre>
local p = {}
function p.doc(frame)
return mw.getCurrentFrame():expandTemplate{
title = 'Documentation',
args = {}
}
end
return p
</pre>

== Bonnes pratiques ==
1. **Structure de <code>/doc</code>** :
- Toujours encapsuler la documentation dans <code><noinclude>...</noinclude></code>.
- Utiliser <code>{{DISPLAYTITLE:Nom (documentation)}}</code> pour le titre.
- Exemple minimal :
<pre>
<noinclude>
{{DISPLAYTITLE:Nom (documentation)}}
{{Documentation}}
== Description ==
...
</noinclude>
</pre>

2. **Catégorisation** :
- Ajouter [[Catégorie:Modèles documentés]] dans la page <code>/doc</code>.
- Utiliser [[Catégorie:Modèles non documentés]] pour les modèles sans <code>/doc</code> (via un [[Special:TrackingCategories|catégorie de suivi]]).

3. **Migration depuis <code>/Documentation</code>** :
- Utiliser [[Special:MovePage]] pour renommer les anciennes pages.
- Mettre à jour les liens avec [[Special:WhatLinksHere]].

== Voir aussi ==
- [[Aide:Créer un modèle]] – Guide pour créer des modèles.
- [[Modèle:Boîte de navigation]] – Pour organiser les documentations.
- [https://www.mediawiki.org/wiki/Help:Templates Documentation officielle MediaWiki] (en anglais).

[[Catégorie:Modèles système]]
[[Catégorie:Documentation]]
</includeonly>