View source for Module:Portal maintenance status/doc

{{Module rating |protected}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This module searches a Portal_talk: page's portal page, and returns an appropriate message based if {{tl|Portal maintenance status}} is found in the page's wikitext, and which parameters are used.
An error is reported if this module is used outside of the Portal_talk namespace. It can be demonstrated, in any namespace, with the {{para|demo}} and {{para|demo2}} parameters, which take the name of templates to "find" (instead of actually searching a page). 

== Usage ==
;<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''main''}}</code>
:Looks for {{tl|Portal maintenance status}} on a Portal_talk: page's related portal page.
:Returns an appropriate message string if found or an empty string if not found, or an error if used in the wrong namespace.
;<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''historical''}}</code>
:Looks for {{tl|Historical}} on a Wikipedia_talk: page's related project page.
:Returns <samp>yes</samp> if found or an empty string if not found, or an error if used in the wrong namespace.
;<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''featured''}}</code>
:Looks for {{tl|Featured portal}} on a Wikipedia_talk: page's related project page.
:Returns <samp>yes</samp> if found or an empty string if not found, or an error if used in the wrong namespace.

==Examples==
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=manual=yes}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}manual=yes}}
----
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=nonstandard=yes}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}nonstandard=yes}}
----
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=incomplete=yes}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}incomplete=yes}}
----
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=subpages=single}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}subpages=single}}
----
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=subpages=checked}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}subpages=checked}}
----
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=note=This is an example.}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}note=This is an example.}}
----
'''If the portal contains {{tld|Portal maintenance status|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=manual=yes|4=nonstandard=yes|5=subpages=single|6=incomplete=yes|7=note=[[Lorem ipsum]] dolor sit amet.}}'''

{{#invoke:Portal maintenance status|main|demo=Portal maintenance status{{!}}date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}{{!}}manual=yes{{!}}nonstandard=yes{{!}}subpages=single{{!}}incomplete=yes{{!}}note=[[Lorem ipsum]] dolor sit amet.}}
----
'''If the portal does not contain the template, there should be no output'''

{{#invoke:Portal maintenance status|main|demo=Lorem ipsum}}
----
'''If used in the wrong namespace, an error should be reported'''

<!-- {{#invoke:Portal maintenance status|main}}
 -->{{large|{{red|'''Lua error: Wrong namespace.'''}}}}
----

==See also==
*{{slink|Template:Portal maintenance status/testcases|Module testcases}}
{{portal templates navbox}}

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

}}</includeonly>