MoodleDocs:Templates

Moodle Docs help

• Guidelines for contributors
• Editing help
• Style guide
• Templates
• Documentation philosophy
• Moodle Docs page features
• User settings
• Login help
• MoodleDocs FAQ

This page lists the most commonly used templates used in Moodle Docs. In addition to displaying a message, many templates also automatically add pages to a category.

Moodle version

Moodle2.0

When adding documentation about a new feature, type

{{Moodle 2.0}}

(or

{{Moodle 2.1}}

etc.) to obtain a version indicator.

This automatically adds pages to the version category, for example Category:Moodle 2.0.

Stub

Type

{{stub}}

to obtain the following message:

This article is a stub. Please help improve Moodle Docs by editing it and adding some content.

This automatically adds pages to Category:Stubs.

Update

Type

{{Update}}

to obtain the following message:

This page requires updating for Moodle 2.0. Please do so and remove this template when finished.

This automatically adds pages to Category:Pages requiring updating.

Update section

Please help update this section for Moodle 1.9.

Type

{{Update section}}

to obtain the following message:

This automatically adds pages to Category:Pages requiring updating.

Review

Type

{{Review}}

to obtain the following message:

This page requires a review. Please do so and remove this template when finished.

This automatically adds pages to Category:Pages requiring a review.

Work in progress

Type

{{Work in progress}}

to obtain the following message:

Note: This article is a work in progress. Please use the page comments or an appropriate moodle.org forum for any recommendations/suggestions for improvement.

Infobox Project

{{{name}}}
Project state	{{{state}}}
Tracker issue	{{{tracker}}}
Discussion	{{{discussion}}}
Assignee	{{{assignee}}}

Type

{{Infobox Project}}

to obtain an information box.

Page for deletion

Type

{{Deletion}}

at the top of the page to obtain the following message:

This page requires deletion. Please use the page comments if necessary to state the reason for deletion.

Obsolete design

Type

{{obsolete design}}

at the top of the page to obtain the message:

This article is a design document which is no longer in use, the code it describes having been written and added to the Moodle codebase, or simply considered then abandoned. The information it contains is likely to be out of date, especially API and Database Schema specifications.

This automatically adds pages to Category:Obsolete Design.

Page fully-protected

Type

{{Pp-protection|reason}}

at the top of fully-protected page to indicate that the page can only be edited by administrators and the reason for why this is the case. See {{Pp-protection}} for more information about this template.

Uncategorised

Type

{{Uncat}}

at the top of a page which is not categorised to remind editors to add one or more categories. See {{Uncat}} for more information about this template.

Unsigned

Type

{{Unsigned|Terri Teacher}}

after an unsigned talk page comment to obtain the following message:

(The preceding comment was added by User:Terri Teacher)

See also

• All pages (Template namespace) - full list of templates used in Moodle Docs