Type a search term to find related articles by LIMS subject matter experts gathered from the most trusted and dynamic collaboration tools in the laboratory informatics industry.
Les modèles sont accessibles en édition par tous les contributeurs. Les nouveaux utilisateurs et même les utilisateurs expérimentés peuvent avoir des difficultés à comprendre certains modèles. C'est pourquoi il est nécessaire de les documenter pour améliorer l'utilisabilité. La documentation doit expliquer clairement ce que fait le modèle et comment l'utiliser. Un utilisateur sans connaissance particulière avec la syntaxe des modèles de MediaWiki doit pouvoir utiliser ce modèle correctement.
L'éditeur visuel demande que les documentations de modèles utilisent la balise TemplateData.
contenu
.La documentation d'un modèle peut être faite :
Il est préférable de systématiquement séparer le code (le modèle) de sa documentation (la sous-page) pour faciliter la prise en main par les nouveaux, et éviter les modèles brisés dont le code a été cassé par une correction de documentation mal faite.
Il est possible d'inclure le contenu de la documentation directement dans le corps du modèle. Pour ce faire, il faut placer en fin de page du modèle :
(...Le code Wiki du modèle est en premier...) <noinclude>{{Documentation|contenu= == Utilisation == ... }} <!-- Catégories pour le modèle --> </noinclude>
Notes :
|contenu=
ne prend pas en charge la syntaxe MediaWiki des tableaux. Pour résoudre ce problème, il est nécessaire de transformer la syntaxe MediaWiki en code HTML ou alors de transférer le contenu de la documentation en sous-page /Documentation.<noinclude>
. Tout texte, modèle, bandeau ou Templatedata doit obligatoirement être placé dans le paramètre contenu
.Il faut placer la documentation en sous-page dans les cas suivants :
L'usage d'une sous page de documentation du modèle permet aussi de séparer le code (le modèle) de sa documentation (la sous-page) pour faciliter la prise en main par les nouveaux, et éviter les modèles brisés dont le code a été cassé par une correction de documentation mal faite.
Pour documenter convenablement un modèle :
<noinclude>{{Documentation}}</noinclude>
Notes :
{{Documentation}}
permet de charger automatiquement le contenu de la sous-page /Documentation.<noinclude>
. Toute catégorie, texte, modèle, bandeau ou Templatedata doit obligatoirement être placé dans la sous-page.