Module:Financial Reports/doc

This is the documentation page for Module:Financial Reports

It is NOT recommended to edit this module directly. Please visit the WAD Portal and submit financial reports via the OOUI forms (by clicking on "Submit financial report" button). If you make a mistake in your report submission, do not edit this Lua module to correct it, just resubmit a new report with the correct data.

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

Usage[edit]

Each entry looks like this:

	{
		unique_id = '9fo3d368oz',
		group_name = 'Learning & Evaluation User Group',
                report_type = 'Annual Financial Report',
		total_budget = '4000',
                total_expense = '3000',
		currency = 'USD',
		report_link = 'https://meta.wikimedia.org/wiki/Report_2019',
                start_date = '01/01/2000,
                end_date = '01/01/2001',
		dos_stamp = '2019-06-30T09:23:49.670Z',
	},

or

	{
		unique_id = '9fo3d368oz',
		group_name = 'Learning & Evaluation User Group',
                report_type = 'Multiyear Financial Report',
                multiyear_duration = '5yrs report',
		total_budget = '4000',
                total_expense = '3000',
		currency = 'USD',
		report_link = 'https://meta.wikimedia.org/wiki/Report_2019',
                start_date = '01/01/2000,
                end_date = '01/01/2001',
		dos_stamp = '2019-06-30T09:23:49.670Z',
	},

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 does look nice.

Parameters[edit]

For each individual parameter:

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.
report_type, this describes the type of Financial report the affiliate in concern is submitting. For example; Annual Financial Report, etc.
total_budget is the total budget of an affiliate (for example a Chapter) that is been reported at the end of a quarter or a fiscal year.
total_expense is the total expenses made for the financial report submitted.
currency is the currency used by the affiliate in reporting. Mostly, it's the currently used in the affiliates country.
report_link is usually the link to where the report has been written on the Wikis (mostly). So a link to the report will enable this report to be read by the movement and other affiliates (for learning purposes etc). So this is where the submitted report resides.
start_date is the start date of the reporting.
end_date is the end date of the reporting.
dos_stamp 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 Financial 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!)