Quelltext der Seite Modul:Transcluder/Doku

<noinclude>
{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}
<languages />
</noinclude>{{#switch:<translate></translate>
| =
<includeonly>{{languages|Module:Transcluder/doc}}</includeonly>
<translate><!--T:1--> This module is a general-purpose '''transclusion engine''', able to transclude any part of any page and with many options that normal transclusion doesn't provide.</translate>

<translate>
== Usage == <!--T:2-->

=== Modules === <!--T:3-->

<!--T:4-->
The main entry point for modules is the <tvar name=1><code>get</code></tvar> method.
</translate>

* <code>get( 'Title' )</code> — <translate><!--T:5--> Get the requested page (exact same result as normal transclusion)</translate>
* <code>get( 'Title#' )</code> — <translate><!--T:6--> Get the lead section of the requested page</translate>
* <code>get( 'Title#Section' )</code> — <translate><!--T:7--> Get the requested section or <tvar name=1>{{tag|section|open}}</tvar> tag (includes any subsections)</translate>

<translate><!--T:8--> <tvar name=1>{{tag|noinclude|open}}</tvar> and <tvar name=2>{{tag|onlyinclude|open}}</tvar> tags are handled [[<tvar name=3>Special:MyLanguage/Transclusion#Transclusion markup</tvar>|the usual way]] and there's also an optional second parameter to exclude various elements from the result:</translate>

* <code>get( 'Title#Section', { files = 0 } )</code> — <translate><!--T:9--> Exclude all files</translate>
* <code>get( 'Title#Section', { files = 1 } )</code> — <translate><!--T:10--> Exclude all files except the first</translate>
* <code>get( 'Title#Section', { files = 2 } )</code> — <translate><!--T:11--> Exclude all files except the second</translate>
* <code>get( 'Title#Section', { files = '1,2' } )</code> — <translate><!--T:12--> Exclude all files except the first and second</translate>
* <code>get( 'Title#Section', { files = '1-3' } )</code> — <translate><!--T:13--> Exclude all files except the first, second and third</translate>
* <code>get( 'Title#Section', { files = '1,3-5' } )</code> — <translate><!--T:14--> Exclude all files except the first, third, fourth and fifth</translate>
* <code>get( 'Title#Section', { files = -2 } )</code> — <translate><!--T:15--> Exclude the second file</translate>
* <code>get( 'Title#Section', { files = '-2,3' } )</code> — <translate><!--T:16--> Exclude the second and third files</translate>
* <code>get( 'Title#Section', { files = '-1,3-5' } )</code> — <translate><!--T:17--> Exclude the first, third, fourth and fifth files</translate>
* <code>get( 'Title#Section', { files = 'A.png' } )</code> — <translate><!--T:18--> Exclude all files except <tvar name=1>A.png</tvar></translate>
* <code>get( 'Title#Section', { files = '-A.png' } )</code> — <translate><!--T:19--> Exclude <tvar name=1>A.png</tvar></translate>
* <code>get( 'Title#Section', { files = 'A.png, B.jpg, C.gif' } )</code> — <translate><!--T:20--> Exclude all files except <tvar name=1>A.png</tvar>, <tvar name=2>B.jpg</tvar> and <tvar name=3>C.gif</tvar></translate>
* <code>get( 'Title#Section', { files = '-A.png, B.jpg, C.gif' } )</code> — <translate><!--T:21--> Exclude <tvar name=1>A.png</tvar>, <tvar name=2>B.jpg</tvar> and <tvar name=3>C.gif</tvar></translate>
* <code>get( 'Title#Section', { files = { [1] = true, [3] = true } } )</code> — <translate><!--T:22--> Exclude all files except the first and third</translate>
* <code>get( 'Title#Section', { files = { [1] = false, [3] = false } } )</code> — <translate><!--T:23--> Exclude the first and third files</translate>
* <code>get( 'Title#Section', { files = { ['A.png'] = false, ['B.jpg'] = false } } )</code> — <translate><!--T:24--> Exclude <tvar name=1>A.png</tvar> and <tvar name=2>B.jpg</tvar></translate>
* <code>get( 'Title#Section', { files = '.+%.png' } )</code> — <translate><!--T:25--> Exclude all files except PNG files (see [[<tvar name=1>Special:MyLanguage/Extension:Scribunto/Lua reference manual#Patterns</tvar>|Lua patterns]])</translate>
* <code>get( 'Title#Section', { files = '-.+%.png' } )</code> — <translate><!--T:26--> Exclude all PNG files</translate>

<translate><!--T:27--> The very same syntax can be used to exclude many other elements:</translate>

* <code>get( 'Title#Section', { sections = 0 } )</code> — <translate><!--T:28--> Exclude all subsections</translate>
* <code>get( 'Title#Section', { sections = 'History, Causes' } )</code> — <translate><!--T:29--> Exclude all subsections except '<tvar name=1>History</tvar>' and '<tvar name=2>Causes</tvar>'</translate>
* <code>get( 'Title#Section', { lists = 1 } )</code> — <translate><!--T:30--> Exclude all lists except the first</translate>
* <code>get( 'Title#Section', { tables = 'stats' } )</code> — <translate><!--T:31--> Exclude all tables except the one with id '<tvar name=1>stats</tvar>'</translate>
* <code>get( 'Title#Section', { paragraphs = '1-3' } )</code> — <translate><!--T:32--> Exclude all paragraphs except the first, second and third</translate>
* <code>get( 'Title#Section', { references = 0 } )</code> — <translate><!--T:33--> Exclude all references</translate>
* <code>get( 'Title#Section', { categories = '0' } )</code> — <translate><!--T:34--> Exclude all categories</translate>
* <code>get( 'Title#Section', { templates = '-.+infobox' } )</code> — <translate><!--T:35--> Exclude infobox templates</translate>
* <code>get( 'Title#Section', { parameters = 'image' } )</code> — <translate><!--T:36--> Exclude all parameters from all templates except the one named '<tvar name=1>image</tvar>'</translate>

<translate><!--T:37--> Options can be combined at will.</translate>
<translate><!--T:38--> For example:</translate>

* <code>get( 'Title#Section', { sections = 0, files = 1, paragraphs = '1-3' } )</code> — <translate><!--T:39--> Exclude all subsections, all files except the first, and all paragraphs except the first three</translate>

<translate><!--T:40--> You can also get only some elements like so:</translate>

* <code>get( 'Title#Section', { only = 'files' } )</code> — <translate><!--T:41--> Get only the files</translate>
* <code>get( 'Title#Section', { only = 'lists', lists = 1 } )</code> — <translate><!--T:42--> Get only the first list</translate>
* <code>get( 'Title#Section', { only = 'tables', tables = 'stats' } )</code> — <translate><!--T:43--> Get only the table with id '<tvar name=1>stats</tvar>'</translate>
* <code>get( 'Title#Section', { only = 'paragraphs', paragraphs = '1,3-5' } )</code> — <translate><!--T:44--> Get only the first, third, fourth and fifth paragraph</translate>
* <code>get( 'Title#Section', { only = 'templates', templates = 'Infobox' } )</code> — <translate><!--T:45--> Get only the infobox</translate>
* <code>get( 'Title#Section', { only = 'parameters', parameters = 'abstract', references = 0 } )</code> — <translate><!--T:71--> Get only the parameter called 'abstract' and remove all the references from it</translate>

<translate><!--T:47--> The output can be further modified with a few special options:</translate>

* <code>get( 'Title#Section', { noFollow = true } )</code> — <translate><!--T:48--> Don't follow redirects</translate>
* <code>get( 'Title#Section', { linkBold = true } )</code> — <translate><!--T:49--> Link the bold title or synonym near the start of the text</translate>
* <code>get( 'Title#Section', { noBold = true } )</code> — <translate><!--T:50--> Remove bold text</translate>
* <code>get( 'Title#Section', { noComments = true } )</code> — <translate><!--T:68--> Remove comments</translate>
* <code>get( 'Title#Section', { noLinks = true } )</code> — <translate><!--T:70--> Remove all links</translate>
* <code>get( 'Title#Section', { noSelfLinks = true } )</code> — <translate><!--T:51--> Remove self links</translate>
* <code>get( 'Title#Section', { noNonFreeFiles = true } )</code> — <translate><!--T:69--> Remove non-free files (currently identified by having the words 'non-free' in their local description or at Commons)</translate>
* <code>get( 'Title#Section', { noBehaviorSwitches = true } )</code> — <translate><!--T:52--> Remove [[<tvar name=1>Special:MyLanguage/Help:Magic words#Behavior switches</tvar>|behavior switches]] such as <tvar name=2><code><nowiki>__NOTOC__</nowiki></code></tvar></translate>
* <code>get( 'Title#Section', { fixReferences = true } )</code> — <translate><!--T:53--> Prefix reference names with 'Title ' to avoid name conflicts when transcluding and rescue references defined outside the requested section to avoid undefined reference errors</translate>

<translate><!--T:54--> Besides the <tvar name=1><code>get</code></tvar> method, the module exposes several other methods to get specific parts of the wikitext.</translate>
<translate><!--T:55--> This allows other modules to combine elements in more advanced ways.</translate>

<translate>
=== Templates === <!--T:56-->
</translate>
<translate><!--T:57--> The main entry point for templates is the <tvar name=1><code>main</code></tvar> method.</translate>
<translate><!--T:58--> It's essentially a wrapper of the <tvar name=1><code>get</code></tvar> method to make it usable for templates.</translate>

<translate><!--T:59--> See the documentation of the <tvar name=1><code>get</code></tvar> method for more details and options.</translate>

* <code><nowiki>{{#invoke:Transcluder|main|Title}}</nowiki></code> — <translate><!--T:60--> Transclude the requested page</translate>
* <code><nowiki>{{#invoke:Transcluder|main|Title#}}</nowiki></code> — <translate><!--T:61--> Transclude the lead section of the requested page</translate>
* <code><nowiki>{{#invoke:Transcluder|main|Title#Section}}</nowiki></code> — <translate><!--T:62--> Transclude the requested section or <tvar name=1>{{tag|section|open}}</tvar> tag (includes any subsections)</translate>
* <code><nowiki>{{#invoke:Transcluder|main|Title#Section|sections=0}}</nowiki></code> — <translate><!--T:63--> Transclude the requested section, excluding subsections</translate>
* <code><nowiki>{{#invoke:Transcluder|main|Title|only=files|files=1}}</nowiki></code> — <translate><!--T:64--> Transclude only the first file of the page</translate>
* <code><nowiki>{{#invoke:Transcluder|main|Title#Section|only=tables|tables=2}}</nowiki></code> — <translate><!--T:65--> Transclude only the second table of the requested section</translate>
* <code><nowiki>{{#invoke:Transcluder|main|Title#|only=paragraphs|linkBold=yes}}</nowiki></code> — <translate><!--T:66--> Transclude only the paragraphs of the lead section and link the bold text</translate>

<translate>
== See also == <!--T:67-->
</translate>
* [[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}}}}
}}