Module:Excerpt/doc: Difference between revisions

Revision as of 13:31, 27 August 2020

Latest revision as of 21:17, 29 August 2024

(14 intermediate revisions by 4 users not shown)

Line 1:

{{Module rating|beta}}

{{high-use|6644}}

{{Uses Lua|Module:Excerpt/i18nconfig|Module:Transcluder|Module:Yesno|Module:TNT}}

This module canimplements transclude any part of any page[[Template:Excerpt]].

* See [[Template:Excerpt]] for documentation on the template parameters

== Usage ==

* See [[mw:Module:Excerpt]] for documentation on this module

* See [[Module:Excerpt/config]] for configuration of this module

=== TemplatesPortals ===

Portals use a previous version of this module:

This module has only one entry point for templates:

* [[Module:Excerpt/portals]] / [[Module:Excerpt/portals/sandbox|sandbox]] /— [[ModuleUsed by:Excerpt/portals/testcases|testcases]]

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

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.

=== Modules ===

* <code><nowiki>get(page, options)</nowiki></code> — Main entry point for modules

== Portals module ==

[[Module:Excerpt/portals]] contains the previous version of this module. It's still being used by the following templates and modules designed for portals:

* [[Module:Excerpt/portals]] / [[Module:Excerpt/portals/sandbox|sandbox]] / [[Module:Excerpt/portals/testcases|testcases]]

** {{tl|Transclude lead excerpt}} / [[Template:Transclude lead excerpt/sandbox|sandbox]] / [[Template:Transclude lead excerpt/testcases|testcases]]

** {{tl|Transclude linked excerpt}} / [[Template:Transclude linked excerpt/sandbox|sandbox]] / [[Template:Transclude linked excerpt/testcases|testcases]]

Line 29 ⟶ 19:

** {{tl|Transclude random excerpt}} / [[Template:Transclude random excerpt/sandbox|sandbox]] / [[Template:Transclude random excerpt/testcases|testcases]]

** {{tl|Transclude selected excerpt}} / [[Template:Transclude selected excerpt/sandbox|sandbox]] / [[Template:Transclude selected excerpt/testcases|testcases]]

* [[Module:Excerpt slideshow]] / [[Module:Excerpt slideshow/sandbox|sandbox]] /— Uses [[Module:Excerpt slideshow/testcases|testcases]]portals and is used by:

** {{tl|Transclude excerpts as random slideshow}} / [[Template:Transclude excerpts as random slideshow/sandbox|sandbox]] / [[Template:Transclude excerpts as random slideshow/testcases|testcases]]

** {{tl|Transclude linked excerpts as random slideshow}} / [[Template:Transclude linked excerpts as random slideshow/sandbox|sandbox]] / [[Template:Transclude linked excerpts as random slideshow/testcases|testcases]]

** {{tl|Transclude list item excerpts as random slideshow}} / [[Template:Transclude list item excerpts as random slideshow/sandbox|sandbox]] / [[Template:Transclude list item excerpts as random slideshow/testcases|testcases]]

* [[Module:Random slideshow]] / [[Module:Random slideshow/sandbox|sandbox]] /— Uses [[Module:Random slideshowExcerpt/testcases|testcases]]portals and is used by:

** {{tl|Random slideshow}} / [[Template:Random slideshow/sandbox|sandbox]] / [[Template:Random slideshow/testcases|testcases]]

** {{tl|Transclude files as random slideshow}} / [[Template:Transclude files as random slideshow/sandbox|sandbox]] / [[Template:Transclude files as random slideshow/testcases|testcases]]

Line 40 ⟶ 30:

<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>