Projet:Laboratoire/Espaces de noms/Modèle/Sandbox/Sous-documentation

Cette page est une ébauche. Avant de recréer une ressource du même type, essayez d'abord de compléter celle-ci ; si c'est impossible, remplacez son contenu par le vôtre. Si vous êtes l'auteur(e) de cette page et que vous souhaitez la continuer, retirez ce bandeau.

Avertissement :

Cette page fournit les informations relatives à l’organisation de la sous-documentation des modèles et modules pour la Wikiversité.

Pour répondre au besoin latent d’améliorer la gestion et le suivi des modèles et modules, le logiciel MediaWiki propose un système de sous-pages standard destiné à faciliter le développement et la documentation des modèle et modules.

Le protocole s’appuie principalement sur l’utilisation de trois sous-page dont le nom est paramétrable. Ainsi chaque page de modèle et chaque page de module, dispose potentiellement de sous-pages affectées à la documentation du code, au développement du code, aux tests relatifs au nouveaux développements.

Il faut considérer ces sous-pages comme des objets système lié au logiciel MediaWiki. Par défaut, les noms des sous-pages sont les suivants :

Mon modèle/doc
Mon modèle/sandbox
Mon modèle/testcase

Initialement les noms sont en minuscules.

L’intégration francophone via Wikipédia aboutie aux schéma suivant :

Mon modèle/Documentation
Mon modèle/Bac à sable
Mon modèle/Test

Première majuscule.

Documentation

La sous-page documentation, est dédiée aux informations d’usage du modèle ou module correspondant. Elle est responsable également de la catégorisation des modèles et modules. Cette sous-page permet de séparer le code en offrant des méthodes pour la documentation, la catégorisation et les liens internes.

Bac à sable

Cette sous-page constitue un bac à sable expérimental, pour le développement du modèle. Il s'agit d’un modèle contenant du code ; que les contributeurs seront amenés à tester avant d’implémenter les modifications sur le modèle principal.

Test

Cette sous-page offre un cadre de test pour le nouveau code. À ce stade le contributeur dispose du modèle principal Mon modèle et du nouveau modèle développé Mon modèle/Bac à sable ; la sous-page Test (testcase) en anglais doit servir à vérifier et comparer le résultat obtenu en appliquant le code du bac à sable.

config

Certains modules disposent d’un sous-module de configuration pour l’adaptation sur le wiki local. Nous encourageons à suivre le standard de fait /config en minuscule.

Conclusion

La sous-page documentation s’est greffée aux modèles puis au modules. Son rôle est devenu primordial. Nous recommandons de mettre à jour les modèles et modules en prenant soin de la définition, des exemples, catégories et liens interwiki.

Les sous-pages Bac à sable et Test, sont optionnelles ; elles doivent être utilisées en priorité lors des modifications des modèles et modules.

Voir aussi