Difference between revisions of "Module:Excerpt/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Sophivorus
(Undid revision 964825274 by Pppery (talk) This module doesn't depend on Module:Transclude and may never do so.)
blackwiki>Sophivorus
Line 19: Line 19:
 
* <code><nowiki>get(page, options)</nowiki></code> — Main entry point for modules
 
* <code><nowiki>get(page, options)</nowiki></code> — Main entry point for modules
  
== Dependent modules, templates, sandboxes and testcases ==
+
== Portals module ==
  
This section attempts to keep track of all modules, templates, sandboxes and testcases dependent of this module to ease navigation, development and testing.
+
[[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]] / [[Module:Excerpt/sandbox|sandbox]] / [[Module:Excerpt/testcases|testcases]]
+
* [[Module:Excerpt/portals]] / [[Module:Excerpt/portals/sandbox|sandbox]] / [[Module:Excerpt/portals/testcases|testcases]]
* [[Module:Excerpt/templates]] / [[Module:Excerpt/templates/sandbox|sandbox]] / [[Module:Excerpt/templates/testcases|testcases]]
 
** {{tl|Excerpt}} / [[Template:Excerpt/sandbox|sandbox]] / [[Template:Excerpt/testcases|testcases]]
 
 
** {{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]]

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: