View source for Module:Transcluder/doc/fr

<noinclude>
{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}
<languages />
</noinclude>{{#switch:
| =
<includeonly>{{languages|Module:Transcluder/doc}}</includeonly>
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.

<span id="Usage"></span>
== Utilisation ==

=== Modules ===

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

* <code>get( 'Title' )</code> — Obtenir la page demandée (même résultat que celui d'une transclusion standard)
* <code>get( 'Title#' )</code> — Obtenir la section principale de la page demandée
* <code>get( 'Title#Section' )</code> — Obtenir la section demandée ou la balise {{tag|section|open}}  (comprend toute sous-section)

Les balises {{tag|noinclude|open}} et {{tag|onlyinclude|open}} sont uilisées de la  [[Special:MyLanguage/Transclusion#Transclusion markup|manière habituelle]] et il existe aussi un second paramètre optionnel pour exclure divers éléments du résultat :

* <code>get( 'Title#Section', { files = 0 } )</code> — Exclure tous les fichiers
* <code>get( 'Title#Section', { files = 1 } )</code> — Exclure tous les fichiers à l'exception du premier
* <code>get( 'Title#Section', { files = 2 } )</code> — Exclure tous les fichiers sauf le second
* <code>get( 'Title#Section', { files = '1,2' } )</code> — Exclure tous les fichiers sauf le premier et le second
* <code>get( 'Title#Section', { files = '1-3' } )</code> — Exclure tous les fichiers sauf le premier, le second et le troisième
* <code>get( 'Title#Section', { files = '1,3-5' } )</code> — Exclure tous les fichiers sauf le premier, le troisième, le quatrième et le cinquième
* <code>get( 'Title#Section', { files = -2 } )</code> — Exclure le second fichier
* <code>get( 'Title#Section', { files = '-2,3' } )</code> — Exclure le second et le troisième fichier
* <code>get( 'Title#Section', { files = '-1,3-5' } )</code> — Exclure le premier fichier, le troisième, le quatrième et le cinquième
* <code>get( 'Title#Section', { files = 'A.png' } )</code> — Exclure tous les fichiers sauf A.png
* <code>get( 'Title#Section', { files = '-A.png' } )</code> — Exclure A.png
* <code>get( 'Title#Section', { files = 'A.png, B.jpg, C.gif' } )</code> — Exclure tous les fichiers sauf A.png, B.jpg et C.gif
* <code>get( 'Title#Section', { files = '-A.png, B.jpg, C.gif' } )</code> — Exclure A.png, B.jpg et C.gif
* <code>get( 'Title#Section', { files = { [1] = true, [3] = true } } )</code> — Exclure tous les fichers sauf le premier et le troisième
* <code>get( 'Title#Section', { files = { [1] = false, [3] = false } } )</code> — Exclure le premier et le troisième fichier
* <code>get( 'Title#Section', { files = { ['A.png'] = false, ['B.jpg'] = false } } )</code> — Exclure A.png et B.jpg
* <code>get( 'Title#Section', { files = '.+%.png' } )</code> — Exclure tous les fichiers à l'exception des fichiers PNG (voir les [[Special:MyLanguage/Extension:Scribunto/Lua reference manual#Patterns|motifs Lua]])
* <code>get( 'Title#Section', { files = '-.+%.png' } )</code> — Exclure tous les fichiers PNG.

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

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

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

* <code>get( 'Title#Section', { sections = 0, files = 1, paragraphs = '1-3' } )</code> — 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 :

* <code>get( 'Title#Section', { only = 'files' } )</code> — Obtenir que les fichiers
* <code>get( 'Title#Section', { only = 'lists', lists = 1 } )</code> — Obtenir que la première liste
* <code>get( 'Title#Section', { only = 'tables', tables = 'stats' } )</code> — Obtenir seulement la table avec l'ID 'stats'
* <code>get( 'Title#Section', { only = 'paragraphs', paragraphs = '1,3-5' } )</code> — Obtenir uniquement le premier paragraphe, le troisième, le quatrième et le cinquième
* <code>get( 'Title#Section', { only = 'templates', templates = 'Infobox' } )</code> — Obtenir seulement la boîte d'information
* <code>get( 'Title#Section', { only = 'parameters', parameters = 'abstract', references = 0 } )</code> — 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 :

* <code>get( 'Title#Section', { noFollow = true } )</code> — Ne pas suivre les redirections
* <code>get( 'Title#Section', { linkBold = true } )</code> — Lier le titre en gras, ou le synonyme à côté du début du texte
* <code>get( 'Title#Section', { noBold = true } )</code> — Enlever le texte en gras
* <code>get( 'Title#Section', { noComments = true } )</code> — Supprimer les commentaires
* <code>get( 'Title#Section', { noLinks = true } )</code> — Supprimer tous les liens
* <code>get( 'Title#Section', { noSelfLinks = true } )</code> — Enlever les auto liens
* <code>get( 'Title#Section', { noNonFreeFiles = true } )</code> — Supprimer les fichiers non libres de droits (actuellement identifiés par les mots 'non-free' dans leur description locale ou sur Commons)
* <code>get( 'Title#Section', { noBehaviorSwitches = true } )</code> — Enlever les [[Special:MyLanguage/Help:Magic words#Behavior switches|sélecteurs de comportement]] tels que <code><nowiki>__NOTOC__</nowiki></code>
* <code>get( 'Title#Section', { fixReferences = true } )</code> — 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 <code>get</code>, 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.

<span id="Templates"></span>
=== Modèles ===
Le point d'entrée principal des modèles est la méthode <code>main</code>.
C'est essentiellement un conteneur de la méthode <code>get</code> pour la rendre utilisable dans les modèles.

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

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

<span id="See_also"></span>
== Voir aussi ==
* [[Module:Transcluder/testcases]]
* [[c:Data:i18n/Module:Transcluder.tab]]

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>
| #default=
  {{#invoke:Template translation|renderTranslatedTemplate|template=Module:Transcluder/doc|noshift=1|uselang={{int:lang}}}}
}}