The eclecticse.omer Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 12:20:41 2018 GMT+0.


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

1 Introduction

Omer Count

A small 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* "2018-04-02"))
  (omer)
  (omer-for "2018-05-12"))

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

2 Systems

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


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

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

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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 eclecticse.omer.asd

Location

eclecticse.omer.asd

Systems

eclecticse.omer (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 eclecticse.omer/omer-package.lisp

Parent

eclecticse.omer (system)

Location

omer-package.lisp

Packages

eclecticse.omer


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 eclecticse.omer/omer.lisp

Dependency

omer-package.lisp (file)

Parent

eclecticse.omer (system)

Location

omer.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 eclecticse.omer

Source

omer-package.lisp (file)

Nickname

omer

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *pesach*
Package

eclecticse.omer

Source

omer.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *week-days*
Package

eclecticse.omer

Source

omer.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   E   F   L  
Index Entry  Section

E
eclecticse.omer.asd: The eclecticse<dot>omer<dot>asd file
eclecticse.omer/omer-package.lisp: The eclecticse<dot>omer/omer-package<dot>lisp file
eclecticse.omer/omer.lisp: The eclecticse<dot>omer/omer<dot>lisp file

F
File, Lisp, eclecticse.omer.asd: The eclecticse<dot>omer<dot>asd file
File, Lisp, eclecticse.omer/omer-package.lisp: The eclecticse<dot>omer/omer-package<dot>lisp file
File, Lisp, eclecticse.omer/omer.lisp: The eclecticse<dot>omer/omer<dot>lisp file

L
Lisp File, eclecticse.omer.asd: The eclecticse<dot>omer<dot>asd file
Lisp File, eclecticse.omer/omer-package.lisp: The eclecticse<dot>omer/omer-package<dot>lisp file
Lisp File, eclecticse.omer/omer.lisp: The eclecticse<dot>omer/omer<dot>lisp file

Jump to:   E   F   L  

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: Internal functions

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

E
es: Internal functions
extract-day: Internal functions
extract-month: Internal functions
extract-year: Internal functions

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

H
h: Internal functions
human-date: Internal functions

I
increment-date: Internal functions
iso-8601-date-now: Internal functions
iso-8601-date-time-now: Internal functions
iso-8601-time-now: Internal functions

M
make-iso-8601-date: Internal functions

N
num-day-of-week: Internal functions

O
o: Internal functions
omer: Exported functions
omer-for: Exported functions

S
sabbath-count: Internal functions
sabbath-p: Internal functions
shavuot: Internal functions

T
tee: Internal functions
today: Internal functions
two-digit-str: Internal functions

U
u: Internal functions

V
vee: Internal functions

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

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*pesach*: Exported special variables
*week-days*: Internal special variables

S
Special Variable, *pesach*: Exported special variables
Special Variable, *week-days*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   E   P   S  
Index Entry  Section

E
eclecticse.omer: The eclecticse<dot>omer system
eclecticse.omer: The eclecticse<dot>omer package

P
Package, eclecticse.omer: The eclecticse<dot>omer package

S
System, eclecticse.omer: The eclecticse<dot>omer system

Jump to:   E   P   S