Difference between revisions of "MoodleDocs:Templates"

Jump to: navigation, search
(Replacing page with 'Cloning')
m (Reverted edits by JEAF1 (Talk) to last version by Helen Foster)
Line 1: Line 1:
Cloning
+
{{Help}}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==
 +
 
 +
<span class="small-info-right"><span class="text-small">Moodle</span><span class="text-big new">1.9</span></span>
 +
When adding documentation about a new feature, type <code><nowiki>{{Moodle 1.9}}</nowiki></code> (or <code><nowiki>{{Moodle 2.0}}</nowiki></code> etc.) to obtain a version indicator.
 +
 
 +
This automatically adds pages to the version category, for example [[:Category:Moodle 1.9]].
 +
 
 +
==Stub==
 +
 
 +
Type <code><nowiki>{{stub}}</nowiki></code> to obtain the following message:
 +
<p class="note">''This article is a [[MoodleDocs:Stub|stub]]. Please help improve Moodle Docs by [{{SERVER}}{{localurl:{{NAMESPACE}}:{{PAGENAME}}|action=edit}} editing it] and adding some content.''</p>
 +
 
 +
This automatically adds pages to [[:Category:Stubs]].
 +
 
 +
==Update==
 +
 
 +
Type <code><nowiki>{{Update}}</nowiki></code> to obtain the following message:
 +
<p class="note">''This page requires updating for Moodle 1.9.'' Please do so and remove this template when finished.</p>
 +
 
 +
This automatically adds pages to [[:Category:Pages requiring updating]].
 +
 
 +
==Update section==
 +
<span class="small-info-right">''Please help update this section for Moodle 1.9.''</span>
 +
Type <code><nowiki>{{Update section}}</nowiki></code> to obtain the following message:
 +
 
 +
This automatically adds pages to [[:Category:Pages requiring updating]].
 +
 
 +
==Review==
 +
 
 +
Type <code><nowiki>{{Review}}</nowiki></code> to obtain the following message:
 +
<p class="note">''This page requires a review.'' Please do so and remove this template when finished.</p>
 +
 
 +
This automatically adds pages to [[:Category:Pages requiring a review]].
 +
 
 +
==Work in progress==
 +
 
 +
Type <code><nowiki>{{Work in progress}}</nowiki></code> to obtain the following message:
 +
<p class="note">'''Note:''' This article is a work in progress. Please use the page comments for any recommendations/suggestions for improvement.</p>
 +
 
 +
==Page for deletion==
 +
 
 +
Type <code><nowiki>{{Deletion}}</nowiki></code> at the top of the page to obtain the following message:
 +
<p class="note">'''This page requires deletion.''' Please use the page comments if necessary to state the reason for deletion.</p>
 +
 
 +
==Page fully-protected==
 +
 
 +
Type <code><nowiki>{{Pp-protection|reason}}</nowiki></code> 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 {{Tl|Pp-protection}} for more information about this template.
 +
 
 +
==Uncategorised==
 +
Type <code><nowiki>{{Uncat}}</nowiki></code> at the top of a page which is not categorised to remind editors to add one or more categories. See {{Tl|Uncat}} for more information about this template.
 +
 
 +
==Unsigned==
 +
Type <code><nowiki>{{Unsigned|Terri Teacher}}</nowiki></code> after an unsigned talk page comment to obtain the following message:
 +
 
 +
<small>(''The preceding comment was added by'' [[User:Terri Teacher]])</small>
 +
 
 +
==See also==
 +
 
 +
* [https://docs.moodle.org/en/index.php?title=Special%3AAllpages&from=&namespace=10 All pages (Template namespace)] - full list of templates used in Moodle Docs
 +
 
 +
[[Category:Templates]]

Revision as of 07:35, 10 November 2009


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

Moodle1.9

When adding documentation about a new feature, type
{{Moodle 1.9}}
(or
{{Moodle 2.0}}
etc.) to obtain a version indicator.

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

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 1.9. 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 for any recommendations/suggestions for improvement.

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.

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 Template:Tl 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 Template:Tl 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