Jump to content

Module:Wikimedia Resource Center/Groups/doc

From Meta, a Wikimedia project coordination wiki

This is the documentation page for Module:Wikimedia Resource Center/Groups

This page stores data related to Connect/Groups page on Meta in a Lua table. It acts as a database for group information. Data is gotten via a form which is processed by the MediaWiki:Gadget-wrcAddNewGroup.js gadget.

Usage

[edit]

A typical entry looks like this (for example):

	{
		type = 'group',
                name = 'Learning and Evaluation',
		description = 'Program coordinators seeking to understand what makes our programs work',
		icon = 'Noun project 1063.svg',
                Facebook = 'https://www.facebook.com/groups/programevaluation',
                Twitter = 'https://twitter.com/WikiEval',
                YouTube = 'https://www.youtube.com/user/WikiEvaluation',

	},

Syntax

[edit]

First, a note on the general syntax: editing these entries is comparable to editing templates on Wikipedia such as infoboxes, but with a few key differences:

  • Each "block" is wrapped in curly brackets, with a comma following each entry, as you can see above.
  • To add a new entry, add a block like above below the last entry, but before the final } on the bottom of the module that closes off the whole thing.
  • Each value after the equals sign has to be surrounded in single quote marks. Here we use single-quotes instead of double quotes. If, however, you want to use an apostrophe, you will need to escape it with a backslash. For example: Wikimedia\'s mission is to make knowledge available to everyone.
  • Indenting is not strictly necessary but it recommended to do some basic indentation.

Parameters

[edit]

For each individual parameter:

  • The type is used to identify the type of data to be saved. In this case, the type should be by default group as it's keep track of groups created data in the Lua table.
  • The name takes is the name of the group that is created e.g. Learning and Evaluation.
  • The description is a brief information about the group that is being created. Group mission, activities etc.
  • Icon holds the name of a picture on commons without the "File:" prefix. The template that renders this will build the full link. If no picture is provided, there is a fall back icon.
  • Facebook holds a link to the Group's Facebook page.
  • Twitter holds a link to the Group's Twitter page.
  • Also, YouTube holds a link to the Group's YouTube channel. Facebook, Twitter and YouTube are all links to the groups social media space.

Translation

[edit]

The strings of text presented on the Wikimedia Resource Center are stored in Template:i18n/Wikimedia Resource Center and can be translated through the Translate interface.

Note that this module stores English versions. To update English text, you should update this module directly.

Even if you are editing this module by hand, there is no need to update Template:i18n/Wikimedia Resource Center by hand, since the "Content" section of that page is refreshed every time someone edits using the editor gadget. (However, if you see that Template:i18n/Wikimedia Resource Center needs to be marked for translation, you are welcome to do so!)