Difference between revisions of "MoodleDocs:Templates"

Jump to: navigation, search
(Update: version change)
m (Add info about New features template)
 
(15 intermediate revisions by 5 users not shown)
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.
 
{{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.
 
  
This automatically adds pages to the version category, for example [[:Category:Moodle 1.9]].
+
==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==
 
==Stub==
Line 19: Line 25:
  
 
Type <code><nowiki>{{Update}}</nowiki></code> to obtain the following message:
 
Type <code><nowiki>{{Update}}</nowiki></code> to obtain the following message:
<p class="note">''This page requires updating for Moodle 2.0.'' 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>
 
 
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]].
 
This automatically adds pages to [[:Category:Pages requiring updating]].
Line 69: Line 69:
 
Type <code><nowiki>{{Deletion}}</nowiki></code> at the top of the page to obtain the following message:
 
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>
 
<p class="note">'''This page requires deletion.''' Please use the page comments if necessary to state the reason for deletion.</p>
 
==Obsolete design==
 
 
Type <code><nowiki>{{obsolete design}}</nowiki></code> at the top of the page to obtain the message:
 
<p class="note">''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.''</p>
 
 
This automatically adds pages to [[:Category:Obsolete Design]].
 
  
 
==Page fully-protected==
 
==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.
 
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==
 
==Unsigned==
Line 91: Line 81:
 
==See also==
 
==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]]
 
[[Category:Templates]]
 +
 +
[[es:MoodleDocs:Plantillas]]

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 User:Terri Teacher)

See also