Wikipedia

Module:Women in Red event/doc

< Module:Women in Red event

Module:Women in Red event 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

and elsewhere.

Usage

edit

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|293|series}} gives "#1day1woman"

A third optional parameter, allows you to specify a default value if none is defined. For example:

  • {{#invoke:Women in Red event|main|291|type|edit-a-thon}} gives "edit-a-thon" because there is no type value defined for 291.

A |hash=no option allows you to remove the # character from the output (this is sometimes useful because this character can upset the formatting of a page and it is not possible to have this character in a page name). For example:

  • {{#invoke:Women in Red event|main|293|series|hash=no}} gives "1day1woman"

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:

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"

Both of these options may be used simultaneously, but the output is slightly awkward, e.g. "from Oct to Dec 2021"

findLatest function

edit

{{#invoke:Women in Red event|findLatest|add}}

Shows the latest event number to be defined (currently 325), ignoring the quasi event numbers "2017" and "2018". For example

  • {{#invoke:Women in Red event|findLatest}} gives "325"

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 "326"
  • {{#invoke:Women in Red event|findLatest|add=-5}} gives "320"

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

MeetupNameDate
52Women in peaceAug 2017
53Canadian womenAug 2017
54Hispanic & Latina womenSep 2017
55Olympic womenSep 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

MeetupNameDate
323Women in engineering Nov 2024
324Women who died: 2024Dec 2024 – Jan 2025
325ReligionDec 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.

If any other columns are required, please ask one of the module's maintainers.

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:

MeetupNameDateTemplate
316Women writers & their worksSep 2024{{WIR|316}}
317Geofocus: Islands A–HSep 2024{{WIR|317}}
318Women in STEMOct 2024{{WIR|318}}
319Geofocus: Islands I–POct 2024{{WIR|319}}
320Women in archaeologyOct 2024{{WIR|320}}
321Asian womenNov 2024{{WIR|321}}
322Geofocus: Islands Q–ZNov 2024{{WIR|322}}
323Women in engineering Nov 2024{{WIR|323}}
324Women who died: 2024Dec 2024 – Jan 2025{{WIR|324}}
325ReligionDec 2024{{WIR|325}}

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:

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 the month 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: Asian women Geofocus: Islands Q–Z Women in engineering
December 2024: Women who died: 2024 Religion
Ongoing initiatives: #1day1woman Education
Upcoming events: Ideas
  • {{#invoke:Women in Red event|current_events|year=2023|month=2|ongoing=Still happening|upcoming=Coming up}} produces:
Recently completed: Women who died: 2022 Alphabet run: M & N Geofocus: East Asia
February 2023: Alphabet run: O & P Black women Justice Folklore
Still happening: Peace and Diplomacy #1day1woman
Coming up: Geofocus: Mediterranean Art + Activism Alphabet run: Q & R Ideas

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.

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


Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:Women_in_Red_event/doc&oldid=1244544373"