Module:Ns has subpages/doc

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

This Lua module is used in system messages, and on approximately 3,060,000 pages, or roughly 5% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This module can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

This module finds whether a given namespace can have subpages.

Usage

From wikitext

From wikitext this module must be used via the {{ns has subpages}} template. Please see the template page for documentation.

From Lua

Usually Lua modules should use mw.site.namespaces[namespace].hasSubpages rather than this module. But if you have a good reason, it can be accessed like this:

Load the module:

local mNsHasSubpages = require('Module:Ns has subpages')

The subpage information can be found with the ._main function:

mNsHasSubpages._main(ns, frame)

ns is the namespace name, number, or a page name. It defaults to the current namespace.
frame is a frame object with which we can call frame:callParserFunction if necessary. This is optional, and intended for internal use.