Difference between revisions of "Help:Year Upping"

From BRGS Wiki
Jump to: navigation, search
m (Reverted edits by Ifewazuwede (talk) to last revision by Clizard)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Introduction==
 
==Introduction==
 +
These commands automatically add category information which puts you in the right year group and form and is automatically (by admins) updated every year. This remains the easiest way of keeping everyone up-to-date. You can also safely refer to forms and current years using the below commands.
 +
 +
* Add the following command to a student's page for them to be put into the correct form and year group categories:
 +
{{YFS|YEAR|FORM|NAME}}
 +
{{YFS|2005|R|Morris, Max}}
 +
 +
Search for examples to get a quick overview (e.g. [[David Bewicke]]) of how to set up your own pages correctly.
 +
 +
==Motivation==
 
'''Year Upping''' is a regular problem on the wiki. Most student pages want to refer to their year or form, but this information changes every year, so our gnomes and helpers have to go and edit every page to keep everyone up to date at the beginning of September. This is the problem the year upping project hopes to resolve - preferably in a simple, user-friendly way.
 
'''Year Upping''' is a regular problem on the wiki. Most student pages want to refer to their year or form, but this information changes every year, so our gnomes and helpers have to go and edit every page to keep everyone up to date at the beginning of September. This is the problem the year upping project hopes to resolve - preferably in a simple, user-friendly way.
  
This project is still under development and will probably be ''going live'' this September, so any comments, praise, criticisms or suggestions would be very helpful (post on the discussions page or by email: {{email}}).
+
==Creating and Updating Year Templates==
 +
*'''Your intake year may not have been added yet''', if this is the case then you'll need to either wait for them to come online or add them yourself before using the commands ([[Template:Intake YYYY]] and [[Template:Year YYYY]], following the output specification below and using [[Template:Year 2005]] as an example).
  
===Caveats===
+
Each year we update Intake YYYY with the year number and update Year YYYY and Intake YYYY for the leaving year. Therefore assuming we were up to date last year there should be 9 template changes required per year. One for each year 7-13 and two updated to leavers who become 'intake of 20xx' instead of Year x.
*'''These commands are subject to change''' as they are only proposals at this stage.
+
*'''Your intake year may not have been added yet''', if this is the case then you'll need to either wait for them to come online or add them yourself ([[Template:Intake YYYY]] and [[Template:Year YYYY]], following the output specification below and using [[Template:Year 2005]] as an example).
+
  
 
==Commands==
 
==Commands==
Line 33: Line 41:
 
  '''Max Morris''' is currently tipped to be the next BRGS [[headmaster]] and is currently in the form {{Form|2005|R}}.
 
  '''Max Morris''' is currently tipped to be the next BRGS [[headmaster]] and is currently in the form {{Form|2005|R}}.
  
==={{SYF|Year|Form Letter|Surname, Forename}}===
+
==={{YFS|Year|Form Letter|Surname, Forename}}===
'''SYF''' is the acronym for Student, Year and Form. Adding this to a page automatically adds the person onto the necessary category lists, which are kept up-to-date every year.
+
'''YFS''' is the acronym for Year, Form and Student (name). Adding this to a page automatically adds the person onto the necessary category lists, which are kept up-to-date every year. (You can also use SYF).
  
 
To use the template in a page:
 
To use the template in a page:
 
*You type in ''edit'':
 
*You type in ''edit'':
  {{SYF|2005|R|Morris, Max}}
+
  {{YFS|2005|R|Morris, Max}}
 
  '''Max Morris''' is currently tipped to be the next BRGS [[headmaster]].
 
  '''Max Morris''' is currently tipped to be the next BRGS [[headmaster]].
  
Line 45: Line 53:
  
 
==Further Development==
 
==Further Development==
Currently, some forms have their own pages which will still need to be transferred manually. Command names are subject to change based on feedback, so don't start using these on a site wide scale yet.
+
Currently, some forms have their own pages which will still need to be transferred manually. If new wiki software is ever written then this system will become part of the editing interface so that commands aren't needed.

Latest revision as of 16:50, 24 November 2010

Introduction

These commands automatically add category information which puts you in the right year group and form and is automatically (by admins) updated every year. This remains the easiest way of keeping everyone up-to-date. You can also safely refer to forms and current years using the below commands.

  • Add the following command to a student's page for them to be put into the correct form and year group categories:
{{YFS|YEAR|FORM|NAME}}
{{YFS|2005|R|Morris, Max}}

Search for examples to get a quick overview (e.g. David Bewicke) of how to set up your own pages correctly.

Motivation

Year Upping is a regular problem on the wiki. Most student pages want to refer to their year or form, but this information changes every year, so our gnomes and helpers have to go and edit every page to keep everyone up to date at the beginning of September. This is the problem the year upping project hopes to resolve - preferably in a simple, user-friendly way.

Creating and Updating Year Templates

  • Your intake year may not have been added yet, if this is the case then you'll need to either wait for them to come online or add them yourself before using the commands (Template:Intake YYYY and Template:Year YYYY, following the output specification below and using Template:Year 2005 as an example).

Each year we update Intake YYYY with the year number and update Year YYYY and Intake YYYY for the leaving year. Therefore assuming we were up to date last year there should be 9 template changes required per year. One for each year 7-13 and two updated to leavers who become 'intake of 20xx' instead of Year x.

Commands

{{Year 2005}}

Output, for example, Year 7 or Lower Sixth.

To use the template in a page:

  • You type in edit:
'''Max Morris''' is currently tipped to be the next BRGS [[headmaster]] and is currently in {{Year 2005}}.
  • Appearance:
Max Morris is currently tipped to be the next BRGS headmaster and is currently in Year 12.

The template will output one of the following, where relevant:

  • Year 7-11
  • Lower Sixth
  • Upper Sixth
  • the intake of YYYY (e.g. YYYY=2001)

{{Form|2005|S}}

Outputs the form of the person, e.g. 8R, 13CRV. The parameters being the intake year and the form lettering.

To use the template in a page:

  • You type in edit:
'''Max Morris''' is currently tipped to be the next BRGS [[headmaster]] and is currently in the form {{Form|2005|R}}.
  • Appearance:
Max Morris is currently tipped to be the next BRGS headmaster and is currently in the form 12R.

{{YFS|Year|Form Letter|Surname, Forename}}

YFS is the acronym for Year, Form and Student (name). Adding this to a page automatically adds the person onto the necessary category lists, which are kept up-to-date every year. (You can also use SYF).

To use the template in a page:

  • You type in edit:
{{YFS|2005|R|Morris, Max}}
'''Max Morris''' is currently tipped to be the next BRGS [[headmaster]].

{{Intake 2005}}

This just outputs the year number or YY/, e.g. 99/, 05/, if it's outside the range 7-13. This is used in the other templates behind-the-scenes.

Further Development

Currently, some forms have their own pages which will still need to be transferred manually. If new wiki software is ever written then this system will become part of the editing interface so that commands aren't needed.