MoodleDocs:Templates: Difference between revisions

Latest revision as of 09:34, 26 October 2015

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.

New features

Type {{New features}} to obtain the following message (with X.Y replaced with the current docs version): New feature
in Moodle X.Y!

This automatically adds pages to Category:New features

Improve

Type {{Improve}} to obtain the following message:

This page really needs improving. Please see the page comments for suggestions of what to write.

This automatically adds pages to Category:Pages needing improvement.

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. Please do so and remove this template when finished.

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.

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.

Unsigned

Type {{Unsigned|Terri Teacher}} after an unsigned talk page comment to obtain the following message:

(The preceding comment was added by Terri Teacher)

@@ Line 1: / Line 1: @@
 {{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.
+==New features==
-==Moodle version==
+Type <code><nowiki>{{New features}}</nowiki></code> to obtain the following message (with X.Y replaced with the current docs version):
+<span class="small-info-right">New feature<br />in '''Moodle X.Y'''!</span>
-<span class="small-info-right"><span class="text-small">Moodle</span><span class="text-big new">1.9</span></span>
+This automatically adds pages to [[:Category:New features]]
-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.
+==Improve==
+Type <code><nowiki>{{Improve}}</nowiki></code> to obtain the following message:
+<p class="note">''This page really needs improving.'' Please see the page comments for suggestions of what to write.</p>
+This automatically adds pages to [[:Category:Pages needing improvement]].
 ==Stub==
@@ Line 11: / Line 19: @@
 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>
+<p class="note">''This page requires updating.'' Please do so and remove this template when finished.</p>
-==Update section==
+This automatically adds pages to [[:Category:Pages requiring updating]].
-<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:
 ==Review==
@@ Line 25: / Line 33: @@
 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>
+<p class="note">'''Note:''' This article is a work in progress. Please use the page comments or an appropriate [{{{forumurl|http://moodle.org/course/view.php?id=5}}} moodle.org forum] for any recommendations/suggestions for improvement.</p>
+==Infobox Project==
+{| style="margin: 0 0 1em 1em; border-collapse: collapse; float: right; width: 350px; font-size: 90%;" border="1"
+|-
+! style="text-align: center; padding: 0.2em; background-color: #ccc; font-size: 120%;" colspan="2" | '''{{{name}}}'''
+|-
+| style="padding: 0.2em;" | Project state
+| style="padding: 0.2em;" | {{{state}}}
+|-
+| style="padding: 0.2em;" | Tracker issue
+| style="padding: 0.2em;" | {{{tracker}}}
+|-
+| style="padding: 0.2em;" | Discussion
+| style="padding: 0.2em;" | {{{discussion}}}
+|-
+| style="padding: 0.2em;" | Assignee
+| style="padding: 0.2em;" | {{{assignee}}}
+|-
+|}
+Type <code><nowiki>{{Infobox Project}}</nowiki></code> to obtain an information box.
+<br />
+<br />
+<br />
+<br />
 ==Page for deletion==
@@ Line 35: / Line 69: @@
 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.
+==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
+* [https://docs.moodle.org/20/en/index.php?title=Special%3AAllPages&from=&to=&namespace=10 All pages (Template namespace)] - full list of templates used in Moodle Docs
 [[Category:Templates]]
+[[es:MoodleDocs:Plantillas]]

Documentation