Template:Portal maintenance status/doc

This is a documentation subpage for Template:Portal maintenance status.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Separated entries (sandbox)

Usage

The {{portal maintenance status}} template should be placed at the top of the portal page, not within a table or another template, due to template limits.

All parameters:

{{Portal maintenance status |{{subst:DATE}} |maintainer1= |maintainer2= |maintainer3= |maintainer4= |manual= |upgrade= |notes= |update= |broken= |nonstandard= |incomplete= |subpages= 
}}

{{Portal maintenance status 
|{{subst:DATE}} 
|maintainer1= 
|maintainer2= 
|maintainer3= 
|maintainer4= 
|manual= 
|upgrade= 
|notes=
|update=
|broken= 
|nonstandard= 
|incomplete= 
|subpages= 
}}

Optional parameters

The following parameters should be populated, where possible:

|date= Date of last template update
|maintainer[1-4]=Example: Used to specify users who look after the portal in question.
|subpages= Subpage triage status
Set to untriaged or yes (or leave unset) if the subpages have not yet been checked.

Once a portal's subpages have been checked, set to:
checked or triaged or keep (or any other value): if any unneeded subpages have been removed.

none or single or singlepage or no: if the portal has a single page layout (no subpages exist).

This template can also hold miscellaneous notes:

|notes=Text goes here: to record notes in plain text or even wikitext markup.

Include the following parameters, if they are applicable; otherwise, omit the parameter (or set to no)

|manual=yes (or any other value): Portal is manually maintained. You should specify at least one maintainer using the |maintainer[1-4]= parameter.
|upgrade=yes (or any other value): Portal needs upgrading. Use the |notes= field to elaborate.
|update=yes (or any other value): Portal needs updating. Use the |notes= field to elaborate.
|broken= Portal has issues needing attention. Use the |notes= field to elaborate.
Set to yes, major or serious: for portals that have errors or major problems, such as Lua timeouts, template parsing limits exceeded, or completely wrecked layout

Set to minor, access or layout: for portals that have minor problems, such as accessibility issues or minor layout issues
|nonstandard=yes (or any other value): Portal has a nonstandard layout
|incomplete=yes (or any other value): Portal is under construction or incomplete

Aliases

The parameter |note= is recognised as an alias for |notes=. If both |notes= and |note= are present, there may be unexpected results.

How to update the maintenance information for a portal

To change the maintenance information for a portal:

Edit the portal using source editor (edit source tab on the portal)
In the first few lines of the edit box (not inside of a table or another template), there should be this template ({{Portal maintenance status}})
Edit the parameters of this template to change the information as needed; what each parameter does is described above in #Usage.

Tracking categories

When in portal space, this template populates the following hidden categories (or their subcategories):

Category:Portals with undated maintenance templates – Added when date is unset or missing
Category:Portals with named maintainer – Added when one or more maintainers are listed
Category:Portals with no named maintainer – Added when no maintainers are listed
Category:Automatically maintained portals with listed maintainers – Added when manual is set to no or left out and maintainer(s) have been provided
Category:All manually maintained portal pages – Added when manual is set to yes
Category:Manually maintained portal pages with no date – Added when manual is set to yes but no date is listed
Category:Manually maintained portals without listed maintainers – Added when manual is set to yes, but no maintainer parameters have been provided
Category:Portals that need upgrading – Added when upgrade is set to yes
Category:Portals that need updating – Added when update is set to yes
Category:Portals with errors in need of immediate attention – Added when broken is set to yes
Category:Portals with minor issues in need of attention – Added when broken is set to minor
Category:Portals under construction – Added when incomplete is set to yes
Category:All portals with untriaged subpages – Added when subpages is unset, or set to untriaged
Category:All portals with triaged subpages – Added when subpages is set to triaged
Category:Single-page portals – Added when subpages is set to single or singlepage

Display

By default, this template produces no visible output when in portal space.

To show hidden categories, enable that setting in your preferences ("Appearance" tab, checkbox under "Advanced options")
To show a message box like the examples below, add the following line to your personal CSS:
```
div.portal-maintenance-status { display:block !important }
```
Alternatively, the messages may be viewed on portal talk pages, inside the {{WikiProject Portals}} banner (which automatically transcludes them)