GBBopen 1.5 Reference -- very-brief-date

very-brief-date

very-brief-date &optional universal-time &key time-zone month-precedes-date year-first include-year separator destination => result [Function]

Purpose
Generate a very brief date description.

Package :gbbopen-tools

Module :gbbopen-tools

Arguments and values

universal-time		A Universal Time (default is `nil`, which is equivalent to the value returned by `(get-universal-time)`)
time-zone		A time zone (default is `nil`, which is equivalent to the current time zone adjusted for daylight saving time)
month-precedes-date		A generalized boolean (default is *month-precedes-date*)
year-first		A generalized boolean (default is *year-first*)
include-year		A generalized boolean (default is `t`)
separator		A character (default is `#\/`)
destination		Either `nil`, `t`, a stream, or a string with a fill pointer (default is `nil`)
result		A string or `nil`

Returns
If destination is non-nil, then nil; otherwise, a string.

Description
If universal-time is not supplied or is nil, the current time (as returned by get-universal-time is used.

If time-zone is not supplied or is nil, it defaults to the current time zone adjusted for daylight saving time. If time-zone is supplied, it is assumed to include any adjustment for daylight saving time.

If month-precedes-date is true, the month is presented in front of the date; otherwise the date precedes the month.

If year-first is supplied and is non-nil, the year is presented in front of the month and date; otherwise the year follows the month and date.

If include-year is supplied and is non-nil, the year is included in the presented time.

Examples
Display the current date (with and without the year):

  > (very-brief-date)
  "2/16/2008"
  > (very-brief-date (get-universal-time) :include-year nil)
  "2/16"
  >

The GBBopen Project

very-brief-date