Template:To do/doc

From Fanlore
Jump to navigation Jump to search

Purpose

This template adds a to-do list to a talk page, which is retrieved from a dedicated subpage. A to-do list outlines suggested improvements to an article, such as content coverage, cleanup, structure, and more. For example, if you place this template on Talk:Article name, then type in the to-do items on a Talk:Article name/to do page, then this template will automatically display them. This template also adds the talk page to the category Category:Pages with to-do lists.

Usage

To use this template, copy the below code and paste it at the beginning of a talk page:

Basic usage

{{To do}}

All parameters

{{To do
| collapsed =
| for =
| inner =
| list =
| maxheight =
| nocats =
| nopreload =
| small =
| target =
}}

Parameters

All fields are optional.

  • |collapsed=: Specifies whether the template should be initially collapsed or not. Accepts yes or no, defaults to no.
  • |for=:
  • |inner=: If specified, the template uses the argument as the to-do list instead of the subpage.
  • |list=: If specified, the template retrieves the to-do list from the subpage specified from the argument. Must use the prefix ./, e.g. ./TO DO.
  • |maxheight=: If specified, sets the maximum height of the to-do list before vertical scroll bars appear to h (a number with suffix px, em or %; e.g. 200px) .
  • |nocats=: Specifies whether or not the page should be excluded from Category:Pages with to-do lists. Accepts yes or no, defaults to no.
  • |nopreload=: Specifies whether or not clicking the edit link in the template takes the user to a blank page instead of a preloaded one. Accepts yes or no, defaults to no.
  • |small=: Specifies whether or not the template is formatted as the 'small' version. Accepts yes or no, defaults to no.
  • |target=: If specified, the template retrieves the to-do list from a different article.

Example

When placed on this page, {{to do}} retrives the to-do list from Template:To do/to do:

Copyright