Module:PageListTools/doc: Difference between revisions

From RuneRealm Wiki
Jump to navigation Jump to search
Content added Content deleted
(Created page with "{{Documentation}} {{Helper module |name = PageListTools |fname1 = pageswithcats(cats, [logging]) |ftype1 = table, boolean/nil |fuse1 = Returns a list of pages with the specified categories. Uses SMW.<br/>Each entry can consist of several categories AND-ed together with ' '. |fname2 = pageswithconditions(conditions, [logging]) |ftype2 = string, boolean/nil |fuse2 = Returns a list of pages that satisfies the given SMW conditions. |fname3 = pagelistchecks(pages, [logging])...")
 
No edit summary
Tag: Reverted
Line 4: Line 4:
|fname1 = pageswithcats(cats, [logging])
|fname1 = pageswithcats(cats, [logging])
|ftype1 = table, boolean/nil
|ftype1 = table, boolean/nil
|fuse1 = Returns a list of pages with the specified categories. Uses SMW.<br/>Each entry can consist of several categories AND-ed together with ' '.
|fuse1 = Returns a list of mw.pages with the specified categories. Uses SMW.<br/>Each entry can consist of several categories AND-ed together with ' '.
|fname2 = pageswithconditions(conditions, [logging])
|fname2 = pageswithconditions(conditions, [logging])
|ftype2 = string, boolean/nil
|ftype2 = string, boolean/nil
|fuse2 = Returns a list of pages that satisfies the given SMW conditions.
|fuse2 = Returns a list of mw.pages that satisfies the given SMW conditions.
|fname3 = pagelistchecks(pages, [logging])
|fname3 = pagelistchecks(mw.pages, [logging])
|ftype3 = table, boolean/nil
|ftype3 = table, boolean/nil
|fuse3 = Given a list of pages, this function returns lists of pages that are either non-existing (invalid), redirects or duplicates.
|fuse3 = Given a list of mw.pages, this function returns lists of mw.pages that are either non-existing (invalid), redirects or duplicates.
|fname4 = pageswithcatsdpl(cats, [logging])
|fname4 = pageswithcatsdpl(cats, [logging])
|ftype4 = table, boolean/nil
|ftype4 = table, boolean/nil
|fuse4 = Returns a list of pages with the specified categories. Uses DPL.<br/>Each entry can consist of several categories AND-ed together with '&'.
|fuse4 = Returns a list of mw.pages with the specified categories. Uses DPL.<br/>Each entry can consist of several categories AND-ed together with '&'.
|fname5 = pageswithconditionsdpl(conditions, [logging])
|fname5 = pageswithconditionsdpl(conditions, [logging])
|ftype5 = table, boolean/nil
|ftype5 = table, boolean/nil
|fuse5 = Returns a list of pages that satisfies the given DPL conditions.
|fuse5 = Returns a list of mw.pages that satisfies the given DPL conditions.
}}
}}

Revision as of 00:12, 17 October 2024

This is a documentation subpage for Module:PageListTools.
It contains usage information, categories, and other content that is not part of the original module page.
Module:PageListTools requires Module:Array.
Module:PageListTools requires Module:DPLlua.
Module:PageListTools requires libraryUtil.
Module:PageListTools is required by Module:Elemental weakness table.
Module:PageListTools is required by Module:Slottable.

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See RuneScape:Lua/Helper modules for a full list and more information.

FunctionTypeUse
pageswithcats(cats, [logging])table, boolean/nilReturns a list of mw.pages with the specified categories. Uses SMW.
Each entry can consist of several categories AND-ed together with ' '.
pageswithconditions(conditions, [logging])string, boolean/nilReturns a list of mw.pages that satisfies the given SMW conditions.
pagelistchecks(mw.pages, [logging])table, boolean/nilGiven a list of mw.pages, this function returns lists of mw.pages that are either non-existing (invalid), redirects or duplicates.
pageswithcatsdpl(cats, [logging])table, boolean/nilReturns a list of mw.pages with the specified categories. Uses DPL.
Each entry can consist of several categories AND-ed together with '&'.
pageswithconditionsdpl(conditions, [logging])table, boolean/nilReturns a list of mw.pages that satisfies the given DPL conditions.