ਮੌਡਿਊਲ:PotM/data/doc

This is the data which fills {{PotM}} and the PotM part of {{Collaboration}}.

Add works to the table that is returned by this module.

• Note: Editors changing this page should be doing so based on discussions at Wikisource Talk:Proofread of the Month.

This data is intended for use by Module:PotM, but in theory other modules can use it too.

Adding months

You can add months like this:

	{
		year = 2021,
		month = 4,
		theme = "Poetry and Drama",
		works = {
             ...
		}
	},

As long as month and year are in the future, it won't be shown until that month arrives. This allows you to pre-load months and works for auto-changeover at the end of a month.

Optional month parameters:

• overflow: set to true if this is an "overflow" month to show the list of small works. Otherwise the module will set the "extra" ("The current Proofread of the Month has been completed early") state when the second work in a month is reached.
• current: the current work within a month. If not given, the first work in the month will be used. This is so additional works can be pre-loaded into a month and enabled later by just adding or changing current.

Adding works

You can add works with the following template:

			{
				index = "Index link.djvu",
				display = "Display name",
				author = "Firstname Lastname",
				year = XXXX,
			},

Optional work parameters:

• image a filename to use for the image. If not given, the "proofreading star" is used
• imagesize the size of the image, if there is one. If not given, 75px.

There is no author override field. The author author field is normally unlinked and a link to the author page will be constructed as usual. If the author field contains wikilinks, it will be presented as-is.