Module:Mainonly

Module documentation

This documentation is transcluded from Module:Mainonly/doc. [edit] [history] [purge]

This module is unused.

This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add {{Documentation}}/{{No documentation}} to the calling template's or parent's module documentation.

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. For a full list of modules using this helper click here

Function	Type	Use
`_main(arg)`	Any value	If the module is invoked in the content namespace, it will return arg, otherwise, it will return an empty string
`on_main()`	N/A	Returns true if invoked in the content namespace, otherwise false

--[[
{{Helper module|name=Mainonly
|fname1=_main(arg)
|ftype1=Any value
|fuse1=If the module is invoked in the content namespace, it will return arg, otherwise, it will return an empty string
|fname2=on_main()
|ftype2=N/A
|fuse2=Returns true if invoked in the content namespace, otherwise false
}}
--]]
--
-- Module to return text only when invoked in the content namespace
--

local p = {}

function p.main(frame)
	local ret = frame:getParent().args[1] or ''
	return p._main(ret)
end

function p._main(text)
	if mw.title.getCurrentTitle().namespace == 0 then
		return text
	else
		return ''
	end
end

--
-- Boolean for whether or not the page is in the mainspace
-- Sometimes it might be better to just check first
-- Rather than spend processing time on something that won't be used
function p.on_main()
	return mw.title.getCurrentTitle().namespace == 0
end

return p