Discussion modèle:Documentation

Une page de Wikipédia, l'encyclopédie libre.
Sauter à la navigation Sauter à la recherche
Autres discussions [liste]
  • Suppression
  • Neutralité
  • Droit d'auteur
  • Article de qualité
  • Bon article
  • Lumière sur
  • À faire
  • Archives

Apparence de la documentation[modifier le code]

Pourquoi ne pas utiliser {{Documentation modèle en sous-page}} pour ce modèle? On ne voit le lien vers la page de doc, mais seulement via l'onglet bleu modifier ? Donc on ne peut y accèder qu'en mode modification -- Xfigpower (pssst) 8 septembre 2009 à 10:02 (CEST)

Avis[modifier le code]

Étant donné que ce modèle est de plus en plus utilisé au profit de son rival {{doc modèle}}, je propose d'ajouter "__NOEDITSECTION__" ce qui justifiera la présence du "[modifier]" (en haut, à côté de "[purger]"). ~Hlm Z. [@] 7 août 2011 à 12:57 (CEST)

Non, il faut au contraire conserver la possibilité d'éditer par section quand la documentation est correctement structurée (avec des titres de sections). --Lgd (d) 7 août 2011 à 13:00 (CEST)
Oui, mais je trouve que ça fait trop de "modifier" dans une même page, surtout que les documentations sont souvent courtes. D'un autre côté, je plussoie ton argument puisque l'accessibilité en prendrait un grand coup. ~Hlm Z. [@] 7 août 2011 à 13:08 (CEST)

Regrouper les actions modifier, historique et purger, ajouter voir[modifier le code]

Bonjour, la version anglaise est plus simple : elle met côte à côte les quatre actions en début de page ([view] [edit] [history] [purge]). Je trouve cette disposition mieux que la version française qui donne deux liens [modifier] quasiment au même endroit, et aucun lien pour voir la documentation. De plus, la phrase « la documentation de ce modèle est incluse depuis sa sous-page de documentation » me semble en trop, parce que :

  • c'est le cas de quasiment toutes les documentations de modèle, le modificateur de modèle l'a vite compris ;
  • c'est le même système que les palettes de navigation qui ont « v · d · m » : on ne met pas au début de la palette « cette palette est un modèle inclus dans cet article ».


Est-ce qu'un administrateur est capable de modifier le modèle pour retirer la phrase et regrouper les quatre liens comme dans la version anglaise ?

Nodulation (d) 4 décembre 2012 à 03:25 (CET)

codes mis à jour[modifier le code]

hi i have been testing some updated codes in sandbox to be included in template documentation please go to here to check the codes Modèle:Documentation/tas de sableModèle:Documentation/bac à sable renommer par pixeltoo (d · c · b)

ce sont les codes je voudrais comprendre, si vous voulez les voir travailler cliquer sur le lien ci-dessus pour le vérifier


<!--
  Automatically add {{template sandbox notice}} when on a /sandbox page.
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
}}<!--
  Automatically add {{pp-template}} to protected templates.
-->{{template other
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
  | {{pp-template|docusage=yes}}
  | {{#if: {{PROTECTIONLEVEL:edit}}
    | {{pp-template|docusage=yes}}
    | <!--Not protected, or only semi-move-protected-->
    }}
  }}
}}<!--
  Start of green doc box.
-->{{Documentation/début boite2
| preload = {{{preload|}}}   <!--Allow custom preloads-->
| heading = {{{heading|¬}}}   <!--Empty but defined means no header-->
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}

<!--Some namespaces must have the /doc, /sandbox and /testcases 
    in talk space-->
| docspace = {{documentation/docspace}}

| 1 = {{{1|}}}   <!--Other docname, if fed-->

<!--The namespace is added in /start box2-->
| template page = {{documentation/template page}}

}}<!-- Start content --><!--
  Start load the /doc content:
  Note: The line breaks between this comment and the next line are necessary
  so  "=== Headings ===" at the start and end of docs are interpreted.
-->
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 
| 1111 = {{{content|}}}
| 0110 | 0111 = {{ {{{1}}} }}
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
| 0000 | 0100 | 0010 | 0101 = 
}}
<!--
  End load the /doc content:
  Note: The line breaks between this comment and the previous line are necessary
  so  "=== Headings ===" at the start and end of docs are interpreted.
-->{{Documentation/fin boite2
| preload = {{{preload|}}}   <!--Allow custom preloads-->
| content = {{{content|}}}
| link box = {{{link box|}}}   <!--So "link box=off" works-->

<!--Some namespaces must have the /doc, /sandbox and /testcases 
    in talk space-->
| docspace = {{documentation/docspace}}

| 1 = {{{1|}}}   <!--Other docname, if fed-->

<!--The namespace is added in /end box2-->
| template page = {{documentation/template page}}

}}<!--
  End of green doc box
--><noinclude>

<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>

178.239.50.146 (d) 17 février 2013 à 14:31 (CET)

Hi,
Sorry my english is limited. I tried one day to include a similar code but not sure that all these parameters are necessary. For example this part is particularly hard to understand :
 {{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 
| 1111 = {{{content|}}}
| 0110 | 0111 = {{ {{{1}}} }}
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
| 0000 | 0100 | 0010 | 0101 = 
 }}
So it will be difficult to argue to change it. But I m interested to include a link to facilitate the creation of a sandbox.
--pixeltoo (discuter) 24 février 2013 à 23:05 (CET)

proposition de modèle:documentation[modifier le code]

salut j'ai une suggestion à faire, je tiens à dire que nous documenttion changer de médecin ce que je veux dire par exemple quand il est dit modèle: documentation/documentation peut-on sortern vers le modèle: documentation/doc 178.239.50.146 (d) 17 février 2013 à 14:33 (CET)

Protection[modifier le code]

Ce module ne pourrait-il pas déterminé le type de protection de la page et automatiquement affiché l’icône adéquate et catégoriser le modèle dans Catégorie:Modèle semi-protégé ou Catégorie:Modèle protégé ? — Le message qui précède, non signé, a été déposé par Zebulon84 (discuter).

Oui c'est une bonne idée. Je m'en occuperai très prochainement. Hlm Z. (discuter) 16 juillet 2014 à 13:03 (CEST)
Fait Fait. – Zebulon84 (discuter) 5 août 2014 à 13:35 (CEST)

Catégorie:Modèle sans documentation[modifier le code]

Bonsoir, cette catégorie est emplie de pages utilisateurs, de pages de discussion, de portail... Elle ne devrait contenir que des pages de l'espace modèle. Merci donc de mettre en place un filtre. --FDo64 (discuter) 20 mars 2016 à 23:09 (CET)

Notification FDo64 : Fait Fait. — Zebulon84 (discuter) 29 mars 2016 à 14:54 (CEST)
C'est parfait, merci ! --FDo64 (discuter) 29 mars 2016 à 23:41 (CEST)
Bonsoir Od1n Bonsoir. Il semblerait que cette modification ait fait sauter ce filtre. Il y a actuellement 345 pages utilisateurs dans cette catégorie. Pourrais-tu le rétablir ?
Merci. --FDo64 (discuter) 30 octobre 2019 à 20:44 (CET)
J'ai essayé de relire cet ancienne modif, je pense que je n'avais pas pris en compte tous les cas de figure (preuve qu'il y en a énormément et que c'est la plaie pour la maintenabilité du code), et a priori, une simple annulation de la modif n'irait pas introduire de régression, autrement dit cela fairait plus de bien que de mal, je viens donc d'effectuer cette annulation. od†n ↗blah 31 octobre 2019 à 04:29 (CET)
Merci Od1n Clin d'œil --FDo64 (discuter) 31 octobre 2019 à 20:13 (CET)

Catégorie:Pages utilisant des balises HTML auto-fermantes non valides[modifier le code]

Voir Discussion Projet:Scribunto#Catégorie:Pages utilisant des balises HTML auto-fermantes non valides, merci. — Thibaut (会話) 17 juillet 2016 à 06:36 (CEST)

Fait Catégorisation des modules[modifier le code]

Bonjour, actuellement la Catégorie:Module en langage Lua contient 38 760 pages. Comme elle est remplie par le Module:Documentation, il faudrait le faire évoluer. Quelques pistes :

  1. Module:Carte/données/... : ils sont déjà présents dans la Catégorie:Module de paramétrage de carte. Inutile donc de les mettre dans Catégorie:Module en langage Lua.
  2. Module:Données/... créés par Notification Roland45 : on devrait les ranger dans une catégorie du style Catégorie:Module de données démographiques et les retirer de la Catégorie:Module en langage Lua.
  3. Module:Infobox/... : ils sont déjà présents dans la Catégorie:Module infobox (même si dans la réalité il y en a la moitié, montrant ainsi un problème de classification non respecté). Inutile donc de les mettre dans Catégorie:Module en langage Lua.
  4. Remarque : Ce style de filtre est déjà effectué pour la Catégorie:Module d'informations pays par le Module:Documentation, mais ne faudrait-il pas le faire à la source comme pour les cartes et ne gérer ici qu'une liste d'exceptions ?

Y aurait-il un développeur Lua pour effectuer ces modification ? Merci. --FDo64 (discuter) 17 janvier 2018 à 15:59 (CET)

Pour ma part je suis d'accord avec cette proposition concernant les modules de données démographiques ... Par contre autant je peux créer des modules de données, autant, n'étant pas un développeur lua, je ne peux toucher au module documentation.Roland45 (discuter) 17 janvier 2018 à 16:55 (CET)
Bonsoir Od1n Bonsoir. Comme indiqué en janvier 2018, la catégorisation des modules effectuée par le Module:Documentation n’est vraiment pas satisfaisante. Je viens donc proposer une autre manière.
  1. Module:Carte/données/... : déjà présent dans la Catégorie:Module de paramétrage de carte grâce au modèle {{Documentation données cartes}} appelé par MediaWiki:Scribunto-doc-page-does-not-exist à partir du Module:Carte/autodoc (fallait le trouver !!!)
  2. Module:Country data/... : déjà présent dans la Catégorie:Module d'informations pays mais à partir du Module:Documentation, je propose de créer le modèle {{Documentation module Country data}} qui s'occuperait de la catégorisation
  3. Module:Données/... : je propose de créer la Catégorie:Module de données démographiques et {{Documentation module données démographiques}}
  4. Module:Infobox/... : déjà présents dans la Catégorie:Module infobox pour ceux qui ont une documentation correcte
Peut-être que la solution serait d'adapter MediaWiki:Scribunto-doc-page-does-not-exist de la manière suivante ?
{{#switch: {{BASEPAGENAME}}
| Carte/données = {{Documentation|$1|couleur=#ecf0fc |module=1 |contenu={{Documentation données cartes}} }}
| Country data = {{Documentation|$1|couleur=#ecf0fc |module=1 |contenu={{Documentation module Country data}} }}
| Données/ = {{Documentation|$1|couleur=#ecf0fc |module=1 |contenu={{Documentation module données démographiques}} }}
| Infobox = {{Documentation|$1|couleur=#ecf0fc |module=1}}[[Catégorie:Module infobox|{{SUBPAGENAME}}]]
| {{Documentation|$1|couleur=#ecf0fc |module=1}}[[Catégorie:Module en langage Lua]]
}}
{{Projet Scribunto}}
Je n'ai pas trouvé de méthode pour faire des tests dans l'espace MediaWiki, je n'ose donc m'en charger moi-même.
Cela reste extrêmement compliqué donc toute autre idée sera forcément meilleure Mort de rire !
--FDo64 (discuter) 30 octobre 2019 à 21:22 (CET)
Notification FDo64 je rebondis ici suite à ton message ci-dessous. 2 petites remarques :
  • Le message MediaWiki:Scribunto-doc-page-does-not-exist n'apparait que pour les modèles dont la doc n'existe pas (voir la doc du message), donc ce fonctionnement n'est possible que pour les modèles sans sous-page de documentation. Pour les autres, il faut attaquer MediaWiki:Scribunto-doc-page-show (voir ceci).
  • Il me semble qu'il faudrait utiliser le paramètre 1= plutôt que contenu=, car il s'agit du paramètre dédié au chargement d'une page de doc différente, alors que contenu= sert à ajouter une doc sans page de doc justement. On devrait donc avoir, pour la version actuelle du message, plutôt un truc du genre :
{{Documentation|$1|couleur=#ecf0fc|module=1|Modèle:Documentation données cartes}}.
Epok__ (Insultes, éloges, simples discussions : ), le 31 octobre 2019 à 22:04 (CET)
Notification FDo64 J'ai fait quelques modifications. J'espère n'avoir rien cassé... N'hésitez pas à réverter l'ensemble des mes modifs sur MediaWiki:Scribunto-doc-page-does-not-exist et MediaWiki:Scribunto-doc-page-show. Bref, les modules devraient être catégorisés par défaut dans Catégorie:Module en langage Lua en l'absence de doc. Mais la doc devrait être chargée par défaut depuis un modèle (sauf si une sous-page de doc existe) pour les cas que tu as mentionnés ci-dessus. J'ai créé les modèles {{Documentation module Country data}} et {{Documentation module données démographiques}} pour la catégorisation, il faut maintenant les remplir.
À noter que de nombreux modules disposent d'une sous-page de doc se contentant d'appeler l'un des modèles ci-dessus : ce ne devrait plus être nécessaire si on conserve cette modification.
Epok__ (Insultes, éloges, simples discussions : ), le 4 novembre 2019 à 09:02 (CET)
Juste une remarque supplémentaire sur la catégorisation : il semblerait que les pages restent dans las catégorie « Module en langage Lua » jusqu'à ce qu'on les purge manuellement... Il faudrait peut-être faire passer un bot pour purger toutes les pages de cette catégorie. À moins qu'il ne faille se contenter d'attendre un mise à jour, c'est parfois un peu long. Epok__ (Insultes, éloges, simples discussions : ), le 4 novembre 2019 à 21:48 (CET)
Notification Epok : Super boulot ! Merci ! En effet, en faisant des null-edit ça remet à jour la catégorie. On peut attendre, ou faire une demande de bot, vu le nombre.
Sinon, je constate que tu n'as pas suivi mon conseil de classer les modules de données dans Catégorie:Module de données démographiques. J'aurai préféré. À faire avant la mise à jour des catégories, si tu rejoins mon avis.
Notification Roland45 : Aurais-tu un texte à proposer pour {{Documentation module données démographiques}} ?
--FDo64 (discuter) 4 novembre 2019 à 22:30 (CET)
Notification FDo64, j'ai utilsé la catégorie Catégorie:Module de données car elle existait déjà, tout simplement. L'objectif était de mettre en place l'architecture technique permettant ces catégorisations automatiques. Il suffit dorénavant de modifier {{Documentation module données démographiques}} pour changer la catégorie qui sera associée à ces modules, je te laisse la main sur la suite des opérations.
Wikipédiennement, Epok__ (Insultes, éloges, simples discussions : ), le 5 novembre 2019 à 07:35 (CET)
Notification Epok : Excellent travail ! @FDo64 OK pour remplir la page de documentation (juste un petit délai, le temps de finir le travail en cours actuel).Roland45 (discuter) 5 novembre 2019 à 08:47 (CET)
Notification Epok : Fait Fait.
Notification Roland45 : J'ai hésité à recopier le texte que tu as mis en commentaire au début de chaque module et je me suis contenté de mettre la première phrase. Á toi de voir. Merci.
--FDo64 (discuter) 5 novembre 2019 à 22:22 (CET)
Notification FDo64 : J'ai un texte plus développé en stock. Je vais voir comment l'adapter.Roland45 (discuter) 6 novembre 2019 à 08:36 (CET)
Notification FDo64 :Notification Epok : Fait Fait. J'ai ajouté un texte descriptif détaillé (exemple). Lors de l'actualisation de janvier 2020, je pourrai supprimer les infos documentaires actuellement dans le corps du module pour les faire migrer dans le modèle générique de documentation, afin de bien dissocier documentation et module.Roland45 (discuter) 6 novembre 2019 à 09:34 (CET)
Merci Roland45 Clin d'œil !
Les catégories sont maintenant plus lisibles ! --FDo64 (discuter) 6 novembre 2019 à 10:20 (CET)

Sous-pages de documentation[modifier le code]

Bonsoir Od1n Bonsoir, suite aux modifications apportées aujourd'hui, je te signale une régression sur le Modèle:Source RS Doublage dont la sous-page de documentation ne s'affiche plus à partir de {{Documentation de source}}.

Au prochain dump, je surveillerai Projet:Modèle/Maintenance/Listes pour voir s'il n'y a pas d'autres cas. --FDo64 (discuter) 16 août 2019 à 22:30 (CEST)

En réalité, il y en a plein d'autres, on les trouve dans la page spéciale. --FDo64 (discuter) 16 août 2019 à 22:33 (CEST)
Corrigé : 161881177. Merci beaucoup pour le signalement. od†n ↗blah 17 août 2019 à 00:22 (CEST)
J'ai aussi traité les modèles {{Documentation lien interne}}, {{Country showdata}} et {{Documentation boîte utilisateur}}, et j'ai retrouvé cette discussion à propos. od†n ↗blah 17 août 2019 à 01:02 (CEST)
Notification Od1n : Merci, je vais surveiller cela à la prochaine génération de la liste parce que j'ai bien peur qu'il en manque. Au hasard : Modèle:Élu2/Parti/Documentation. --FDo64 (discuter) 17 août 2019 à 01:12 (CEST)
En l'occurrence, traité {{Documentation d'une sous-page de modèle}}. De ce que j'ai vu pour l'instant, ces méta-modèles de documentation me paraissent assez "fragiles" : ça peut péter à causes de modifs faites ailleurs, gestion de tout ce qui est "sauts de lignes / lignes vides" assez hasardeuse, paramètres en profusion bazardesque… od†n ↗blah 17 août 2019 à 01:26 (CEST)
Ajout de {{Documentation palette}} à la liste des méta-modèles concernés. Voir la discussion. od†n ↗blah 31 août 2019 à 15:40 (CEST)
Notification Od1n et FDo64 :
étant l'auteur de certains de ces modèles de doc susmentionnés, et venant juste d'en créer un nouveau, je suis d'accord avec ce que tu dis sur le code un peu bordélique. Pour moi, cela vient du fait que ce modèle est utilisé pour 2 choses différentes : en tant que modèle (pour documenter des modèles) mais également en tant que méta-modèle (pour créer d'autres modèles de doc).
J'ai quelques idées pour améliorer la situation et simplifier le code. En fait, il y a 2 idées séparées, chacune pouvant être mise en œuvre indépendamment de l'autre, mais elles sont à mon sens complémentaires.
1) Tout d'abord, il faudrait remédier au double usage du modèle {{Documentation}} en tant que modèle et méta-modèle. Ça peut se faire sans toucher au module. Il suffirait de créer un modèle {{Méta documentation de modèle}}, dans lequel on mettrait le code exact du modèle {{Documentation}} actuel. Dans la doc, on indiquerait tous les paramètres existants, y compris les méta-paramètres notice, titre, couleur, message protection et module (ce dernier n'est pas documenté actuellement).
Dans un second temps, on mettrait à jour le code de tous les modèles de doc hors {{Documentation}} pour cibler le méta-modèle, puis on remplacerait le code de {{Documentation}} par un appel à {{Méta documentation de modèle}}, mais en transmettant uniquement les paramètres 1, contenu et complément. Cela permettrait d'éviter d'avoir à les documenter dans le modèle, et simplifierait la doc de la doc.
2) Dans le module, on rajouterait deux méta-paramètres : en-tête et pied, distincts du paramètre contenu et ajoutant du contenu respectivement au-dessus et en-dessous du contenu (qu'il vienne du paramètre contenu ou de la sous-page) pour prévoir cette fonctionnalité, et on éviterait ainsi de devoir tweaker dans les modèles de doc spécifiques pour utiliser contenu tout en proposant ce même paramètre, rajoutant de la complexité à tous les niveaux. Il faudrait également lever la restriction sur notice : « Elle peut-être modifiée par l'utilisateur grâce au paramètre « |notice= » dans un modèle seulement si le paramètre « |contenu= » est renseigné. »
Il y a peut-être un peu de boulot, mais on en sortirait à mon avis avec une syntaxe plus simple, et donc plus facile à entretenir, tout en faisant une distinction claire entre les usages du modèle {{Documentation}}.
Pour le point 1), je peux m'en occuper, par contre pour le point 2), je ne maîtrise pas suffisamment la syntaxe du module pour me lancer là-dedans.
Qu'en pensez-vous ?
Wikipédiennement, Epok__ (Insultes, éloges, simples discussions : ), le 31 octobre 2019 à 09:23 (CET)
Pour. Il ne faudra pas oublier que ce module sert aux modèles et aux modules.
Si par ailleurs on pouvait sortir les catégorisations des modules (Cf. discussion précédente) ce serait encore mieux.
--FDo64 (discuter) 31 octobre 2019 à 20:16 (CET)
Notification FDo64 : Si c'est le nommage que je propose ({{Méta documentation de modèle}}) qui te fait faire cette remarque sur les modules, je vois 3 solutions possibles :
  1. Simplifier le nom en {{Méta documentation}},
  2. Séparer en deux méta-modèles indépendants {{Méta documentation de modèle}} et {{Méta documentation de module}},
  3. Conserver la proposition {{Méta documentation de modèle}} et attaquer directement le module dans les pages MediaWiki:Scribunto-doc-page-does-not-exist et MediaWiki:Scribunto-doc-page-show.
La solution 1 me semble peu précise dans le nommage ; la solution 2 me semble too much pour seulement 2 appels à la doc de module ; la solution 3 en revanche permettrait de ne pas inclure le paramètre module dans le méta-modèle et sa doc, et séparerait plus précisément les usages.
Epok__ (Insultes, éloges, simples discussions : ), le 31 octobre 2019 à 22:14 (CET)

┌──────────────────┘
Finalement, le code du module est assez explicite, j'ai pu commencer à tester. J'ai fait un test dans Module:Documentation/Bac à sable, appliqué pour l'instant au modèle {{Documentation modèle utilisé en préchargement}}. Tout semble bien fonctionner. J'ai nommé les paramètres pré-contenu et post-contenu car en-tête est déjà une notion utilisée dans le module. J'ai ajouté un méta-paramètre conntenu facultatif pour permettre d'indiquer que le contenu n'a pas à être fourni (déjà fourni par pré- et post-contenu). Il me reste encore à régler l'histoire de la notice qui ne s'affiche que s'il y a du contenu, je suis dessus.
Epok__ (Insultes, éloges, simples discussions : ), le 1 novembre 2019 à 09:50 (CET)

Tout semble bon maintenant, y compris la notice. J'ai également déployé le code du bac à sable sur le modèle {{Documentation boîte utilisateur}}, ce qui en fait un test extensif sur près de 9000 pages, tout semble rouler. Dites moi ce que vous en pensez. Vérifiez notamment que je n'aie pas fait de connerie au niveau du module...
Wikipédiennement, Epok__ (Insultes, éloges, simples discussions : ), le 1 novembre 2019 à 10:53 (CET)
En l'absence d'opposition, et parce que je ne voudrais pas que des modèles en production dépendent trop longtemps d'un bac à sable, je me lance. Je vais créer temporairement Module:Documentation 2 pour mettre le nouveau code du module, en attendant que mes modifications soient revues par un spécialiste du module (Notification Od1n ?), et créer {{Méta documentation de modèle}}.
Epok__ (Insultes, éloges, simples discussions : ), le 3 novembre 2019 à 11:04 (CET)
Voilà, le méta-modèle est créé et déployé sur les modèles de doc que j'avais moi-même créés : {{Documentation modèle utilisé en préchargement}}, {{Documentation boîte utilisateur}} et {{Documentation d'une sous-page de modèle}}.
Je résume les étapes à faire si on continue dans cette voie :
  1. Vérifier le code de Module:Documentation 2 pour s'assurer que je n'ai rien cassé,
  2. Remplacer le code de Module:Documentation par celui de Module:Documentation 2, et mettre à jour {{Méta documentation de modèle}} pour utiliser ce module,
  3. Finir de déployer le méta-modèle sur les autres modèles de documentation,
  4. Remplacer le code de {{Documentation}} par un appel au méta-modèle, et mettre à jour sa doc pour ne plus documenter que les paramètres effectivement utilisables par les modèles.
Dès que l'étape 1 sera OK, je peux me charger de la suite.
Epok__ (Insultes, éloges, simples discussions : ), le 3 novembre 2019 à 11:46 (CET)
On est là dans quelque chose d'assez complexe, donc ça demande du temps, et là je ne peux pas vraiment… Évidemment, accord de principe pour remettre à plat et simplifier tous ces modèles. Petite mise en garde quand même, tu as l'air parti là pour créer de nouveaux modèles, fais attention à ce que cela ne soit qu'un chantier temporaire, l'objectif est que la situation soit plus simple au final, faudrait pas se retrouver avec le contraire ;) od†n ↗blah 3 novembre 2019 à 14:32 (CET)
Salut Od1n Bonjour, et merci de ta réponse. Non, aucun nouveau modèle à part {{Méta documentation de modèle}}, donc le code est exactement le même que le code actuel de {{Documentation}}. Également, de manière temporaire, Module:Documentation 2 pour éviter de tout casser dans le code de Module:Documentation au cas où j'ai fait une erreur. Mais celui-ci disparaitra dès que le code sera validé : il me semble OK, mais j'ai pu oublier un effet de bord pernicieux... Comme tu as l’expertise de ce module, je compte sur ta relecture, bien entendu lorsque tu en aura le temps. Pour simplifier, voici l'ensemble des modifications que j'ai apporté au module, dans l'ordre du code (voir ce diff, mais il n'est pas très clair sur l'affichage) :
  • Ajout d'un paramètre pré-contenu (peu d'erreurs possibles ici),
  • Ajout d'un paramètre contenu facultatif, qui empêche l'affichage du bandeau "pas de sous-page de dooc" (faible probabilité d'erreur aussi),
  • Suppression du test "si args.contenu" pour la modification de la notice (c'est ici que je crains des effets de bord, mais à mon avis pas catastrophiques),
  • Ajout d'un paramètre post-contenu (peu d'erreurs possibles ici),
C'est tout !
Vu que tout le monde semble OK, je vais poursuivre la migration des modèles de doc vers ce module, à l'exception de {{Documentation}} (étape 3 ci-dessus).
Epok__ (Insultes, éloges, simples discussions : ), le 3 novembre 2019 à 15:48 (CET)
Notification FDo64 et Od1n : J'ai terminé le déploiement sur les modèles de documentation, hors {{Documentation}}, avec les dernières retouches que je viens de faire. J'ai juste craqué pour la création d'un modèle supplémentaire : {{Documentation module}} pour simplifier la syntaxe des messages MediaWiki:Scribunto-doc-page-show et MediaWiki:Scribunto-doc-page-does-not-exist.
Je ne constate pas d'erreur notoire dans les documentations de modèles et de modules. Je pense avoir consulté des pages utilisant à peu près toutes les combinaisons de paramètres de ces modèles, mais bien entendu je n'ai pas pu regarder la totalité des pages affectées... Merci de me remonter toute erreur constatée sur une utilisation de documentation. Si on ne constate pas d'erreur d'ici quelques jours (semaines ?), je terminerai le déploiement avec le modèle {{Documentation}}.
Wikipédiennement, Epok__ (Insultes, éloges, simples discussions : ), le 4 novembre 2019 à 18:34 (CET)
En survolant rapidement la chose, sans étudier en détail le code, ça me semble aller dans la bonne direction. Ce nouveau {{Méta documentation de modèle}} est clairement la brique intermédiaire qui manquait. Une fois wstat.fr à jour, ça va être bien sympa pour faire encore plus de ménage. od†n ↗blah 7 novembre 2019 à 00:44 (CET)

Réorganisation des modèles de documentation[modifier le code]

Notification Od1n et FDo64 : je crée une nouvelle section pour y voir un peu plus clair (y compris pour moi).
Tout d'abord, je rappelle rapidement les modifications que j'ai effectué sur les modèles de documentation et que j'ai déjà partagé avec vous. En effet, j'ai mené plusieurs modifications de front donc je pense qu'un petit bilan améliorera la lisibilité :

  • J'ai créé le modèle {{Méta documentation de modèle}} pour prendre la place du modèle {{Documentation}} pour les aspects méta-modèle. Il utilise temporairement le module Module:Documentation 2, code modifié du module Module:Documentation qu'il viendra remplacer à terme.
  • Dans ce module, j'ai introduit les paramètres pré-contenu et post-contenu pour accueillir le contenu « statique », i.e. généré par le modèle de doc et non l'appel de celui-ci.
  • J'ai mis à jour tous les modèles de documentation, sauf {{Documentation}} pour l'instant, pour utiliser le nouveau méta-modèle. Je compte attendre le prochain dump en fin de mois pour le mettre à jour afin de m'assurer que je n'ai rien oublié.
  • J'ai créé le modèle {{Documentation module}} pour la documentation spécifique aux modules.
  • J'ai mis à jour les messages système MediaWiki:Scribunto-doc-page-does-not-exist et MediaWiki:Scribunto-doc-page-show pour utiliser ce modèle. La nouvelle version de ces messages génère une doc automatique pour certains types de modules.

Ensuite, quelques modifications dont je n'ai pas encore parlé :

  • La nouvelle version de la documentation des modules s'aligne sur celle des modèles de doc pour ce qui est de la catégorisation : celle-ci n'est plus automatique mais inclue par la doc. Bien entendu, tous les modules qui ont une documentation automatique ont une catégorie associée. J'ai bien mis à jour toutes les sous-pages de documentation de modules pour avoir une catégorisation suite à ce changement de comportement. Mais, point différent des modèles, les modules sans aucune doc continuent à être catégorisés « par défaut » dans la catégorie « Module en langage Lua ».
  • Suite à l'harmonisation du comportement des modèles de doc, j'ai ajouté une nouvelle manière de générer la notice, automatique (il suffit de renseigner le nom du modèle) en fonction du type d'inclusion de la documentation (contenu, sous-page de doc ou page de doc spécifiée par le paramètre 1).

Voilà pour ce qui est fait. Maintenant, j'ai plusieurs points à trancher pour ce qu'il reste à faire pour lesquels j'aimerai avoir votre avis :

  1. Pour ce qui est de la couleur d'arrière-plan des modèles de documentation, tous les modèles utilisent la même, sauf {{Documentation Modèle Automatique}}, créé par Notification Tomybrz. Ce choix semble arbitraire. La doc des modules en revanche a une couleur différente. Je propose de lier la couleur au type de doc (modèle ou module), plutôt que de laisser ce choix à l'implémentation, et donc de supprimer le paramètre couleur. Le seul modèle impacté serait celui cité au début de ce point.
  2. Je ne suis pas tout à fait satisfait du nommage que j'ai donné aux paramètres pré-contenu et post-contenu, car cela introduit une confusion avec le paramètre contenu. Le problème est que les deux premiers sont des méta-paramètres, tandis que le dernier est un paramètre (selon la terminologie barbare que j'ai introduite précédemment mais qui me semble nécessaire pour différentier les types de paramètres), et donc que leur usage risque de prêter à confusion. Avez-vous une meilleure idée de nommage pour ces paramètres ? Tout ça est très clair dans ma tête car je suis en plein dedans, j'espère que je suis aussi clair pour vous Sourire.
  3. J'utilise le modèle {{Méta documentation de modèle}} pour générer le modèle {{Documentation module}}. C'est un contre-sens comme l'a souligné FDo64, mais ça me semble la façon la plus simple de faire pour l'instant... Pensez-vous que cela peut poser un problème ?
  4. J'ai utilisé le comportement actuel pour générer la nouvelle notice : introduction d'un lien pour purger lorsque l'on utilise le paramètre contenu, mais pas lorsque la doc vient d'une sous-page de doc, ni lorsqu'elle est générée directement par le modèle de doc... Ça me semble un peu contre-intuitif, j'aurai plutôt introduit ce lien lorsque la doc vient d'autre part que du code du modèle documenté... Il faut peut-être en profiter pour revoir cet usage.

Voilà, désolé pour ce sujet à rallonge, mais je pense que c'est le bon moment pour traiter de tout ça...
Wikipédiennement, Epok__ (Insultes, éloges, simples discussions : ), le 8 novembre 2019 à 16:45 (CET)

Bonsoir Epok Bonsoir. Je vais être plus bref !
  1. Oui
  2. Si ces paramètres ne servent qu'au méta-modèle, peut-être les appeler contenu1, contenu2 et contenu3 ? D'ailleurs, est-ce que complément n'aurait pas du être remplacé par post-contenu ?
  3. Ma remarque visait uniquement à ne pas oublier qu'il y avait des spécificités pour les modules, rien de plus.
  4. Je n'ai pas compris, pourquoi la purge ne serait pas disponible tout le temps ?
--FDo64 (discuter) 8 novembre 2019 à 22:21 (CET)
Merci pour ces réponses Notification FDo64.
Pour le 1, c'est fait.
Pour le 2, le problème est que le paramètre contenu est spécial car il agit comme si une sous-page de doc était présente : il conditionne l'affichage du bandeau d'absence de doc par exemple. Il me semble donc qu'il faudrait au contraire qu'il soit distinct des paramètres que j'ai introduits dès le premier coup d'oeil. Pour le paramètre complément, c'est pas faux, je vais y réfléchir.
Pour le 4, je pense que tu as raison, et qu'il faut afficher ce lien dès qu'il y a un contenu, d'où qu'il vienne...
Epok__ (Insultes, éloges, simples discussions : ), le 9 novembre 2019 à 09:26 (CET)
Bonjour Epok Bonjour. Pour le 2, il y a les classiques début/fin, avant/après, en-tête/en-queue. --FDo64 (discuter) 9 novembre 2019 à 09:36 (CET)
Notification FDo64 Peut-être un truc du genre "contenu auto haut" et "contenu auto bas", mais ça fait peut être un peu long comme noms... Epok__ (Insultes, éloges, simples discussions : ), le 9 novembre 2019 à 09:47 (CET)
Suite de mes réflexions concernant le point 4. Dans ce qui suit, le terme "sous-page" veut dire sous-page de doc, mais également page de doc provenant d'une autre page passée en paramètre.
On dispose de deux liens purger : en tête et en pied.
  • Le lien en tête apparaît lorsque la doc viens d'une sous-page ou qu'il n'y a pas de doc (?), mais pas lorsqu'elle vient du contenu. Je propose de toujours mettre ce lien.
  • Le lien en pied apparait à l'inverse uniquement lorsque la doc vient du paramètre contenu. Je propose de le supprimer complètement, remplacé par le lien en tête.
Il y a également d'autres liens : créer, modifier et historique.
  • En tête, on a un lien créer lorsqu'il n'a ni sous-page ni paramètre contenu, et un lien modifier uniquement lorsqu'il y a une sous-page. Ça me semble cohérent.
  • En pied, on a un lien modifier et un lien historique lorsqu'il il y une sous-page. Je ne suis pas sûr de la pertinence de ces deux liens car on a déjà un lien vers la sous-page à cet endroit, et de plus le premier est redondant avec le lien en tête. Je pense qu'on pourrait les supprimer tous les deux. Un lien pour créer une sous-page de doc apparaît également lorsque le paramètre contenu existe, pour indiquer que l'on devrait déplacer la doc vers la sous page si le modèle est protégé. Ce lien me semble pertinent.
Dites moi ce que vous en pensez.
Epok__ (Insultes, éloges, simples discussions : ), le 9 novembre 2019 à 17:45 (CET)
Ok pour conserver le lien purger uniquement en tête.
Ok pour supprimer le deuxième lien modifier en queue.
Par contre le lien historique ne se trouve nulle part ailleurs et mérite d'être conservé.
Ok sur tout le reste.
--FDo64 (discuter) 9 novembre 2019 à 18:36 (CET)

┌────────────┘
Fait Fait. De mon point de vue, j'ai terminé les modifications sur le module. Je procèderai à la mise à jour du module Documentation et du modèle {{Documentation}} après le prochain dump afin de vérifier les inclusions du modèle. Ça laisse environ 2 semaines pour vérifier que le nouveau comportement correspond bien à nos attentes et s'assurer qu'il n'y a pas de comportement indésiré. N'hésitez pas à me faire remonter tout problème ou remarque (même mineure).
Wikipédiennement, Epok__ (Insultes, éloges, simples discussions : ), le 9 novembre 2019 à 19:32 (CET)

Bravo ! Notification Epok --FDo64 (discuter) 9 novembre 2019 à 21:24 (CET)