Module:WCI2016.PEG/doc

From Meta, a Wikimedia project coordination wiki

This is the documentation page for Module:WCI2016.PEG

Note: This instance is meant particularly for a single grant request. Any modification here will also cause a change in the appearance of the actual grant application page. Therefore, if someone wants to make use of these scripts for another grant application, please take a copy of this and use that one. Please do not modify any part of this within this module itself, as it will disrupt the original grant documents it is intended to generate.  

WCI2016.PEG[edit]

This is a module containing all lua templates for creating expense and budget sheets for various Wikimedia outreach and conference events. This particular instance is created for WCI2016 (WikiConference India - 2016)project. Please contact Viswaprabha for suggestions and modifications. Thanks! (As on 2016/02/25) ViswaPrabhaവിശ്വപ്രഭtalk 01:27, 25 February 2016 (UTC)

Description[edit]

This module contains a set of routines to create an event expense form easily. The aim is to generate a set of preformatted wikitables, each one with its own header lines, item rows and footer lines. The preparations, entry and calculation of data (to be filled within the numerical and text cells as inputs) can be done in an off-line or collaborated spreadsheet program, enabling fast and easy calculations. The data thus evolved can then be directly copy/pasted to the meta page (for grant requests, reports etc.) or any other mediawiki page of interest as the desired final output. Any numerical modification, correction or updates can thus be immediately incorporated into the target grant request (or report) page without having to go through rather cumbersome wiki-table edits.


List of functions[edit]

Part 1[edit]

  • function p.QEHeader(frame) -- Adds a section Header with Section Number and SectionName for the 'Quantity Estimate' form.
  • function p.QEItem(frame) --Adds an item row to the 'Quantity Estimate' form
  • function p.QEFooter(frame) -- Adds a section Footer to the 'Quantity Estimate' form
  • function p.QELegend(frame) -- Adds a legend line to the 'Quantity Estimate' form.

Part 2[edit]

  • function p.ESHeader(frame) -- Adds a section Header with Section Number and Section Name to the 'Expenses Summary' form.
  • function p.ESItem(frame) --Adds a n itemrow to the 'Expenses Summary' form.
  • function p.ESFooter(frame) -- Adds a section Footer to the 'Expenses Summary' form.
[Please note that the 'Total Sum' on this line must be added manually. This is to avoid the code being overly complicated].

Part 3[edit]

  • function p.EDHeader(frame) -- Adds a section Header with Section Number and SectionName to the 'Expenses in Detail' form.
  • function p.EDItem(frame) --Adds a n itemrow to the 'Expenses in Detail' form.
  • function p.EDFooter(frame) -- Adds a section Footer to the 'Expenses in Detail' form.
[Please note that the 'Total Sum' on this line must be added manually. This is to avoid the code being overly complicated].

(Invoke each function to generate an appropriate line as required in the wikified report format. (For eg:)


Sources of revenue
Code No. Item INR US$ %age Notes