imported>Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:19:08Z

Added the page to Category:Module documentation pages

New page

{{Lua|Module:Arguments}}
'''Module:FeaturedTopicSum''' is used to find out whether a topic is [[WP:GT|good]] or [[WP:FT|featured]].

Each call to a new topic, using any of the functions in this module, will use three [[Wikipedia:Template limits#Expensive parser function calls|expensive parser function calls]]. This means that only 133 different topics can be listed on a page before the page goes over the limit of 500 expensive parser function calls per page (not counting other expensive function calls that might be used).

== Usage ==
=== From wikitext ===

From wikitext this module should be used via [[Template:FeaturedTopicSum]]. Please see the template page for documentation.

=== 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 | |


}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>

Module:FeaturedTopicSum/doc - Revision history

imported>Warudo: Added the page to :Category:Module documentation pages