The eclecticse.omer Reference Manual

Table of Contents

The eclecticse.omer Reference Manual

This is the eclecticse.omer Reference Manual, version 1.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 18:49:05 2020 GMT+0.

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.

2.1 eclecticse.omer

Author

David Trudgett <eclecticse@gmail.com>

License

GPL V3

Description

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

Version

1.0.1

Dependency

local-time

Source

eclecticse.omer.asd (file)

Components

• omer-package.lisp (file)
• omer.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 eclecticse.omer.asd

Location

eclecticse.omer.asd

Systems

eclecticse.omer (system)

3.1.2 eclecticse.omer/omer-package.lisp

Parent

eclecticse.omer (system)

Location

omer-package.lisp

Packages

eclecticse.omer

3.1.3 eclecticse.omer/omer.lisp

Dependency

omer-package.lisp (file)

Parent

eclecticse.omer (system)

Location

omer.lisp

Exported Definitions

• *pesach* (special variable)
• omer (function)
• omer-for (function)

Internal Definitions

• *week-days* (special variable)
• a (function)
• date-diff (function)
• date-portion (function)
• day-count-to (function)
• day-of-week (function)
• es (function)
• extract-day (function)
• extract-month (function)
• extract-year (function)
• four-digit-str (function)
• h (function)
• human-date (function)
• increment-date (function)
• iso-8601-date-now (function)
• iso-8601-date-time-now (function)
• iso-8601-time-now (function)
• make-iso-8601-date (function)
• num-day-of-week (function)
• o (function)
• sabbath-count (function)
• sabbath-p (function)
• shavuot (function)
• tee (function)
• today (function)
• two-digit-str (function)
• u (function)
• vee (function)

4 Packages

Packages are listed by definition order.

4.1 eclecticse.omer

Source

omer-package.lisp (file)

Nickname

omer

Use List

common-lisp

Exported Definitions

• *pesach* (special variable)
• omer (function)
• omer-for (function)

Internal Definitions

• *week-days* (special variable)
• a (function)
• date-diff (function)
• date-portion (function)
• day-count-to (function)
• day-of-week (function)
• es (function)
• extract-day (function)
• extract-month (function)
• extract-year (function)
• four-digit-str (function)
• h (function)
• human-date (function)
• increment-date (function)
• iso-8601-date-now (function)
• iso-8601-date-time-now (function)
• iso-8601-time-now (function)
• make-iso-8601-date (function)
• num-day-of-week (function)
• o (function)
• sabbath-count (function)
• sabbath-p (function)
• shavuot (function)
• tee (function)
• today (function)
• two-digit-str (function)
• u (function)
• vee (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *pesach*

Package

eclecticse.omer

Source

omer.lisp (file)

5.1.2 Functions

Function: omer ()

Package

eclecticse.omer

Source

omer.lisp (file)

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 (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *week-days*

Package

eclecticse.omer

Source

omer.lisp (file)

5.2.2 Functions

Function: a LINE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: date-diff DATE-1 DATE-2

Package

eclecticse.omer

Source

omer.lisp (file)

Function: date-portion ISO-8601-DATE-TIME

Package

eclecticse.omer

Source

omer.lisp (file)

Function: day-count-to DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: day-of-week DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: es LINE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: extract-day ISO-8601-DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: extract-month ISO-8601-DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: extract-year ISO-8601-DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: four-digit-str INT

Package

eclecticse.omer

Source

omer.lisp (file)

Function: h LINE

Package

eclecticse.omer

Source

omer.lisp (file)

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 (file)

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 (file)

Function: iso-8601-date-now &key HYPHEN

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

Package

eclecticse.omer

Source

omer.lisp (file)

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 (file)

Function: iso-8601-time-now &key COLON

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

Package

eclecticse.omer

Source

omer.lisp (file)

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 (file)

Function: num-day-of-week DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: o LINE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: sabbath-count DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: sabbath-p DATE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: shavuot ()

Package

eclecticse.omer

Source

omer.lisp (file)

Function: tee LINE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: today ()

Package

eclecticse.omer

Source

omer.lisp (file)

Function: two-digit-str INT

Package

eclecticse.omer

Source

omer.lisp (file)

Function: u LINE

Package

eclecticse.omer

Source

omer.lisp (file)

Function: vee LINE

Package

eclecticse.omer

Source

omer.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types