The eclecticse.iso-8601-date Reference Manual

Table of Contents

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

The eclecticse.iso-8601-date Reference Manual

This is the eclecticse.iso-8601-date Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 14:19:11 2019 GMT+0.


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

1 Introduction

EclecticSE ISO 8601 Date Representation Routines

David K. Trudgett

Miscellaneous date routines based around the ISO 8601 string representation.

Function List

License

LLGPL


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.iso-8601-date

Author

David K. Trudgett

License

LLGPL

Description

Miscellaneous date routines based around ISO-8601 representation.

Version

1.0.0

Dependency

local-time

Source

eclecticse.iso-8601-date.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.iso-8601-date.asd

Location

eclecticse.iso-8601-date.asd

Systems

eclecticse.iso-8601-date (system)


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

3.1.2 eclecticse.iso-8601-date/package.lisp

Parent

eclecticse.iso-8601-date (system)

Location

package.lisp

Packages

eclecticse.iso-8601-date


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

3.1.3 eclecticse.iso-8601-date/iso-8601-date.lisp

Dependency

package.lisp (file)

Parent

eclecticse.iso-8601-date (system)

Location

iso-8601-date.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.iso-8601-date

Source

package.lisp (file)

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


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

5.1.1 Functions

Function: d/m/y->iso-8601-date DMY-DATE-STRING &key HYPHEN

Convert a d/m/y date string into ISO 8601 string format. Returns NIL for invalid dates. Does not check leap years for the number of days in February.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: date-add DATE DAYS

Add DAYS number of days to DATE.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: date-diff DATE-1 DATE-2

Return the number of days between DATE-1 and DATE-2.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

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

Return the date portion of an ISO 8601 date/time string. Assumes that the date string contains hyphen separators, and is therefore exactly ten characters long.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: extract-day ISO-8601-DATE

Return the integer day of the month represented by the ISO-8601-DATE.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: extract-month ISO-8601-DATE

Return the integer month represented by the ISO-8601-DATE.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: extract-year ISO-8601-DATE

Return the integer year represented by the ISO-8601-DATE.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: human-date DATE-STRING

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

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

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

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

Package

eclecticse.iso-8601-date

Source

iso-8601-date.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.iso-8601-date

Source

iso-8601-date.lisp (file)

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

Return a string representing the current time in ISO 8601 HH:mm:ss format.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: last-month ()

Return ISO 8601 year/month string for the month previous to the current month. Example: if current month is May 2020, return "2020-04".

Package

eclecticse.iso-8601-date

Source

iso-8601-date.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.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: num-day-of-week DATE

Return the numerical day of the week for DATE.
1 for Sunday, 2 or Monday, etc., up to 7 for Saturday.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.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.iso-8601-date

Source

iso-8601-date.lisp (file)


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

5.2.2 Functions

Function: day-of-week DATE

Return the English day of the week name for the given DATE.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: four-digit-str INT

Convert an integer in the range 0 to 9999 into a four-character string with leading zeroes, if necessary.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.lisp (file)

Function: two-digit-str INT

Convert an integer in the range 0 to 99 into a two-character string with leading 0, if necessary.

Package

eclecticse.iso-8601-date

Source

iso-8601-date.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.iso-8601-date.asd: The eclecticse<dot>iso-8601-date<dot>asd file
eclecticse.iso-8601-date/iso-8601-date.lisp: The eclecticse<dot>iso-8601-date/iso-8601-date<dot>lisp file
eclecticse.iso-8601-date/package.lisp: The eclecticse<dot>iso-8601-date/package<dot>lisp file

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

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

Jump to:   E   F   L  

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

A.2 Functions

Jump to:   D   E   F   H   I   L   M   N   T  
Index Entry  Section

D
d/m/y->iso-8601-date: Exported functions
date-add: Exported functions
date-diff: Exported functions
date-portion: Exported functions
day-of-week: Internal functions

E
extract-day: Exported functions
extract-month: Exported functions
extract-year: Exported functions

F
four-digit-str: Internal functions
Function, d/m/y->iso-8601-date: Exported functions
Function, date-add: Exported functions
Function, date-diff: Exported functions
Function, date-portion: Exported functions
Function, day-of-week: Internal functions
Function, extract-day: Exported functions
Function, extract-month: Exported functions
Function, extract-year: Exported functions
Function, four-digit-str: Internal functions
Function, human-date: Exported functions
Function, iso-8601-date-now: Exported functions
Function, iso-8601-date-time-now: Exported functions
Function, iso-8601-time-now: Exported functions
Function, last-month: Exported functions
Function, make-iso-8601-date: Exported functions
Function, num-day-of-week: Exported functions
Function, two-digit-str: Internal functions

H
human-date: Exported functions

I
iso-8601-date-now: Exported functions
iso-8601-date-time-now: Exported functions
iso-8601-time-now: Exported functions

L
last-month: Exported functions

M
make-iso-8601-date: Exported functions

N
num-day-of-week: Exported functions

T
two-digit-str: Internal functions

Jump to:   D   E   F   H   I   L   M   N   T  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*week-days*: Internal special variables

S
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.iso-8601-date: The eclecticse<dot>iso-8601-date system
eclecticse.iso-8601-date: The eclecticse<dot>iso-8601-date package

P
Package, eclecticse.iso-8601-date: The eclecticse<dot>iso-8601-date package

S
System, eclecticse.iso-8601-date: The eclecticse<dot>iso-8601-date system

Jump to:   E   P   S