Module:Excerpt/doc: Difference between revisions

Revision as of 19:46, 11 May 2020

Revision as of 13:36, 1 June 2020

Line 1:

{{Module rating|beta}}

{{high-use|6644}}

{{Uses Lua|Module:Excerpt/i18n|Module:Hatnote}}

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This module aims to be a '''transclusion engine''', whereby other modules and templates may transclude any part of any page.

== Usage ==

=== Templates ===

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|lead}}</code>

:''Main documentation: {{tl|Transclude lead excerpt/doc}}''

Transcludes the lead of an article as an excerpt.

This module has only one entry point for templates:

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|linked}}</code>

:''Main documentation: {{tl|Transclude linked excerpt/doc}}''

Transcludes as an excerpt the lead of an article selected randomly from wikilinks on a page.

* <code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}Excerpt|listitemmain}}</nowiki></code> — Wraps the get() entry point, see its documentation for details

:''Main documentation: {{tl|Transclude list item excerpt/doc}}''

Transcludes as an excerpt the lead of an article selected randomly from list items on a page.

The main entry point gives access to most if not all the functionality of the module and should suffice for most simple templates, but in more sophisticated cases, it my become necessary to create a custom submodule like [[Module:Excerpt/templates]] to implement the template.

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|random}}</code>

:''Main documentation: {{tl|Transclude random excerpt/doc}}''

Transcludes as an excerpt the lead of an article selected randomly from the parameters.

=== Modules ===

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|selected}}</code>

:''Main documentation: {{tl|Transclude selected excerpt/doc}}''

Transcludes the lead of a selected article as an excerpt.

* <code><nowiki>{{get(page, options)</nowiki>#invoke:{{BASEPAGENAME}}|excerpt}}</code> — Main entry point for modules

:''Main documentation: {{tl|Excerpt/doc}}''

Transcludes part of an article into another article.

== NoteDevelopers ==

Before saving aany change to this module, please preview with:

* [[TemplateModule:Excerpt/testcases]]

* [[Template:Excerpt/testcases]]

* [[Template:Transclude lead excerpt/testcases]]

:''Main* documentation[[Template: {{tl|Transclude lead excerpt/doc}}''testcases2]]

* [[Template:Transclude linked excerpt/testcases]]

* [[Template:Transclude list item excerpt/testcases]]

* [[Template:Transclude random excerpt/testcases]]

* [[Template:Transclude selected excerpt/testcases]]

* [[Template:Excerpt/testcases]]

== See also ==

* [[Template:Excerpt]]

{{Portal* [[Module:Excerpt/templates navbox}}]]

* [[Module:Excerpt slideshow]]

* [[Module:Random slideshow]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |