Module:Activities Reports/Affiliate Information/doc

This module will keep track of Activities Reports addition affiliate data submitted by Wikimedia Affiliates in relations to the Reports page here: WADP on Meta-Wiki.

Usage

Each entry looks like this:

	{
		unique_id = 'q86jm02q9io',
		group_name = 'Learning & Evaluation User Group',
		primary_contact1 = 'User:ABC',
		primary_contact2 = 'User:XYZ',
		editors = '10',
		non_editors = '3',
		event_participants = '5',
		event_supporters = '1',
		event_leaders = '2',
		past_programs = {'A', 'B', 'C', 'D'},
		capacities_to_strengthen = {'X', 'Y', 'Z'}
		created_at = '2019-07-02T18:21:59.837Z',
	},

Syntax

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.
• events_hosted is a special key that takes as value and array and this in Lua is done with curly braces {} and it's comma separated to distinct the values from one another.
• Indenting is not strictly necessary but it does look nice.

Parameters

• unique_id is used to distinguish each entry even when the other values change. It does not need to follow a specific pattern but it does need to be unique.
• group_name is the name used by the affiliate (User Group, Chapter etc). This should in most cases be a recognized affiliate listed in the Wikimedia Movement Affiliates page on Meta-Wiki.
• primary_contact1 is the main group contact of the affiliate.
• primary_contact2 is the secondary group contact of the affiliate.
• editors are the number of members in the affiliate that are Wikimedia editors - meaning they edits Wikimedia wikis.
• non_editors is the member count that doesn't edit Wikimedia projects.
• event_participants are people who take part in events hosted by the affiliate.
• event_supporters are people who support the events hosted by the affiliates like partners or individual supports but doesn't necessarily participate on the event day.
• event_leaders are members who are in charge of leading the event.
• past_programs are the events that have been hosted by the affiliate.
• capacities_to_strengthen are the capacities that the group needs to strengthen over a period of time in the future.
• created_at stands for date of submission stamp and this is the timestamp that this entry/report was submitted.

Translation

The strings of text presented on the Activities Report form are stored in Template:i18n/Reports 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/Reports by hand, (however, if you see that Template:i18n/Reports needs to be marked for translation, you are welcome to do so!)