Module:Transcluder/documentation

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Module:Transcluder/doc and the translation is 97% complete.
Other languages:
English • ‎Türkçe • ‎español • ‎français • ‎中文 • ‎日本語
warning Attention:Cette page est partagée entre plusieurs wikis.
Toutes les modifications apportées à cette page seront automatiquement copiées sur tous les wikis répertoriés dans la barre de gauche.
Merci de nous aider à traduire cette page.

Ce module est un moteur de transclusion à but général, capable de transclure toute partie d'une page quelconque et avec de nombreuses options non fournies par la transclusion standard.

Utilisation

Modules

Le point d'entrée principal pour les modules est la méthode get .

  • get( 'Title' ) — Obtenir la page demandée (même résultat que celui d'une transclusion standard)
  • get( 'Title#' ) — Obtenir la section principale de la page demandée
  • get( 'Title#Section' ) — Obtenir la section remandée ou la balise <section> (comprend toute sous-section)

Les balises <noinclude> et <onlyinclude> sont uilisées de la manière habituelle et il existe aussi un second paramètre optionnel pour exclure divers éléments du résultat :

  • get( 'Title#Section', { files = 0 } ) — Exclure tous les fichiers
  • get( 'Title#Section', { files = 1 } ) — Exclure tous les fichiers à l'exception du premier
  • get( 'Title#Section', { files = 2 } ) — Exclure tous les fichiers sauf le second
  • get( 'Title#Section', { files = '1,2' } ) — Exclure tous les fichiers sauf le premier et le second
  • get( 'Title#Section', { files = '1-3' } ) — Exclure tous les fichiers sauf le premier, le second et le troisième
  • get( 'Title#Section', { files = '1,3-5' } ) — Exclure tous les fichiers sauf le premier, le troisième, le quatrième et le cinquième
  • get( 'Title#Section', { files = -2 } ) — Exclure le second fichier
  • get( 'Title#Section', { files = '-2,3' } ) — Exclure le second et le troisième fichier
  • get( 'Title#Section', { files = '-1,3-5' } ) — Exclure le premier fichier, le troisième et le quatrième et le cinquième
  • get( 'Title#Section', { files = 'A.png' } ) — Exclure tous les fichiers sauf A.png
  • get( 'Title#Section', { files = '-A.png' } ) — Exclure A.png
  • get( 'Title#Section', { files = 'A.png, B.jpg, C.gif' } ) — Exclure tous les fichiers sauf A.png, B.jpg et C.gif
  • get( 'Title#Section', { files = '-A.png, B.jpg, C.gif' } ) — Exclure A.png, B.jpg et C.gif
  • get( 'Title#Section', { files = { [1] = true, [3] = true } } ) — Exclure tous les fichers sauf le premier et le troisième
  • get( 'Title#Section', { files = { [1] = false, [3] = false } } ) — Exclure le premier et le troisième fichier
  • get( 'Title#Section', { files = { ['A.png'] = false, ['B.jpg'] = false } } ) — Exclure A.png et B.jpg
  • get( 'Title#Section', { files = '.+%.png' } ) — Exclure tous les fichiers à l'exception des fichiers PNG (voir les motifs Lua)
  • get( 'Title#Section', { files = '-.+%.png' } ) — Exclure tous les fichiers PNG.

Une syntaxe très similaire peut être utilisée pour exclure beaucoup d'autres éléments :

  • get( 'Title#Section', { sections = 0 } ) — Exclure toutes les sous-sections.
  • get( 'Title#Section', { sections = 'History, Causes' } ) — Exclure toutes les sous-sections sauf 'History' et 'Causes'
  • get( 'Title#Section', { lists = 1 } ) — Exclure toutes les listes sauf la première
  • get( 'Title#Section', { tables = 'stats' } ) — Exclure toutes les tables sauf celle ayant l'ID 'stats'
  • get( 'Title#Section', { paragraphs = '1-3' } ) — Exclure tous les paragraphes sauf le premier, le second et le troisième
  • get( 'Title#Section', { references = 0 } ) — Exclure toutes les références
  • get( 'Title#Section', { categories = '0' } ) — Exclure toutes les catégories
  • get( 'Title#Section', { templates = '-.+infobox' } ) — Exclure les modèles de boîtes d'information
  • get( 'Title#Section', { parameters = 'image' } ) — Exclure tous les paramètres de tous les modèles sauf le paramètre 'image'

Les options peuvent être combinées à volonté. Par exemple :

  • get( 'Title#Section', { sections = 0, files = 1, paragraphs = '1-3' } ) — Exclure toutes les sous-sections, tous les fichiers sauf le premier, et tous les paragraphes sauf les trois premiers

Vous pouvez également n'obtenir que quelques éléments de la manière suivante :

  • get( 'Title#Section', { only = 'files' } ) — Obtenir que les fichiers
  • get( 'Title#Section', { only = 'lists', lists = 1 } ) — Obtenir que la première liste
  • get( 'Title#Section', { only = 'tables', tables = 'stats' } ) — Obtenir seulement la table avec l'ID 'stats'
  • get( 'Title#Section', { only = 'paragraphs', paragraphs = '1,3-5' } ) — Obtenir uniquement le premier paragraphe, le troisième, le quatrième et le cinquième
  • get( 'Title#Section', { only = 'templates', templates = 'Infobox' } ) — Obtenir seulement la boîte d'information
  • get( 'Title#Section', { only = 'files, lists', files = 1 } ) — Obtenir seulement le premier fichier, suivi de toutes les listes

La sortie peut ensuite être modifiée à l'aide de quelques options spéciales :

  • get( 'Title#Section', { noFollow = true } ) — Ne pas suivre les redirections
  • get( 'Title#Section', { linkBold = true } ) — Lier le titre en gras, ou le synonyme à côté du début du texte
  • get( 'Title#Section', { noBold = true } ) — Enlever le texte en gras
  • get( 'Title#Section', { noComments = true } ) — Remove comments
  • get( 'Title#Section', { noSelfLinks = true } ) — Enlever les auto liens
  • get( 'Title#Section', { noNonFreeFiles = true } ) — Remove non-free files (currently identified by having the words 'non-free' in their local description or at Commons)
  • get( 'Title#Section', { noBehaviorSwitches = true } ) — Enlever les sélecteurs de comportement tels que __NOTOC__
  • get( 'Title#Section', { fixReferences = true } ) — Préfixe les noms des références avec 'Title' pour éviter les conflits de nom lors de la transclusion, et sauvegarde les références définies à l'extérieur de la section demandée pour éviter les erreurs 'référence non définie'

A côté de la méthode get, le module met à disposition plusieurs autres méthodes pour obtenir des parties spécifiques du wikicode. Ceci permet aux autres modules de combiner les éléments de manière plus avancée.

Modèles

Le point d'entrée principal des modèles est la méthode main. C'est essentiellement un conteneur de la méthode get pour la rendre utilisable dans les modèles.

Voir la documentation de la méthode get pour plus de détails et d'options.

  • {{#invoke:Transcluder|main|Title}} — Transclure la page demandée
  • {{#invoke:Transcluder|main|Title#}} — Transclure la section principale de la page demandée
  • {{#invoke:Transcluder|main|Title#Section}} — Transclure la section demandée ou la balise <section> (comprend toute sous-section)
  • {{#invoke:Transcluder|main|Title#Section|sections=0}} — Transclure la section demandée, en excluant les sous-sections
  • {{#invoke:Transcluder|main|Title|only=files|files=1}} — Transclure seulement le premier fichier de la page
  • {{#invoke:Transcluder|main|Title#Section|only=tables|tables=2}} — Transclure seulement le second tableau de la section demandée
  • {{#invoke:Transcluder|main|Title#|only=paragraphs|linkBold=yes}} — Transclure seulement les paragraphes de la section principale et lier le texte en gras

Voir aussi