Discussion aide:Documenter un modèle

Méthode de documentation "systématique" ?

Je ne remet pas ici en cause la manière dont la documentation doit être agencée : elle est complète, informative et fait en sorte d'éviter les éditions abusives de modèles importants, notamment les infobox.
Cependant, je pense que cette manière de faire ne devrait pas s'appliquer systématiquement avec certains types de modèles très simples, par exemple les bandeaux qui ne contiennent aucun paramètre à définir (en tout cas rarement plus d'un) et qui sont pour la plupart d'entre eux auto-descriptif.
Est-il réellement nécessaire de se plier aux exigences de ce manuel en ce qui concerne les modèles faciles à comprendre et à utiliser ? Ne pourrait-on pas rendre leur documentation moins inutilement épaisse ?
-- Ίηνō¢Ќ ^{( -Kẅαάκ ?- )} 23 juin 2011 à 20:22 (UTC)

C'est en l'appliquant sur des modèles "simples", comme Modèle:Répétiteur, que l'on se rend compte que finalement, c'est pas bien épais. Ce sera donc encore moins le cas sur des modèles sans arguments.

Zhu' 23 juin 2011 à 20:42 (UTC)

C'est vrai, mais ça permet également de voir que certaines choses ne sont pas forcément nécessaires à chaque fois. La légende pour les icônes des paramètres n'a par exemple pas vraiment de raison d'être dans cette doc.

En fin de compte, ne serait-il pas possible de considérer un doc comme complète même si elle ne contient pas 100% du contenu détaillé ici ?

-- Ίηνō¢Ќ ^{( -Kẅαάκ ?- )} 23 juin 2011 à 20:47 (UTC)

Je préfère qu'on ne fasse pas d'exception pour le moment. Je vais coder le bot de vérification en juillet, le tester, et à partir de là on verra quels ajustements seront nécessaires - en attendant, c'est plus facile pour moi de ne gérer qu'un seul type de structure.

--Misdre 1 juillet 2011 à 10:00 (UTC)

Une documentation auto-évaluée??

Depuis quelque temps, j'ai commencé à corriger les principaux défauts des modèles en Catégorie à revoir.
Toutefois, j'ignore si les bots (ou utilisateurs humains) qui catégorisent comme à revoir sont en mesure de réévaluer les modèles ne fois documentés. Je me demande donc si la documentation doit être auto-évaluée par le contributeur qui la crée ou si un bot ou un admin ou un relecteur doit repasser derrière pour vérifier que le modèle (et sa doc) est (sont) bien dans les cadres définis DJMFan (discussion) 29 août 2016 à 22:55 (UTC).

Salut. Je pense qu'il y a malheureusement des modèles qui sont marqués "à revoir" par des contributeurs qui ne sont pas toujours aptes à faire les modifications qu'ils ont en tête. Il suffit de voir le nombre de créations laissées en "ébauche" ou "incomplet" par les créateurs des articles... :(

Il n'y a pas de bot vérificateur de documentation, ça reste un travail humain principalement à réaliser par le créateur (ou modificateur) du modèle concerné. Ceci-dit, toute modification de modèle ou doc effectuée par un non-relecteur est au minimum regardée par un relecteur par la suite. --Mewtwo Ex (discussion) 29 août 2016 à 23:22 (UTC)

Pour avoir une info de plus et rebondir sur les modèles "délaissés", ne devrait-on pas ajouter une "exception" pour le bot quand le modèle a finalement été refusé, l’intérêt de la création/de l'enrichissement de sa page de documentation étant inexistant? DJMFan (discussion) 1 septembre 2016 à 06:32 (UTC)

Sauf que, comme je te l'ai dis, ça ne serait de toute façon pas très évident de faire un bot capable d'évaluer la qualité de la doc ^^' --Mewtwo Ex (discussion) 1 septembre 2016 à 23:55 (UTC)

En fait dans mon idée, le bot déclassait les pages catégorisées comme Modèle refusé sans chercher à évaluer la qualité de la doc.
cela reste peut-être impossible, en ce cas, désolé de faire perdre du temps DJMFan (discussion) 2 septembre 2016 à 08:34 (UTC)

Proposer un modèle

Bonjour ! J'aimerais proposer un modèle ; en venant sur cette page, je croyais pouvoir trouver ce qu'il fallait faire, mais je ne comprends pas grand-chose... Ce sont surtout les balises "includeonly" et "noinclude" qui m'intriguent, sans compter le reste de l'article... Si on pouvait me donner un exemple de modèle illustrant parfaitement le contenu de l'article, je serai très reconnaissant ! Évolimiqui 10 juin 2017 à 17:58 (UTC)

Voir Aide:Modèle. Le but de la page Aide:Documenter un modèle est d'expliquer comment rédiger une page d'explication du fonctionnement du modèle. --Mewtwo Ex (discussion) 10 juin 2017 à 18:40 (UTC)

Ça fait un moment que j'étudie le sujet, et je peine à comprendre... Si vous voulez que je puisse proposer un nouveau modèle, laissez-moi du temps, SVP. Évolimiqui 13 juin 2017 à 17:32 (UTC)

Après une étude régulière et forcée, je pense peut-être avoir (enfin) compris l'intérêt de la balise "noinclude" : elle servirait à pouvoir écire un texte sans qu'il ne soit inclus dans un modèle, de manière à ce que le texte n'apparaisse pas lorsqu'on utilise le modèle, c'est ça ? Par contre, je bloque encore sur la fonction de la balise "includeonly"... Évolimiqui 17 juin 2017 à 13:40 (UTC)

C'est ça, quant à la balise "includeonly", c'est l'inverse : le texte n'apparaît pas sur la page du modèle, il apparaît seulement quand le modèle est utilisé. --XFusio (discussion) 17 juin 2017 à 20:43 (UTC)

Ok, j'en prends note ! J'ai vraiment été long à comprendre ça... Mais bon, je n'ai plus qu'à commencer ! Évolimiqui 17 juin 2017 à 21:44 (UTC)

Est-ce que les balises "noinclude" et "includeonly" sont obligatoires ? Évolimiqui 18 juin 2017 à 09:23 (UTC)

Sur le principe non, mais en pratique il y aura toujours quelque chose à mettre dans un noinclude au minimum : le lien vers la doc du modèle. --Mewtwo Ex (discussion) 18 juin 2017 à 21:45 (UTC)

Ce qui donne <noinclude>[[Modèle:NomDuModèle/Documentation]]</noinclude> ? Évolimiqui 19 juin 2017 à 15:54 (UTC)

Pour le principe, je vais essayer de répondre de la manière la plus concise et explicative possible : lorsque l'on crée un modèle, le premier code à taper est :
{{/Documentation}} ce qui crée automatiquement un lien vers la page de documentation du modèle. Le balisage <noinclude></noinclude> permet de faire en sorte que chaque appel au modèle n'affiche pas avec la documentation (ce qui, entre nous, serait assez embêtant surtout pour les infobox).
Le balisage "includeonly" autour du code du modèle permet quant à lui de n'afficher que la documentation sur la page du modèle, permettant aux contributeurs débutants ou expérimentés d'avoir un accès simple et rapide à cette documentation.
En fait, le balisage permet surtout deux choses :

1. Ne pas faire apparaître le code du modèle (trop souvent complexe et pas à jour)
2. Donner un accès simplifié aux informations d'utilisation sans perturber ladite utilisation.

Dans tous les cas, avant d'être accepté, un modèle doit être discuté, moyennant quoi il est toujours possible de l'expliciter sur la page [[Discussion Modèle:NomDuModèle]].
Au passage, et si le besoin s'en fait sentir, on peut toujours trouver de la doc' (si on a la patience) sur les balises (parce que oui, il y en a (beaucoup) d'autres) en cherchant sur le wiki du mediawiki wikiception.
Sinon, maintenant que je commence à piger le truc, je peux filer un coup de main à ceux qui le veulent.
DJMFan (discussion) 19 juin 2017 à 20:33 (UTC)qui espère qu'il a plus aidé qu'embrouillé.

C'est donc censé être comme ça, si on ne compte pas les balises "nowiki" ? Évolimiqui 20 juin 2017 à 16:28 (UTC)

Presque, par convention, on a décidé que sur Poképédia, les pages du modèle ne contiendraient que le code, donc la catégorie se trouve sur la page de documentation entre balises "includeonly". Dans ton cas, cela donne :

<noinclude>{{/Documentation}}</noinclude><includeonly>Ton modèle et son code</includeonly>

Sur la page de doc', la conclusion est<includeonly>[[Catégorie:Modèle pour utilisateur]]</includeonly> <noinclude>[[Catégorie:Aide de modèle]]</noinclude> DJMFan (discussion) 20 juin 2017 à 18:58 (UTC)

Merci ! Je touche au but ! J'y suis presque ! Évolimiqui 21 juin 2017 à 16:09 (UTC)