Jump to content

Module:Organizational Informations/doc

From Meta, a Wikimedia project coordination wiki

This is the documentation page for Module:Organizational Informations

This page will keep track of Organizational Information submitted by Wikimedia Affiliates in relations to the Reports page here: WADP on Meta-Wiki.

Usage

[edit]

Each entry looks like this:

	{
		unique_id = '3bdai20i5ah',
		affiliate_code = 'ABC',
		group_name = 'Example X',
		org_type = 'User Group',
		region = 'Example Region',
		group_country = 'Country',
		legal_entity = 'No',
		mission_changed = 'No',
		group_page = 'foo.wikimedia.org/wiki/ExampleX',
		member_count = '9',
		facebook = 'web.facebook.org/ExampleX',
		twitter = 'twitter.org/ExampleX',
		other = 'foo.wikimedia.org/wiki/ExampleX',
		dm_structure = {'Board', 'Democratic Process'},
		group_contact1 = 'User:Example1',
		group_contact2 = 'User:Example2',
		board_contacts = '',
		agreement_date = 'DD/MM/YYYY',
		fiscal_year_start = '01/01',
		fiscal_year_end = '31/12',
		me_bypass_ooc_autochecks = 'No',
		out_of_compliance_level = '1',
		reporting_due_date = '2021-11-05T23:00:00.000Z',
		uptodate_reporting = 'Tick',
		recognition_status = 'derecognised',
		derecognition_date = '30/05/2010',
		derecognition_note = 'Derecognised by AffCom',
		dos_stamp = '2018/06/26',
	},

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.
  • dm_structure 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

[edit]
  • 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.
  • org_type is the type of organization for example; User Group, Thematic Organization, Chapter etc.
  • region is the geographical location of the affiliate based on the 7 continents that exist.
  • group_country is the country that is affiliate was recognized in. Basically, where the application process happened and where the group contacts are.
  • mission_changed depicts if the organizations mission statement has changed over the years. And if so, then it's going to be explained below (after selected the option "yes" or no explanation if the same).
  • explanation only carries the explanation of the changes to the organizations mission statement.
  • group_page is the presence of the organization on Wiki and this is usually on Meta-Wiki.
  • member_count number of members in the organization. This should be a number.
  • facebook link to the Facebook presence of the organization.
  • twitter link to the Twitter presence of the organization.
  • other link to any other presence of the organization which is different from Facebook or Twitter (maybe mailing list, blog or news page).
  • dm_structure is the decision making structure of the organization. It can be selected from the check list.
  • group_contact1 is the primary contact of the affiliate/group.
  • group_contact2 is the secondary contact of the affiliate/group.
  • board_contacts is a list of users that are board members of the organization.
  • agreement_date is the resolution date from the Affiliations Committee to the group and it should be in the format "DD/MM/YYYY".
  • fiscal_year_start is the start of the fiscal year of the affiliate in DD/MM format.
  • fiscal_year_end is the end of the fiscal year of the affiliate in DD/MM format.
  • me_bypass_ooc_autochecks depicts if M&E staff should by pass special actions on the affiliate or not.
  • out_of_compliance_level shows the level of OOC that the affiliate is at based on system checks and M&E actions.
  • reporting_due_date is the date that the affiliate should have reported on their activities. This is useful when computing the out of compliance status.
  • uptodate_reporting is the field the M&E staff will use to conclude if an affiliate is in compliance or not with a 'Tick' or a 'Cross' string respectively (for the mean time). In addition, special cases for new affiliates (such as User Groups), M&E staff shall input 'Tick-N' or 'Cross-N' for field.
  • notes_on_reporting is additional notes from the Monitoring and Evaluation Staff about the compliance status of the affiliate. TODO: Will be automated into the forms.
  • recognition_status is the status of the affiliate. It's either recognised or derecognised.
  • derecognition_date is the date that the affiliate looses recognition.
  • derecognition_note is the note left upon the affiliate loosing its recognition. Loosing of recognition can be done either via AffCom or overdue reporting.
  • dos_stamps stands for date of submission stamp and this is the date that this entry/report was submitted.

Translation

[edit]

The strings of text presented on the Organizational Information 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!)