Jump to content
Search

This wiki is under development. Features may be missing. Data loss is unlikely, but possible. Read the announcement.

Template:Doccan

From Ubuntu Wiki

This template displays a standardized "documentation candidate" notice box, and adds the page to Category:Documentation candidates.

Examples

Default text:

Documentation Candidate

This page should be considered for migration to the official Ubuntu documentation.

Custom text:

Documentation Candidate

This section should be a part of the official Ubuntu documentation.

Opt out of categorization:

Documentation Candidate

This page should be considered for migration to the official Ubuntu documentation.

TemplateData

A message box marking a page or section as a documentation candidate. Automatically adds the page to Category:Documentation candidates (in the main namespace).

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Message Texttext

Overrides the default notice text.

Default
This page should be considered for migration to the official Ubuntu documentation.
Contentoptional
HTML IDid

An optional HTML id attribute for linking directly to this notice on a page.

Stringoptional
Disable Categorizationnocat

Set to 'yes' to prevent this page from being added to Category:Documentation candidates.

Booleanoptional