Module:Staff list/doc

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

This is the documentation page for Module:Staff list

This module is used for creating a staff listing which allows all or parts of the staff to be displayed in a variety of formats. The contents are stored in a template's staff parameter in a JSON format, including data on all individual departments and employees within the list.

Individual departments (or teams, or subteams, or other similar groups which would be marked in some way) are stored as JSON objects with the following parameters:

  • "name": stores the name of the group. The value should be wrapped in translate tags so that it can be displayed in the appropriate language.
  • "id": stores a stable identifier for the group, so that the template can request data on it.
  • "notTeam": should be marked as true if the group is not a team which should be distinctly listed in lists of teams in, for example, the navbox of all departments and teams.
  • "head": should point to the employee who is the head of the group.
  • "page": should be the title of the page on Meta-wiki (or other Wikimedia wiki, with the appropriate interwiki prefix) which gives information about the group.
  • "members": stores an array of all employees which are directly within the group. (Employees that are part of a subsidiary team within the group should not be listed in the members array.)
  • "subs": stores an array of all groups that are within the group. These groups should be formatted in the same way as the higher-level departments.

Individual employees are stored as objects with the following parameters:

  • "name": stores the name of the employee.
  • "username": stores the on-wiki username of the employee, omitting the "User:" namespace prefix.
  • "homewiki":, for employees whose home wiki must be specified as not being on Meta-wiki, stores the interwiki prefix of the employee's home wiki. (Example: "mw" for mediawiki.org.)
  • "title": stores a the name of the employee's position
  • "titleId": stores a stable identifier for the position, so that the template can request data on the holder of the position.
  • "isContractor": should be marked true if the employee is a contractor.
  • "isMascot": should be marked true if the "employee" is actually just a mascot which should not be counted in employee counts.
  • "image": stores the name of an image on Commons of the employee, omitting the "File:" namespace prefix.

All of these parameters are optional except for name. Further information on template usage can be found on Template:WMF Staff/doc.