Module:Transcluder/documentation
Ceci est une sous-page de documentation de Module:Transcluder/doc. Elle regroupe les informations d'utilisation, les catégories et d'autres contenus ne figurant pas sur la page originale Module. |
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éeget( 'Title#Section' )
— Obtenir la section demandé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 fichiersget( 'Title#Section', { files = 1 } )
— Exclure tous les fichiers à l'exception du premierget( 'Title#Section', { files = 2 } )
— Exclure tous les fichiers sauf le secondget( 'Title#Section', { files = '1,2' } )
— Exclure tous les fichiers sauf le premier et le secondget( 'Title#Section', { files = '1-3' } )
— Exclure tous les fichiers sauf le premier, le second et le troisièmeget( 'Title#Section', { files = '1,3-5' } )
— Exclure tous les fichiers sauf le premier, le troisième, le quatrième et le cinquièmeget( 'Title#Section', { files = -2 } )
— Exclure le second fichierget( 'Title#Section', { files = '-2,3' } )
— Exclure le second et le troisième fichierget( 'Title#Section', { files = '-1,3-5' } )
— Exclure le premier fichier, le troisième, le quatrième et le cinquièmeget( 'Title#Section', { files = 'A.png' } )
— Exclure tous les fichiers sauf A.pngget( 'Title#Section', { files = '-A.png' } )
— Exclure A.pngget( 'Title#Section', { files = 'A.png, B.jpg, C.gif' } )
— Exclure tous les fichiers sauf A.png, B.jpg et C.gifget( 'Title#Section', { files = '-A.png, B.jpg, C.gif' } )
— Exclure A.png, B.jpg et C.gifget( 'Title#Section', { files = { [1] = true, [3] = true } } )
— Exclure tous les fichers sauf le premier et le troisièmeget( 'Title#Section', { files = { [1] = false, [3] = false } } )
— Exclure le premier et le troisième fichierget( 'Title#Section', { files = { ['A.png'] = false, ['B.jpg'] = false } } )
— Exclure A.png et B.jpgget( '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èreget( '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èmeget( 'Title#Section', { references = 0 } )
— Exclure toutes les référencesget( 'Title#Section', { categories = '0' } )
— Exclure toutes les catégoriesget( 'Title#Section', { templates = '-.+infobox' } )
— Exclure les modèles de boîtes d'informationget( '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 fichiersget( 'Title#Section', { only = 'lists', lists = 1 } )
— Obtenir que la première listeget( '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èmeget( 'Title#Section', { only = 'templates', templates = 'Infobox' } )
— Obtenir seulement la boîte d'informationget( 'Title#Section', { only = 'parameters', parameters = 'abstract', references = 0 } )
— Obtenir uniquement le paramètre 'abstract' et lui enlever toutes les références présentes
La sortie peut ensuite être modifiée à l'aide de quelques options spéciales :
get( 'Title#Section', { noFollow = true } )
— Ne pas suivre les redirectionsget( 'Title#Section', { linkBold = true } )
— Lier le titre en gras, ou le synonyme à côté du début du texteget( 'Title#Section', { noBold = true } )
— Enlever le texte en grasget( 'Title#Section', { noComments = true } )
— Supprimer les commentairesget( 'Title#Section', { noLinks = true } )
— Supprimer tous les liensget( 'Title#Section', { noSelfLinks = true } )
— Enlever les auto liensget( 'Title#Section', { noNonFreeFiles = true } )
— Supprimer les fichiers non libres de droits (actuellement identifiés par les mots 'non-free' dans leur description locale ou sur 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'
En plus 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