Difference between revisions of "Module:Excerpt/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Sophivorus
blackwiki>Sophivorus
Line 23: Line 23:
 
[[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]] 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]]
+
* [[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 29:
 
** {{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/testcases|testcases]]
+
* [[Module:Excerpt slideshow]] / [[Module:Excerpt slideshow/sandbox|sandbox]]
 
** {{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/testcases|testcases]]
+
* [[Module:Random slideshow]] / [[Module:Random slideshow/sandbox|sandbox]]
 
** {{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]]

Revision as of 13:31, 27 August 2020

Template:Uses Lua

This module can transclude any part of any page.

Usage

Templates

This module has only one entry point for templates:

  • {{#invoke:Excerpt|main}} — 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

  • get(page, options) — 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: