API documentation: dates in the civil calendar

Published

May 2, 2024

weekrange

Find the seven-day range beginning with Sunday that a given date falls in.

Examples

julia> Lectionary.weekrange()
Date("2024-04-21"):Day(1):Date("2024-04-27")
julia> Lectionary.weekrange(Date(2024,4,23))
Date("2024-04-21"):Day(1):Date("2024-04-27")

weekrange()
weekrange(dt)

calendar_week

Compose a 7-element vector ordered from Sunday to Saturday and including the given date, with a value of either a liturgical day or nothing for each day in the week.

Examples

julia> calendar_week()
7-element Vector{Union{Nothing, LiturgicalDay}}:
 the fourth Sunday of Easter, April 21, 2024
 nothing
 nothing
 nothing
 Saint Mark the Evangelist, April 25, 2024
 nothing
 nothing
julia> calendar_week(Date(2024,4,24))
7-element Vector{Union{Nothing, LiturgicalDay}}:
 the fourth Sunday of Easter, April 21, 2024
 nothing
 nothing
 nothing
 Saint Mark the Evangelist, April 25, 2024
 nothing
 nothing

calendar_week()
calendar_week(dt)

Compose a 7-element vector ordered from Sunday to Saturday and including the given liturgical day, with a value of either a liturgical day or nothing for each day in the week.

julia> calendar_week(Commemoration(Lectionary.FEAST_SAINT_MARK, 2024))
7-element Vector{Union{Nothing, LiturgicalDay}}:
 the fourth Sunday of Easter, April 21, 2024
 nothing
 nothing
 nothing
 Saint Mark the Evangelist, April 25, 2024
 nothing
 nothing

calendar_week(lday)

calendar_month

Compose a vector of 4 or 5 week vectors for a calendar month, with values of either a liturgical day or nothing for each day in each week.

Examples

julia> calendar_month()
5-element Vector{Vector{Union{Nothing, LiturgicalDay}}}:
 [Easter Day, March 31, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
 [the second Sunday of Easter, April 7, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
 [the third Sunday of Easter, April 14, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
 [the fourth Sunday of Easter, April 21, 2024, nothing, nothing, nothing, Saint Mark the Evangelist, April 25, 2024, nothing, nothing]
 [the fifth Sunday of Easter, April 28, 2024, nothing, nothing, Saint Philip and Saint James, Apostles, May 1, 2024, nothing, nothing, nothing]
 julia> calendar_month(Date(2024,4,2))
 5-element Vector{Vector{Union{Nothing, LiturgicalDay}}}:
  [Easter Day, March 31, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
  [the second Sunday of Easter, April 7, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
  [the third Sunday of Easter, April 14, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
  [the fourth Sunday of Easter, April 21, 2024, nothing, nothing, nothing, Saint Mark the Evangelist, April 25, 2024, nothing, nothing]
  [the fifth Sunday of Easter, April 28, 2024, nothing, nothing, Saint Philip and Saint James, Apostles, May 1, 2024, nothing, nothing, nothing]

calendar_month()
calendar_month(dt)

Compose a vector of 4 or 5 week vectors for a calendar month, with values of either a liturgical day or nothing for each day in each week.

Example

julia> calendar_month(eastertide(2,2024))
5-element Vector{Vector{Union{Nothing, LiturgicalDay}}}:
 [Easter Day, March 31, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
 [the second Sunday of Easter, April 7, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
 [the third Sunday of Easter, April 14, 2024, nothing, nothing, nothing, nothing, nothing, nothing]
 [the fourth Sunday of Easter, April 21, 2024, nothing, nothing, nothing, Saint Mark the Evangelist, April 25, 2024, nothing, nothing]
 [the fifth Sunday of Easter, April 28, 2024, nothing, nothing, Saint Philip and Saint James, Apostles, May 1, 2024, nothing, nothing, nothing]

calendar_month(lday)

calendar_year

Construct a calendar of months …

calendar_year()
calendar_year(dt)

Construct a calendar of months in the civil year for a given liturgical year.

calendar_year(lday)