Module:Entrypoint/doc

Entrypoint
Description	Templating wrapper for Scribunto packages.
Author(s)	8nml (Fandom Dev Wiki)
Code source	Entrypoint
Status	Beta

This is a documentation subpage for Module:Entrypoint.
It may contain usage information, categories and other content that is not part of the original module page.

This module is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected.

Entrypoint templating wrapper for Scribunto packages. The module generates an entrypoint function that can execute Scribunto package calls in the template context. This allows a package to support both direct and template invocations.

Documentation

Package function

entrypoint(package) (function)

Entrypoint templating wrapper for Scribunto packages.

Parameter: package Scribunto package. (table)

Errors:

'you must specify a function to call' (string; line 85)

'the function you specified did not exist' (string; line 91)

'$2 is not a function' (string; line 95; optional)

Returns: Template entrypoint - main. (function)

Other items

main(frame) (function): Template entrypoint function generated by this module.; Parameter: frame Scribunto frame in module context. (Frame); Returns: Module output in template context. (string)

Notes

Parent frames are not available in Entrypoint's frame. This is because recursive (grandparent) frame access is impossible in legacy Scribunto due to empty-argument expansion cache limitations.
As Entrypoint enables template access rather than a new extension hook, it does not work with named numeric parameters such as 1= or 2=. This may result in unexpected behaviour such as Entrypoint and module errors.