View source for Module:Page assessment/doc

{{Module rating|alpha}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This module returns a page's assessment (class rating), by parsing the first <code>pageAssessments</code> property of the <code>mw.title</code> object for a given page name.

If the API does not return a <code>pageAssessments</code> table, it tries
* Detecting non-existent pages (Needed class); or
* Detecting non-existent talk pages (Unassessed class); or
* Detecting redirects and disambiguation pages (Redirect or Disambig class); or
* Looking at the namespace of the page

== Usage ==
===text===
Returns the class as text.
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|main|''page name''}}</code>

;Examples
:<code><nowiki>{{#invoke:Page assessment|main|Wikipedia}}</nowiki></code> → {{#invoke:Page assessment|main|Wikipedia}}
:<code><nowiki>{{#invoke:Page assessment|main|Wiktionary}}</nowiki></code> → {{#invoke:Page assessment|main|Wiktionary}}
:<code><nowiki>{{#invoke:Page assessment|main|Wikt}}</nowiki></code> → {{#invoke:Page assessment|main|Wikt}}

===icon===
Returns the class as an icon.
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|icon|''page name''}}</code>

;Examples
:<code><nowiki>{{#invoke:Page assessment|icon|Wikipedia}}</nowiki></code> → {{#invoke:Page assessment|icon|Wikipedia}}
:<code><nowiki>{{#invoke:Page assessment|icon|Wiktionary}}</nowiki></code> → {{#invoke:Page assessment|icon|Wiktionary}}
:<code><nowiki>{{#invoke:Page assessment|icon|Wikt}}</nowiki></code> → {{#invoke:Page assessment|icon|Wikt}}

===iconLink===
Returns the class as an icon and a link to the page.
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|iconLink|''page name''}}</code>

;Examples
:<code><nowiki>{{#invoke:Page assessment|iconLink|Wikipedia}}</nowiki></code> → {{#invoke:Page assessment|iconLink|Wikipedia}}
:<code><nowiki>{{#invoke:Page assessment|iconLink|Wiktionary}}</nowiki></code> → {{#invoke:Page assessment|iconLink|Wiktionary}}
:<code><nowiki>{{#invoke:Page assessment|iconLink|Wikt}}</nowiki></code> → {{#invoke:Page assessment|iconLink|Wikt}}

===In other templates===
The output can be passed into other templates or modules, for example to generate table cells:
<pre style="margin-left:1.6em">
{|class=wikitable
! Class !! Article
|-
{{class|{{#invoke:Page assessment|main|Wiktionary}}}}<td>[[Wiktionary]]</td>
|}
</pre>
{|class=wikitable style="margin-left:1.6em"
! Class !! Article
|-
{{class|{{#invoke:Page assessment|main|Wiktionary}}}}<td>[[Wiktionary]]</td>
|}

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

}}</includeonly>