Editing Module:FeaturedTopicSum/doc (section)

=== From Lua ===

First, load the module.

<syntaxhighlight lang="lua">
local mFTS = require('Module:FeaturedTopicSum')
</syntaxhighlight>

Then, you can find the status of a topic with the <code>status</code> function.

<syntaxhighlight lang="lua">
mFTS.status(topic)
</syntaxhighlight>

The <var>topic</var> parameter is the name of the topic (a string). For example, it would be "Norid" for [[Wikipedia:Featured topics/Norid]]. If the topic is featured, the function will return "FT", and if not, the function will return "GT". (Topics that aren't featured are assumed to be Good Topics.)

It is also possible to use the <code>_main</code> function in the same manner as you would use [[Template:FeaturedTopicSum]]. However, this is not recommended, as using the <code>status</code> function with if .. then .. else .. end statements is usually more readable, and can be more efficient.

<syntaxhighlight lang="lua">
mFTS._main(args)
</syntaxhighlight>

The <var>args</var> parameter is a table of arguments. Please consult the template page for documentation.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>