Modèle:Documentation

Stargate Wiki Sémantique — La référence sémantique sur l'univers Stargate
Aller à la navigation Aller à la recherche
Documentation modèle [modifier] [purger]

Voici le modèle {{Documentation}}.

Pour la majeure partie des instructions sur la manière et quand utiliser ce modèle, voir Stargate Wiki FR:Documentation modèle.

Ce modèle affiche un bandeau de couleur bleue tel que vous le voyez à l'heure actuelle (si vous êtes sur la page du modèle) et charge automatiquement le contenu depuis une sous-page /documentation. Il peut aussi charger le contenu depuis d'autres endroits s'il est renseigné de cette façon.

Ce modèle est destiné pour documenter les modèles et autres pages qui sont incluses sur d'autres pages. Il peut être utilisé dans l'espace modèle et dans la plupart des autres espaces de noms.

L'utilisation de ce modèle permet aux modèles de pouvoir être protégés si nécessaire, permettant à chacun de modifier la documentation, les catégories et les liens interwikis.

Utilisation[modifier le wikicode]

En temps normal, ce modèle est utilisé sans aucun paramètre, placé au pied du modèle ou de la page devant être documentée, à l'intérieur des balises <noinclude> :

<!-- Dernière ligne de votre code modèle --><noinclude>

{{documentation}}
<!-- Ajouter les catégories et les interwikis dans la sous-page documentation, pas ici ! -->
</noinclude>

Ensuite, ce modèle charge automatiquement le contenu depuis la sous-page /documentation du modèle sur lequel il est utilisé.

<!-- Dernière ligne de votre code modèle --><noinclude>

{{documentation|Modèle:Autre page/documentation}}
</noinclude>

Remarquez que lorsque vous chargez la documentation provenant d'une page autre que la page locale /documentation, cela devient délicat de tenir correctement les catégories et les liens interwikis.

Le contenu peut aussi être directement entré comme texte. Comme ceci :

<!--Dernière ligne de votre code modèle --><noinclude>

{{documentation
 | contenu = Voici un contenu de documentation directe
}}
</noinclude>

Quand le paramètre contenu est utilisé, le bandeau documentation ne montre pas normalement les liens [modifier] [purger] situés dans le coin supérieur droit. Veuillez noter que si la page /documentation existe, un lien menant vers celle-ci est affiché dans le bandeau de lien situé sous le bandeau documentation.

Mais le paramètre 1 et le paramètre contenu peuvent être aussi combinés, comme ceci :

<!--Dernière ligne de votre code modèle --><noinclude>

{{documentation
 | 1       = Modèle:Une documentation/documentation
 | contenu = {{Modèle:Une documentation/documentation|paramètres}}
}}
</noinclude>

Alors, le nom de la page alimenté par le paramètre 1 es utilisé pour les liens [modifier] [purger] et pour le lien /documentation dans le bandeau de lien en dessous du bandeau documentation. Mais le paramètre contenu est utilisé pour le contenu montré dans le bandeau documentation. Le code ci-dessus signifie que le contenu est inclus en tant que « {{Modèle:Une documentation/documentation|paramètres}} ». Dans cet exemple, un paramètre est aussi donné à la page /documentation chargée.

Meilleure pratique[modifier le wikicode]

Le code devrait être ajouté au pied du code modèle, sans espace avant « <noinclude> » (qui provoquerait une espace supplémentaire sur les pages où le modèle est utilisé).

Les catégories et les liens interwiki qui s'appliquent au modèle concerné devraient être ajoutés au pied de la sous-page /documentation, à l'intérieur de la balise <includeonly></includeonly>. Pour les cas plus complexes, voir Stargate Wiki FR:Documentation modèle#Catégories et liens interwiki.

Si la page documentation contient la balise <includeonly> or <noinclude> comme partie du texte de documentation visible, remplacez « < » par « &lt; ».

L'entête[modifier le wikicode]

Quand il se trouve dans l'espace modèle, ce modèle affiche cet entête :

Template-info.svg Documentation modèle

Dans la plupart des autres espaces de nom, comme « Stargate Wiki FR: », il affiche cet entête :

Documentation

Mais quand il se trouve sur les pages Fichier (images), il affiche cet entête :

Résumé

Le paramètre entête peut être utilisé pour définir l'entête pour autre chose. Comme ceci :

{{documentation| entête = Infobox documentation }}

Si le paramètre entête est vide mais défini, aucun entête ne s'affiche et les liens [modifier] [purger] ne s'affichent pas. Comme ceci :

{{documentation| entête = }}

Le paramètre style entête peut être rempli avec des valeurs CSS, sans les marques de guillemets anglais " " mais avec avec les point-virgules de fin ;. Par exemple :

style entête = color: red; font-size: 150%; (couleur : rouge, taille de police : 150 %)

Le bandeau de lien[modifier le wikicode]

En dessous de l'énorme bandeau documentation se trouve un petit bandeau de liens qui affiche des méta-données concernant la documentation. Le bandeau de lien affiche différentes choses suivant les paramètres qui sont donnés à ce modèle et l'espace de nom dans lequel il est utilisé. Dans certains cas, le bandeau de lien ne s'affiche pas du tout.

Pour masquer le bandeau de lien, ajouter le paramètre « Modèle:Paramètre »

Vous pouvez aussi insérer du texte personnalisé dans le bandeau de lien, en définissant le paramètre Modèle:Paramètre. Par exemple :

|bandeau lien=Cette documentation est générée automatiquement par [[Modèle:Country showdata]]

Fonctions automatiques[modifier le wikicode]

Si la page de documentation n'existe pas, le lien [créer] inclut une page de préchargement qui, en cliquant sur le lien, va pré-remplir le formulaire de modification avec le formatage de page documentation basique. Le texte de préchargement est aussi utilisé pour les liens (créer) /bac à sable et /études de cas.

Quand ce modèle se trouve sur une page modèle protégée, il ajoute automatiquement {{Modèle protégé}} qui affiche le cadenas gris ou rouge dans le coin supérieur droit. Il n'y a donc pas besoin d'ajouter à la main Modèle:Msl aux modèles qui utilisent {{documentation}}.

Quand ce modèle se trouve dans une sous-page /bac à sable, il ajoute automatiquement la {{notice bac à sable modèle}}.

Espace sujet en opposition à espace de discussion[modifier le wikicode]

Terminologie : l'espace sujet est l'opposé de l'espace discussion. Par exemple « Modèle: » est l'espace sujet de « Discussion modèle: ».

Ce modèle est en temps normal placé dans l'espace sujet, à l'intérieur des balises <noinclude>. Mais dans certains cas, ce modèle nécessite de se trouver sur la page de discussion :

  • Pour les pages de préchargement (généralement dans les espaces Modèles ou Stargate Wiki FR), étant donné qu'elles ne peuvent pas utiliser <noinclude>.
  • Dans l'espace MediaWiki, étant donné que <noinclude> ne fonctionne généralement pas dans les messages système et que l'espace MediaWiki doit être conservé propre pour des raisons de performance.

Quand il est placé dans les pages de discussion, ce modèle est généralement place au plus près de la tête de page et les balises <noinclude>.

Les pages /documentation, /bac à sable et /études de cas doivent normalement se trouver dans l'espace sujet, à l'exception des espaces de nom qui n'ont pas l'option sous-page activée : Fichier, MediaWiki et Catégorie.

Ce modèle pointe automatiquement les liens de création pour les /documentation, /bac à sable et /études de cas dans l'espace de nom correct.

Détails techniques[modifier le wikicode]

Ce modèle appelle {{documentation/bandeau début 2}} et {{documentation/bandeau fin 2}} qui à leur tour appellent respectivement {{documentation/bandeau début}} et {{documentation/bandeau fin}}. /bandeau début (et /bandeau fin) détiennent la majeure partie du code tandis que ce modèle et /bandeau début 2 (et /bandeau fin 2) font un prétraitement des paramètres.

La page de préchargement pour le lien [créer] /documentation est Modèle:Documentation/préchargement, mais dans l'espace Fichier, il s'agit de Modèle:Documentation/préchargement espace fichier. Les pages de préchargement pour les lien (créer) /bac à sable et /études de cas sont Modèle:Documentation/préchargement bac à sable et Modèle:Documentation/préchargement études de cas.

Voir aussi[modifier le wikicode]

  • {{documentation}} – Placé sur les modèles et les autres pages afin de les documenter.
  • {{sous-page documentation}} – Utilisé en tête des sous-pages /documentation pour expliquer leur utilité et montrer un lien dirigeant vers la page qu'elle documente.