Difference between revisions of "Module:Excerpt/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Sophivorus
m (35 revisions imported)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Module rating|beta}}
 
{{Module rating|beta}}
 
{{high-use|6644}}
 
{{high-use|6644}}
{{Uses Lua|Module:Excerpt/i18n}}
+
{{Uses Lua|Module:Transcluder|Module:Yesno|Module:Excerpt/config|Module:TNT|Module:Hatnote}}
  
This module can transclude any part of any page.
+
This module implements [[Template:Excerpt]].
  
== Usage ==
+
* See [[Template:Excerpt]] for documentation on the template parameters
 +
* See [[mw:Module:Excerpt]] for documentation on this module
 +
* See [[Module:Excerpt/config]] for configuration of this module
  
=== Templates ===
+
== Portals ==
  
This module has only one entry point for templates:
+
Portals still use a previous version of this module:
  
* <code><nowiki>{{#invoke:Excerpt|main}}</nowiki></code> — Wraps the get() entry point, see its documentation for details
+
* [[Module:Excerpt/portals]] / [[Module:Excerpt/portals/sandbox|sandbox]] — Used by:
 
 
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]]
 
 
** {{tl|Transclude lead excerpt}} / [[Template:Transclude lead excerpt/sandbox|sandbox]] / [[Template:Transclude lead excerpt/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]]
 
** {{tl|Transclude linked excerpt}} / [[Template:Transclude linked excerpt/sandbox|sandbox]] / [[Template:Transclude linked excerpt/testcases|testcases]]
Line 29: Line 19:
 
** {{tl|Transclude random excerpt}} / [[Template:Transclude random excerpt/sandbox|sandbox]] / [[Template:Transclude random excerpt/testcases|testcases]]
 
** {{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]]
 
** {{tl|Transclude selected excerpt}} / [[Template:Transclude selected excerpt/sandbox|sandbox]] / [[Template:Transclude selected excerpt/testcases|testcases]]
* [[Module:Excerpt slideshow]] / [[Module:Excerpt slideshow/sandbox|sandbox]]
+
* [[Module:Excerpt slideshow]] / [[Module:Excerpt slideshow/sandbox|sandbox]] — Uses Module:Excerpt/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 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 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]]
 
** {{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]]
+
* [[Module:Random slideshow]] / [[Module:Random slideshow/sandbox|sandbox]] — Uses Module:Excerpt/portals and is used by:
 
** {{tl|Random slideshow}} / [[Template:Random slideshow/sandbox|sandbox]] / [[Template:Random slideshow/testcases|testcases]]
 
** {{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]]
 
** {{tl|Transclude files as random slideshow}} / [[Template:Transclude files as random slideshow/sandbox|sandbox]] / [[Template:Transclude files as random slideshow/testcases|testcases]]

Latest revision as of 16:31, 26 September 2020

Template:Uses Lua

This module implements Template:Excerpt.

Portals

Portals still use a previous version of this module: