The eclecticse.omer Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The eclecticse.omer Reference Manual

This is the eclecticse.omer Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:29:50 2022 GMT+0.

Table of Contents


1 Introduction

Omer Count

A small Common Lisp script to aid in the counting of the days and weeks from Pesach to Shavuot.

A discussion of the purpose and requirements of this script can be found at this blog article, but here is the essential summary.

What is an omer count and what is the purpose of this script?

There are two biblical feasts called Pesach and Shavuot, where the latter is fifty days after the former. There is a biblical commandment to count the days, the weeks and the weekly Sabbaths which occur between 16 Aviv (the day after Pesach) and the day of Shavuot, fifty days later.

The Bible gives a few instructions on the counting requirements:

  1. The counting is to begin (from one) on the day after the Pesach Sabbath on 15 Aviv.
  2. The days from one to forty-nine are to be counted, and then the fiftieth day is to be celebrated as the day of Shavuot.
  3. The celebration of the fiftieth day is to begin at sunset of the previous day.
  4. The seven weekly Sabbath days along the way are also to be separately counted.
  5. Each of the seven weeks is to be counted.

We take it that to do this counting, the intention is that it be done each day until the eve of Shavuot arrives; and therein lies the problem which this program is meant to solve: a single person performing this count manually each day may possibly be error prone. It's handy to have a convenient confirmation that one has not skipped or doubled up on a day.

Usage

(ql:quickload :eclecticse.omer)
(use-package :eclecticse.omer)
(let ((omer:*pesach* "2019-03-23"))
  (omer)
  (omer-for "2019-05-12"))

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 eclecticse.omer

A script to assist in counting the time period between Pesach and Shavuot.

Author

David Trudgett <eclecticse@gmail.com>

License

GPL V3

Version

1.0.1

Dependency

local-time (system).

Source

eclecticse.omer.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


3.1.1 eclecticse.omer/eclecticse.omer.asd

Source

eclecticse.omer.asd.

Parent Component

eclecticse.omer (system).

ASDF Systems

eclecticse.omer.


3.1.2 eclecticse.omer/omer-package.lisp

Source

eclecticse.omer.asd.

Parent Component

eclecticse.omer (system).

Packages

eclecticse.omer.


3.1.3 eclecticse.omer/omer.lisp

Dependency

omer-package.lisp (file).

Source

eclecticse.omer.asd.

Parent Component

eclecticse.omer (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 eclecticse.omer

Source

omer-package.lisp.

Nickname

omer

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Special variables

Special Variable: *pesach*
Package

eclecticse.omer.

Source

omer.lisp.


5.1.2 Ordinary functions

Function: omer ()
Package

eclecticse.omer.

Source

omer.lisp.

Function: omer-for (date)

Print out the omer count output for the give DATE, which is provided in ISO 8601 YYYY-MM-DD format.

Package

eclecticse.omer.

Source

omer.lisp.


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *week-days*
Package

eclecticse.omer.

Source

omer.lisp.


Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary functions

Function: a (line)
Package

eclecticse.omer.

Source

omer.lisp.

Function: date-diff (date-1 date-2)
Package

eclecticse.omer.

Source

omer.lisp.

Function: date-portion (iso-8601-date-time)
Package

eclecticse.omer.

Source

omer.lisp.

Function: day-count-to (date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: day-of-week (date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: es (line)
Package

eclecticse.omer.

Source

omer.lisp.

Function: extract-day (iso-8601-date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: extract-month (iso-8601-date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: extract-year (iso-8601-date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: four-digit-str (int)
Package

eclecticse.omer.

Source

omer.lisp.

Function: h (line)
Package

eclecticse.omer.

Source

omer.lisp.

Function: human-date (date-string)

Strip the T from ISO8601 dates, and remove decimal portion of seconds, if any.

Package

eclecticse.omer.

Source

omer.lisp.

Function: increment-date (date)

Increment DATE by one day. DATE must be in YYYY-MM-DD format. If there is a time portion, it will be ignored.

Package

eclecticse.omer.

Source

omer.lisp.

Function: iso-8601-date-now (&key hyphen)

Return a string representing the current date in ISO 8601 format.

Package

eclecticse.omer.

Source

omer.lisp.

Function: iso-8601-date-time-now (&key t-sep hyphen colon)

Return a string representing the current date and time in ISO 8601 format.

Package

eclecticse.omer.

Source

omer.lisp.

Function: iso-8601-time-now (&key colon)

Return a string representing the current time in ISO 8601 format.

Package

eclecticse.omer.

Source

omer.lisp.

Function: make-iso-8601-date (year month day &key hyphen)

Given numerical values for the year, month and day, return a string representing the date in ISO 8601 format.

Package

eclecticse.omer.

Source

omer.lisp.

Function: num-day-of-week (date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: o (line)
Package

eclecticse.omer.

Source

omer.lisp.

Function: sabbath-count (date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: sabbath-p (date)
Package

eclecticse.omer.

Source

omer.lisp.

Function: shavuot ()
Package

eclecticse.omer.

Source

omer.lisp.

Function: tee (line)
Package

eclecticse.omer.

Source

omer.lisp.

Function: today ()
Package

eclecticse.omer.

Source

omer.lisp.

Function: two-digit-str (int)
Package

eclecticse.omer.

Source

omer.lisp.

Function: u (line)
Package

eclecticse.omer.

Source

omer.lisp.

Function: vee (line)
Package

eclecticse.omer.

Source

omer.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   E   F   H   I   M   N   O   S   T   U   V  
Index Entry  Section

A
a: Private ordinary functions

D
date-diff: Private ordinary functions
date-portion: Private ordinary functions
day-count-to: Private ordinary functions
day-of-week: Private ordinary functions

E
es: Private ordinary functions
extract-day: Private ordinary functions
extract-month: Private ordinary functions
extract-year: Private ordinary functions

F
four-digit-str: Private ordinary functions
Function, a: Private ordinary functions
Function, date-diff: Private ordinary functions
Function, date-portion: Private ordinary functions
Function, day-count-to: Private ordinary functions
Function, day-of-week: Private ordinary functions
Function, es: Private ordinary functions
Function, extract-day: Private ordinary functions
Function, extract-month: Private ordinary functions
Function, extract-year: Private ordinary functions
Function, four-digit-str: Private ordinary functions
Function, h: Private ordinary functions
Function, human-date: Private ordinary functions
Function, increment-date: Private ordinary functions
Function, iso-8601-date-now: Private ordinary functions
Function, iso-8601-date-time-now: Private ordinary functions
Function, iso-8601-time-now: Private ordinary functions
Function, make-iso-8601-date: Private ordinary functions
Function, num-day-of-week: Private ordinary functions
Function, o: Private ordinary functions
Function, omer: Public ordinary functions
Function, omer-for: Public ordinary functions
Function, sabbath-count: Private ordinary functions
Function, sabbath-p: Private ordinary functions
Function, shavuot: Private ordinary functions
Function, tee: Private ordinary functions
Function, today: Private ordinary functions
Function, two-digit-str: Private ordinary functions
Function, u: Private ordinary functions
Function, vee: Private ordinary functions

H
h: Private ordinary functions
human-date: Private ordinary functions

I
increment-date: Private ordinary functions
iso-8601-date-now: Private ordinary functions
iso-8601-date-time-now: Private ordinary functions
iso-8601-time-now: Private ordinary functions

M
make-iso-8601-date: Private ordinary functions

N
num-day-of-week: Private ordinary functions

O
o: Private ordinary functions
omer: Public ordinary functions
omer-for: Public ordinary functions

S
sabbath-count: Private ordinary functions
sabbath-p: Private ordinary functions
shavuot: Private ordinary functions

T
tee: Private ordinary functions
today: Private ordinary functions
two-digit-str: Private ordinary functions

U
u: Private ordinary functions

V
vee: Private ordinary functions

Jump to:   A   D   E   F   H   I   M   N   O   S   T   U   V