Module:Women in Red event/doc
This is a documentation subpage for Module:Women in Red event. It may contain usage information, categories and other content that is not part of the original module page. |
This Lua module is used on approximately 55,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
Usage
[edit]This module has various functons that use the list of WikiProject Women in Red events stored at Wikipedia:WikiProject Women in Red/events. These are used in
- Template:WikiProject Women in Red,
- Template:WIR meetup header,
- Template:WIR category
- Template:Women in Red navigation
and elsewhere.
main function
[edit]{{#invoke:Women in Red event|main|event|field}}
Given an event number, reads one of the fields (event, year, month, type, image, series). For example:
{{#invoke:Women in Red event|main|294|name}}
gives "Education"{{#invoke:Women in Red event|main|7|year}}
gives "2016"{{#invoke:Women in Red event|main|236|series}}
gives "Alphabet run"
name function
[edit]{{#invoke:Women in Red event|name|event}}
Given an event number, returns the name or the series of the event. If the both the name and the series are defined, then it will prepend the series with a colon. For example:
{{#invoke:Women in Red event|name|294}}
gives "Education"{{#invoke:Women in Red event|name|7}}
gives "Black women: History"{{#invoke:Women in Red event|name|236}}
gives "Alphabet run: C & D"
text function
[edit]{{#invoke:Women in Red event|text|event}}
Produces a piped link to the event page followed by the date, for use in the project banner. For example:
{{#invoke:Women in Red event|text|291}}
gives "Women who died: 2023 edit-a-thon from December 2023 to January 2024"
date function
[edit]{{#invoke:Women in Red event|date|event|sentence|abbrev}}
Produces a formatted date (including month and year) of the event. For example:
{{#invoke:Women in Red event|date|210}}
gives "October–December 2021"
This function takes two optional parameters:
|sentence=
- if set to "yes" then the date will be expressed as a sentence using the words "from" and "to", e.g. "from October to December 2021"|abbrev=
- if set to "yes" then the names of the months will be abbreviated, e.g. "Oct–Dec 2021"
findLatest function
[edit]{{#invoke:Women in Red event|findLatest|add}}
Shows the latest event number to be defined (currently 315), ignoring the quasi event numbers "2017" and "2018". For example
{{#invoke:Women in Red event|findLatest}}
gives "315"
An optional parameter |add=
can be used to add or subtract numbers to the latest. For example
{{#invoke:Women in Red event|findLatest|add=1}}
gives "316"
list function
[edit]{{#invoke:Women in Red event|list|first|last|latest|meetup|logo|series|name|date|template|wrapper|category}}
Produce a table of events, for various purposes. The following parameters are recognised.
|first=
,|last=
- specify the first and/or last event to show in the list.
For example {{#invoke:Women in Red event|list|first=52|last=55}}
produces
Meetup | Name | Date |
---|---|---|
52 | Women in peace | Aug 2017 |
53 | Canadian women | Aug 2017 |
54 | Hispanic & Latina women | Sep 2017 |
55 | Olympic women | Sep 2017 |
|latest=
- to show a specified number of the latest events. In this case|first=
and|last=
will be ignored.
For example, {{#invoke:Women in Red event|list|latest=3}}
produces
Meetup | Name | Date |
---|---|---|
313 | Women in Sports | Jul–Aug 2024 |
314 | Indigenous women | Aug 2024 |
315 | Film and stage | Aug 2024 |
Columns
[edit]The columns of the table can be customised by setting various parameters to yes
or no
.
|meetup=
- shows or hides a column with the meetup number. By default this column is shown. If a background colour is defined then it will be used in this cell.|logo=
- enables a column to show the logo associated with each event.|series=
- enables a column to show the series (if applicable) of each event.|name=
- enables a column to show the name of each event, and a link to the meetup page. This will be shown by default.|date=
- shows or hides a column which displays the date of each event. Shown by default.|template=
- column to show the syntax for the template using the shortcut {{WIR}}|wrapper=
(deprecated) - column to show the wrapper template for each event. These are no longer in general use.|category=
- enables a column which links to the category for articles created by each event, along with the population of that category.
Examples
[edit]The table currently shown on Wikipedia talk:WikiProject Women in Red/events is produced by the syntax {{#invoke:Women in Red event|list|logo=yes|series=yes|wrapper=yes|category=yes}}
.
The table currently shown on Template:WikiProject Women in Red/doc is produced by the syntax {{#invoke:Women in Red event|list|latest=10|template=yes}}
which produces the following:
Meetup | Name | Date | Template |
---|---|---|---|
306 | Alphabet run: U–W | May 2024 | {{WIR|306}} |
307 | Geofocus: Central and Eastern Europe | May 2024 | {{WIR|307}} |
308 | LGBTQ+ women | Wiki Loves Pride | Jun 2024 | {{WIR|308}} |
309 | Women in Music | Jun 2024 | {{WIR|309}} |
310 | Alphabet run: X–Z | Jun 2024 | {{WIR|310}} |
311 | Translation | Jul–Sep 2024 | {{WIR|311}} |
312 | Science Fiction and Fantasy | Jul 2024 | {{WIR|312}} |
313 | Women in Sports | Jul–Aug 2024 | {{WIR|313}} |
314 | Indigenous women | Aug 2024 | {{WIR|314}} |
315 | Film and stage | Aug 2024 | {{WIR|315}} |
event_list_by_year function
[edit]{{#invoke:Women in Red event|event_list_by_year|year}}
Produces a list of all past events in a particular year, for use in Template:Women in Red navigation.
For example, {{#invoke:Women in Red event|event_list_by_year|2023}}
produces:
- INITIATIVES:
- Peace and Diplomacy
- #1day1woman EDIT-A-THONS:
- Folklore
- Women who died: 2023
- Jan:
- Feb:
- Mar:
- Apr:
- May:
- Jun:
- Jul:
- Aug:
- Sep:
- Oct:
- Nov:
- Dec:
current_events function
[edit]{{#invoke:Women in Red event|current_events|year|month}}
Produces a list of current, upcoming, recently completed and ongoing events, for navigational purposes at the top of meetup pages. The display on a certain month and year can be specified by using the parameters:
year
- specify the 4-digit year, e.g.|year=2022
month
- specify the month as a number between 1-12. If the year is specified then this will default to 1, i.e. January.
The labels in front of the boxes can be customised with the following parameters:
recent
current
ongoing
upcoming
Examples
[edit]{{#invoke:Women in Red event|current_events}}
produces:
Recently completed: | |
August 2024: | |
Ongoing initiatives: | |
Upcoming events: |
{{#invoke:Women in Red event|current_events|year=2023|month=2|ongoing=Still happening|upcoming=Coming up}}
produces:
Recently completed: | |
February 2023: | |
Still happening: | |
Coming up: |
events function
[edit]{{#invoke:Women in Red event|events}}
Produces a list of current, upcoming and recently completed events, for use on Wikipedia:WikiProject Women in Red/Events. It has a number of optional parameters:
monthly
- include a section for edit-a-thons in the current month. This parameter defines the heading, e.g.|monthly=Happening now
ongoing
- include a section for ongoing initiatives or contests. This parameter defines the heading, e.g.|ongoing=Ongoing initiatives
upcoming
- include a section for upcoming events. This parameter defines the heading, e.g.|upcoming=Coming up
recent
- include a section for recently completed events (i.e. events in the previous month). This parameter defines the heading, e.g.|recent=Recently completed
past
- include a section for all past events (except recently completed). This parameter defines the heading, e.g.|past=Past events
category_header function
[edit]{{#invoke:Women in Red event|category_header}}
Used by Template:WIR category to produce a header for various categories. Please see that template's documentation.
addDateCategories function
[edit]{{#invoke:Women in Red event|addDateCategories|event}}
Used by Template:WIR meetup header to add appropriate categories to meetup pages. This function takes the event number as the first positional parameter.
- For all events, an annual category such as Category:WikiProject Women in Red in 2024 is added.
- If the event spans no more than one calendar month, then a monthly category such as Category:Wikipedia meetups in August 2024 is added.
- If the event spans more than one calendar month, then an annual category such as Category:Wikipedia meetups in 2024 is added.
Example
[edit]{{#invoke:Women in Red event|addDateCategories|300}}
produces the categories Category:WikiProject Women in Red in 2024 and Category:Wikipedia meetups in March 2024.
pinterest function
[edit]{{#invoke:Women in Red event|pinterest|event}}
Generates a link to Pinterest collection based on the date of the event.
The link is of the form https://www.pinterest.com/wikiwomeninred/MONTH-YEAR-editathons
where MONTH
and YEAR
are replaced with the relevant month and year. For annual events, the month of January is used.
Example
[edit]{{#invoke:Women in Red event|pinterest|305}}
produces May-2024-editathons