Difference between revisions of "Template:At school/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Izno
(rv)
blackwiki>Robertsky
(add documentation for style parameter usage.)
Line 4: Line 4:
 
== Parameters ==
 
== Parameters ==
 
This template has four parameters:
 
This template has four parameters:
* type
+
* {{code|type}}
* exams
+
* {{code|exams}}
* returndate
+
* {{code|returndate}}
* institutionname
+
* {{code|institutionname}}
* name
+
* {{code|name}}
 +
* {{code|style}}
  
 
=== type ===
 
=== type ===
The type parameter conveys what type of educational institute you are learning in. It is conveyed using the following syntax:
+
The {{code|type}} parameter conveys what type of educational institute you are learning in. It is conveyed using the following syntax:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
<nowiki>{{At school|type=school}}</nowiki>
 
<nowiki>{{At school|type=school}}</nowiki>
Line 22: Line 23:
  
 
=== exams ===
 
=== exams ===
The exams parameter conveys if you're taking exams. It is conveyed using the following syntax:
+
The {{code|exams}} parameter conveys if you're taking exams. It is conveyed using the following syntax:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
<nowiki>{{At school|exams=yes}}</nowiki>
 
<nowiki>{{At school|exams=yes}}</nowiki>
Line 28: Line 29:
  
 
=== returndate ===
 
=== returndate ===
The returndate parameter conveys when you will return back to edit on Wikipedia. It is conveyed using the following syntax:
+
The {{code|returndate}} parameter conveys when you will return back to edit on Wikipedia. It is conveyed using the following syntax:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
<nowiki>{{At school|returndate=31 December 2199}}</nowiki>
 
<nowiki>{{At school|returndate=31 December 2199}}</nowiki>
Line 34: Line 35:
  
 
=== institutionname ===
 
=== institutionname ===
The institutionname parameter conveys when you will return back to edit on Wikipedia. It is conveyed using the following syntax:
+
The {{code|institutionname}} parameter conveys when you will return back to edit on Wikipedia. It is conveyed using the following syntax:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
<nowiki>{{At school|institutionname=Singapore Management University}}</nowiki>
 
<nowiki>{{At school|institutionname=Singapore Management University}}</nowiki>
Line 42: Line 43:
  
 
=== name ===
 
=== name ===
The name parameter conveys the user's name. It is conveyed using the following syntax:
+
The {{code|name}} parameter conveys the user's name. It is conveyed using the following syntax:
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
<nowiki>{{At school|name=ExampleUser}}</nowiki>
 
<nowiki>{{At school|name=ExampleUser}}</nowiki>
 
</pre>
 
</pre>
 +
 +
=== style ===
 +
The style parameter takes in CSS style. The default CSS style takes after {{tl|tmbox}} (for talk pages) and {{tl|mbox}} for other spaces (as inherited from {{tl|wikibreak}}), with <nowiki>{{code|text-align: center;}}</nowiki> added for the centered text alignment. It is conveyed using the following syntax:
 +
<pre style="overflow:auto;">
 +
<nowiki>{{At school|style=text-align: center; background-color: #E75480; color:#000;}}</nowiki>
 +
</pre>
 +
 +
Note: if the {{code|style}} parameter is used, <nowiki>{{code|text-align: center;}}</nowiki> has to be included in the {{code|style}} parameter to keep the centered text alignment.
  
 
== Example Usage ==
 
== Example Usage ==

Revision as of 18:12, 10 September 2020

This is a template for indicating that you are in an educational institute and may be inactive for periods of time. Note that the "be able to do some editing" link will work, providing it is placed on a user page or user talk page.

Parameters

This template has four parameters:

  • type
  • exams
  • returndate
  • institutionname
  • name
  • style

type

The type parameter conveys what type of educational institute you are learning in. It is conveyed using the following syntax:

{{At school|type=school}}

Valid types are:

  • college
  • university
  • graduate

exams

The exams parameter conveys if you're taking exams. It is conveyed using the following syntax:

{{At school|exams=yes}}

returndate

The returndate parameter conveys when you will return back to edit on Wikipedia. It is conveyed using the following syntax:

{{At school|returndate=31 December 2199}}

institutionname

The institutionname parameter conveys when you will return back to edit on Wikipedia. It is conveyed using the following syntax:

{{At school|institutionname=Singapore Management University}}

Note: This doesn't link to the institution's Wikipedia article, if it is available.

name

The name parameter conveys the user's name. It is conveyed using the following syntax:

{{At school|name=ExampleUser}}

style

The style parameter takes in CSS style. The default CSS style takes after {{tmbox}} (for talk pages) and {{mbox}} for other spaces (as inherited from {{wikibreak}}), with {{code|text-align: center;}} added for the centered text alignment. It is conveyed using the following syntax:

{{At school|style=text-align: center; background-color: #E75480; color:#000;}}

Note: if the style parameter is used, {{code|text-align: center;}} has to be included in the style parameter to keep the centered text alignment.

Example Usage

This code:

{{At school}}

Produces this: Template:Wikibreak

This code:

{{At school|exams=yes}}

Produces this: Template:Wikibreak

This code:

{{At school|type=college|exams=yes}}

Produces this: Template:Wikibreak

This code:

{{At school|type=college|exams=yes|institutionname=Singapore Management University}}

Produces this: Template:Wikibreak

This code:

{{At school|type=college|exams=yes|institutionname=Singapore Management University|returndate=31 December 2199}}

Produces this: Template:Wikibreak


This code:

{{At school|type=college|exams=yes|institutionname=Singapore Management University|returndate=31 December 2199|name=Example User}}

Produces this: Template:Wikibreak

Consolidation of education wikibreak templates

On 5 February 2020 and 24 February 2020, consensus were reached to delete the following templates and consolidate under this template. The following table maps the deleted templates to the relevant parameters here:

Comparative table between deleted templates and this template
Deleted template This template
{{University wikibreak}}
{{At school|type=university}}
{{College wikibreak}}
{{At school|type=college}}
{{Education wikibreak}}
{{Attempting school wikibreak}}
{{At school}}

See also

Template:Wikibreak templates