rambam

Documentation

Overview

Hebcal's rambam package calculates the Daily Rambam (Mishneh Torah) learning schedule in both the 1-chapter-a-day and 3-chapters-a-day cycles instituted by the Lubavitcher Rebbe in 1984.

https://en.wikipedia.org/wiki/Daily_Rambam_Study

Index

• Variables
• func NewDailyRambam1Event(hd hdate.HDate, reading Reading) event.CalEvent
• func NewDailyRambam3Event(hd hdate.HDate, readings []Reading) event.CalEvent
• type Reading
  • func New1(hd hdate.HDate) (Reading, bool)
  • func New3(hd hdate.HDate) ([]Reading, bool)
  • func (r Reading) String() string

Variables

var Rambam1Start = greg.ToRD(1984, time.April, 29)

Rambam1Start is the R.D. number of the start of the Daily Rambam cycle, Sunday 27 Nisan 5744 (29 April 1984). Both cycles share this start date.

Functions

func NewDailyRambam1Event

func NewDailyRambam1Event(hd hdate.HDate, reading Reading) event.CalEvent

NewDailyRambam1Event returns a calendar event for the 1-chapter-a-day Daily Rambam reading on the given date.

func NewDailyRambam3Event

func NewDailyRambam3Event(hd hdate.HDate, readings []Reading) event.CalEvent

NewDailyRambam3Event returns a calendar event for the 3-chapters-a-day Daily Rambam reading on the given date. Adjacent chapters in the same section are collapsed into a single range for display.

Types

type Reading

type Reading struct {
	// Name is the English transliteration of the section (Halacha), e.g.
	// "Foundations of the Torah", "Sabbath", "Kings and Wars".
	Name string
	// Perek is the chapter (perek) reference: usually a number, but may be
	// a range like "4-5" when chapters are combined, or a mitzvot range
	// like "1-21" / "1:1-4:8" for the introductory sections.
	Perek string
}

Reading is one section/chapter of the Mishneh Torah as scheduled by the Daily Rambam cycle.

func New1

func New1(hd hdate.HDate) (Reading, bool)

New1 calculates the Daily Rambam reading for the 1-chapter-a-day cycle.

The second return value is false when the date is before the cycle began (29 April 1984).

func New3

func New3(hd hdate.HDate) ([]Reading, bool)

New3 calculates the Daily Rambam readings for the 3-chapters-a-day cycle, returning the three chapters studied that day in order.

The second return value is false when the date is before the cycle began (29 April 1984).

func (Reading) String

func (r Reading) String() string

String returns the untranslated description, e.g. "Kings and Wars 4".