Jump to content

Template:Probox/Research/doc

From Meta, a Wikimedia project coordination wiki

An infobox for research projects. See Meta:Probox and Template:Probox for examples. The underlying code lives at Module:Probox and Module:Probox/Research

Template parameters

ParameterDescriptionTypeStatus
Project statusstatus

The status of the projects. Options include planned, proposed, active, and completed. Each option adds a corresponding category.

Default
proposed
Example
planned, proposed, active, completed
Auto value
Stringrequired
Project titleproject

The title of the project. Usually matches the page title.

Example
Commons upload wizard evaluation May 2015
Stringrequired
Summarysummary

A 1-2 sentence summary of the project. Please do not include wikitext, hyperlinks, or other markup.

Example
Evaluating the usability of the Commons Image Upload process.
Stringrequired
Start monthstart_month

The month when the project started

Example
May
Stringsuggested
Start yearstart_year

The year the project started.

Example
2015
Numbersuggested
End monthend_month

The month the project ended, or is expected to end.

Example
June
Stringsuggested
End yearend_year

The year the project ended, or is expected to end.

Example
2016
Numbersuggested
Imageimage

An icon image (or avatar) for this project, which will be displayed in the infobox.

Default
File:Wikimedia-research.png
Example
File:Wikimedia-research.png
Auto value
Filesuggested
Primary investigatorprimary_investigator primary_investigator1 primary_investigator2

The username of the project leader. You DON'T need to add 'User:' at the beginning.

Example
Ijon
Userrequired
Contact emailcontact contact1 contact2 contact3

The email address of the primary investigator and/or the primary contact for the project.

Example
yourname@gmail.com
Stringsuggested
Collaborator(s)collaborator collaborator1 collaborator2 collaborator3 collaborator4 collaborator5 collaborator6 collaborator7 collaborator8 collaborator9

The username of collaborators on the project. You can add up to nine collaborators by adding collaborator2=, collaborator3=, etc. parameters to the template.

Example
Jtmorgan
Usersuggested
Organizationorganization organization1 organization2 organization3

The name of the organization(s) that the researcher(s) are affiliated with.

Example
University of Melbourne
Stringoptional
Wikimedia contactwmf_coordinator wmf_coordinator1 wmf_coordinator2

The username of a WMF staff member who is involved with and/or consulting on this project.

Example
Jmorgan (WMF)
Stringoptional
Created ontimestamp

The date and time that the project page was created

Auto value
Daterequired
Open accessopen_access

URL to an open access repository (or a wikipage) where the results of this project are published

Example
https://digital.lib.washington.edu/researchworks/handle/1773/25074
Stringoptional
Open dataopen_data

The URL to an open data repository where this project's data are published open access

Example
http://figshare.com/articles/Wikimedia_Mobile_View/1254628
Stringoptional
Open sourceopen_source

URL to a repository where code from this project is published open access

Example
https://github.com/halfak/mwmetrics
Stringoptional
Portalportal

Which type of Probox this is. See Meta:Probox for options.

Default
Research
Example
Research
Auto value
Research
Stringrequired
Translationstranslations

Path to the translatable page where the template's interface text is stored. Assumes the template namespace.

Default
Probox/Research/Content
Example
Probox/Research/Content
Auto value
Probox/Research/Content
Page namerequired
Creatorcreator

The person who created the project, if different from the Primary Investigator or Collaborators

Useroptional