Template:Portal maintenance status/doc

From The Goon Show Depository

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:

  1. Edit the portal using source editor (edit source tab on the portal)
  2. 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}})
  3. 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):

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)

Examples

{{Portal maintenance status|date=December 2024|maintainer1=Example}}

{{Portal maintenance status|date=December 2024|manual=yes}}

{{Portal maintenance status|date=December 2024|broken=yes}}

{{Portal maintenance status|date=December 2024|broken=minor}}

{{Portal maintenance status|date=December 2024|nonstandard=yes}}

{{Portal maintenance status|date=December 2024|incomplete=yes}}

{{Portal maintenance status|date=December 2024|subpages=checked}}

{{Portal maintenance status|date=December 2024|subpages=none}}

{{Portal maintenance status|date=December 2024|upgrade=yes}}

{{Portal maintenance status|date=December 2024|update=yes}}

{{Portal maintenance status|date=December 2024|notes=This is a test note.}}

{{Portal maintenance status|date=December 2024|manual=yes|maintainer1=Example|broken=yes|nonstandard=yes|incomplete=yes|...}}

TemplateData

TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Portal maintenance status in articles based on its TemplateData.

TemplateData for Portal maintenance status

Hidden notice box used to record portal maintenance metadata

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Manually maintainedmanual

Mark portals that are manually maintained

Default
no
Example
manual=yes
Booleanoptional
Brokenbroken

Mark portals with errors or layout issues needing attention

Default
(empty)
Example
broken=yes, broken=minor
Stringoptional
Non-standardnonstandard

Mark portals with significantly unique layout or markup

Default
no
Example
nonstandard=yes
Booleanoptional
Subpagessubpages

Subpage triage status

Default
untriaged
Example
subpages=single, subpages=triaged
Stringsuggested
Incompleteincomplete

Mark portals that are incomplete or under construction

Default
no
Example
incomplete=yes
Booleanoptional
Datedate

Date of template placement

Example
date=April 2018, date={{subst:DATE}}
Datesuggested
Embedembed

Used to embed this template in the WikiProject Portals banner

Default
no
Example
embed=yes
Booleanoptional
Additional Notenote notes

Free-form notes field, can accept wikitext.

Default
(empty)
Example
note=This is a test note.
Stringoptional
Portal Maintainermaintainer maintainer1

Name of primary portal maintainer. Marks the portal as manually maintained.

Default
(empty)
Example
maintainer=Example
Usersuggested
Portal Maintainer 2maintainer2

See 'maintainer'

Default
(empty)
Useroptional
Portal Maintainer 3maintainer3

See 'maintainer'

Default
(empty)
Useroptional
Portal Maintainer 4maintainer4

See 'maintainer'

Default
(empty)
Useroptional
upgradeupgrade

no description

Unknownoptional
updateupdate

no description

Unknownoptional

See also