Module:Excerpt/doc: Difference between revisions

Revision as of 19:14, 1 June 2020

Latest revision as of 21:17, 29 August 2024

(19 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]] — Used by:

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

** {{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]]

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.

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

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

=== Modules ===

** {{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/portals and is used by:

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

** {{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]]

== Developers ==

** {{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:Excerpt/portals and is used by:

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

** {{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]]

* [[Module:Excerpt/testcases]]

* [[Template:Excerpt/testcases]]

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

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

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

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

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

== See also ==

* [[Module:Excerpt/templates]]

* [[Module:Excerpt slideshow]]

* [[Module:Random slideshow]]

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

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

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>