The westbrook Reference Manual

Table of Contents

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

The westbrook Reference Manual

This is the westbrook Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:44:40 2018 GMT+0.


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

1 Introduction

westbrook

This project is for generating RSS feeds.

It is used by creating a westbrook:feed object, adding westbrook:item objects to the feed, then using westbrook:generate or westbrook:generate-to to write the XML feed to a string or file.

I use it to generate feeds for Quicklisp build failure reports.

Example

(let ((feed (make-instance 'feed
                           :title "My Great Feed"
                           :link "https://www.xach.com/"
                           :description "My feed.")))
  (add-feed-item feed
                 :title "An item"
                 :description "Here is <a href='https://github.com/xach/vecto/'>vecto</a>!"
                 :link "https://www.xach.com/lisp/"
                 :guid "my-great-feed-item-1"
                 :guid-permalink-p nil)
  (generate-to "rss.xml" feed))

Feedback

Development of westbrook takes place on github. If you find a bug, please report via github issues. You can also email me at xach@xach.com.

Enjoy!


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 westbrook

Author

Zach Beane <xach@xach.com>

License

BSD

Description

An RSS feed generator.

Dependency

cxml

Source

westbrook.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 westbrook.asd

Location

westbrook.asd

Systems

westbrook (system)


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

3.1.2 westbrook/package.lisp

Parent

westbrook (system)

Location

package.lisp

Packages

westbrook


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

3.1.3 westbrook/pubdate.lisp

Dependency

package.lisp (file)

Parent

westbrook (system)

Location

pubdate.lisp

Internal Definitions

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

3.1.4 westbrook/feed.lisp

Dependency

pubdate.lisp (file)

Parent

westbrook (system)

Location

feed.lisp

Exported Definitions
Internal Definitions

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

3.1.5 westbrook/generate-xml.lisp

Dependency

feed.lisp (file)

Parent

westbrook (system)

Location

generate-xml.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 westbrook

Source

package.lisp (file)

Use List
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 Functions

Function: generate-to FILE OBJECT
Package

westbrook

Source

generate-xml.lisp (file)


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

5.1.2 Generic functions

Generic Function: add-feed-item FEED &rest INITARGS &key &allow-other-keys
Package

westbrook

Source

feed.lisp (file)

Methods
Method: add-feed-item FEED &rest INITARGS &key &allow-other-keys
Generic Function: generate OBJECT
Package

westbrook

Source

generate-xml.lisp (file)

Methods
Method: generate (ITEM item)
Method: generate FEED
Method: generate (FEED feed) around
Generic Function: items OBJECT
Generic Function: (setf items) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: items (FEED feed)

automatically generated reader method

Source

feed.lisp (file)

Method: (setf items) NEW-VALUE (FEED feed)

automatically generated writer method

Source

feed.lisp (file)

Generic Function: make-feed-item FEED &rest INITARGS &key &allow-other-keys
Package

westbrook

Source

feed.lisp (file)

Methods
Method: make-feed-item FEED &rest INITARGS &key &allow-other-keys

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

5.1.3 Classes

Class: feed ()
Package

westbrook

Source

feed.lisp (file)

Direct superclasses

checked-slots-mixin (class)

Direct methods
Direct slots
Slot: title

Required. A short description/title for the feed.

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: link

Required. A link to the RSS feed itself.

Initargs

:link

Readers

link (generic function)

Writers

(setf link) (generic function)

Slot: description

Required. A long-ish description of the feed.

Initargs

:description

Readers

description (generic function)

Writers

(setf description) (generic function)

Slot: pub-date
Initargs

:pub-date

Initform

(get-universal-time)

Readers

pub-date (generic function)

Writers

(setf pub-date) (generic function)

Slot: last-build-date
Initargs

:last-build-date

Initform

(get-universal-time)

Readers

last-build-date (generic function)

Writers

(setf last-build-date) (generic function)

Slot: items
Initargs

:items

Initform

(quote nil)

Readers

items (generic function)

Writers

(setf items) (generic function)

Slot: item-class

When using ADD-FEED-ITEM or MAKE-FEED-ITEM, new items are created as instances of this class.

Initargs

:item-class

Initform

(quote westbrook:item)

Readers

item-class (generic function)

Writers

(setf item-class) (generic function)

Direct Default Initargs
InitargValue
:checked-slots(quote (westbrook::title westbrook::link))
Class: item ()
Package

westbrook

Source

feed.lisp (file)

Direct superclasses

checked-slots-mixin (class)

Direct methods
Direct slots
Slot: title

Required. A string title.

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: link

Required. A string link to view this item.

Initargs

:link

Readers

link (generic function)

Writers

(setf link) (generic function)

Slot: description
Initargs

:description

Initform

""

Readers

description (generic function)

Writers

(setf description) (generic function)

Slot: pub-date

A universal-time representing the publication date of the item. Defaults to the current time.

Initargs

:pub-date

Initform

(get-universal-time)

Readers

pub-date (generic function)

Writers

(setf pub-date) (generic function)

Slot: guid

Required. A string representing a unique (global)
id of this item. If guid-permalink-p is true for the item, the guid should be a unique link to the item.

Initargs

:guid

Readers

guid (generic function)

Writers

(setf guid) (generic function)

Slot: guid-permalink-p
Initargs

:guid-permalink-p

Readers

guid-permalink-p (generic function)

Writers

(setf guid-permalink-p) (generic function)

Direct Default Initargs
InitargValue
:checked-slots(quote (westbrook::link westbrook::title westbrook::guid))

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *generator-string*
Package

westbrook

Source

feed.lisp (file)

Special Variable: *short-month-names*
Package

westbrook

Source

pubdate.lisp (file)

Special Variable: *short-weekday-names*
Package

westbrook

Source

pubdate.lisp (file)


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

5.2.2 Functions

Function: check-required-slots OBJECT SLOTS
Package

westbrook

Source

feed.lisp (file)

Function: element NAME VALUE
Package

westbrook

Source

generate-xml.lisp (file)

Function: elements &rest NAMES-AND-VALUES
Package

westbrook

Source

generate-xml.lisp (file)

Function: iso8601-date-string UNIVERSAL-TIME
Package

westbrook

Source

pubdate.lisp (file)

Function: pubdate-string UNIVERSAL-TIME
Package

westbrook

Source

pubdate.lisp (file)


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

5.2.3 Generic functions

Generic Function: checked-slots OBJECT
Package

westbrook

Methods
Method: checked-slots (CHECKED-SLOTS-MIXIN checked-slots-mixin)

automatically generated reader method

Source

feed.lisp (file)

Generic Function: description OBJECT
Generic Function: (setf description) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: description (ITEM item)

automatically generated reader method

Source

feed.lisp (file)

Method: (setf description) NEW-VALUE (ITEM item)

automatically generated writer method

Source

feed.lisp (file)

Method: description (FEED feed)
Method: (setf description) NEW-VALUE (FEED feed)

Required. A long-ish description of the feed.

Source

feed.lisp (file)

Generic Function: guid OBJECT
Generic Function: (setf guid) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: guid (ITEM item)
Method: (setf guid) NEW-VALUE (ITEM item)

Required. A string representing a unique (global)
id of this item. If guid-permalink-p is true for the item, the guid should be a unique link to the item.

Source

feed.lisp (file)

Generic Function: guid-permalink-p OBJECT
Generic Function: (setf guid-permalink-p) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: guid-permalink-p (ITEM item)

automatically generated reader method

Source

feed.lisp (file)

Method: (setf guid-permalink-p) NEW-VALUE (ITEM item)

automatically generated writer method

Source

feed.lisp (file)

Generic Function: item-class OBJECT
Generic Function: (setf item-class) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: item-class (FEED feed)
Method: (setf item-class) NEW-VALUE (FEED feed)

When using ADD-FEED-ITEM or MAKE-FEED-ITEM, new items are created as instances of this class.

Source

feed.lisp (file)

Generic Function: last-build-date OBJECT
Generic Function: (setf last-build-date) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: last-build-date (FEED feed)

automatically generated reader method

Source

feed.lisp (file)

Method: (setf last-build-date) NEW-VALUE (FEED feed)

automatically generated writer method

Source

feed.lisp (file)

Generic Function: link OBJECT
Generic Function: (setf link) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: link (ITEM item)
Method: (setf link) NEW-VALUE (ITEM item)

Required. A string link to view this item.

Source

feed.lisp (file)

Method: link (FEED feed)
Method: (setf link) NEW-VALUE (FEED feed)

Required. A link to the RSS feed itself.

Source

feed.lisp (file)

Generic Function: pub-date OBJECT
Generic Function: (setf pub-date) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: pub-date (ITEM item)
Method: (setf pub-date) NEW-VALUE (ITEM item)

A universal-time representing the publication date of the item. Defaults to the current time.

Source

feed.lisp (file)

Method: pub-date (FEED feed)

automatically generated reader method

Source

feed.lisp (file)

Method: (setf pub-date) NEW-VALUE (FEED feed)

automatically generated writer method

Source

feed.lisp (file)

Generic Function: title OBJECT
Generic Function: (setf title) NEW-VALUE OBJECT
Package

westbrook

Methods
Method: title (ITEM item)
Method: (setf title) NEW-VALUE (ITEM item)

Required. A string title.

Source

feed.lisp (file)

Method: title (FEED feed)
Method: (setf title) NEW-VALUE (FEED feed)

Required. A short description/title for the feed.

Source

feed.lisp (file)


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

5.2.4 Classes

Class: checked-slots-mixin ()
Package

westbrook

Source

feed.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: checked-slots
Initargs

:checked-slots

Readers

checked-slots (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   W  
Index Entry  Section

F
File, Lisp, westbrook.asd: The westbrook<dot>asd file
File, Lisp, westbrook/feed.lisp: The westbrook/feed<dot>lisp file
File, Lisp, westbrook/generate-xml.lisp: The westbrook/generate-xml<dot>lisp file
File, Lisp, westbrook/package.lisp: The westbrook/package<dot>lisp file
File, Lisp, westbrook/pubdate.lisp: The westbrook/pubdate<dot>lisp file

L
Lisp File, westbrook.asd: The westbrook<dot>asd file
Lisp File, westbrook/feed.lisp: The westbrook/feed<dot>lisp file
Lisp File, westbrook/generate-xml.lisp: The westbrook/generate-xml<dot>lisp file
Lisp File, westbrook/package.lisp: The westbrook/package<dot>lisp file
Lisp File, westbrook/pubdate.lisp: The westbrook/pubdate<dot>lisp file

W
westbrook.asd: The westbrook<dot>asd file
westbrook/feed.lisp: The westbrook/feed<dot>lisp file
westbrook/generate-xml.lisp: The westbrook/generate-xml<dot>lisp file
westbrook/package.lisp: The westbrook/package<dot>lisp file
westbrook/pubdate.lisp: The westbrook/pubdate<dot>lisp file

Jump to:   F   L   W  

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

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   I   L   M   P   T  
Index Entry  Section

(
(setf description): Internal generic functions
(setf description): Internal generic functions
(setf description): Internal generic functions
(setf guid): Internal generic functions
(setf guid): Internal generic functions
(setf guid-permalink-p): Internal generic functions
(setf guid-permalink-p): Internal generic functions
(setf item-class): Internal generic functions
(setf item-class): Internal generic functions
(setf items): Exported generic functions
(setf items): Exported generic functions
(setf last-build-date): Internal generic functions
(setf last-build-date): Internal generic functions
(setf link): Internal generic functions
(setf link): Internal generic functions
(setf link): Internal generic functions
(setf pub-date): Internal generic functions
(setf pub-date): Internal generic functions
(setf pub-date): Internal generic functions
(setf title): Internal generic functions
(setf title): Internal generic functions
(setf title): Internal generic functions

A
add-feed-item: Exported generic functions
add-feed-item: Exported generic functions

C
check-required-slots: Internal functions
checked-slots: Internal generic functions
checked-slots: Internal generic functions

D
description: Internal generic functions
description: Internal generic functions
description: Internal generic functions

E
element: Internal functions
elements: Internal functions

F
Function, check-required-slots: Internal functions
Function, element: Internal functions
Function, elements: Internal functions
Function, generate-to: Exported functions
Function, iso8601-date-string: Internal functions
Function, pubdate-string: Internal functions

G
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate-to: Exported functions
Generic Function, (setf description): Internal generic functions
Generic Function, (setf guid): Internal generic functions
Generic Function, (setf guid-permalink-p): Internal generic functions
Generic Function, (setf item-class): Internal generic functions
Generic Function, (setf items): Exported generic functions
Generic Function, (setf last-build-date): Internal generic functions
Generic Function, (setf link): Internal generic functions
Generic Function, (setf pub-date): Internal generic functions
Generic Function, (setf title): Internal generic functions
Generic Function, add-feed-item: Exported generic functions
Generic Function, checked-slots: Internal generic functions
Generic Function, description: Internal generic functions
Generic Function, generate: Exported generic functions
Generic Function, guid: Internal generic functions
Generic Function, guid-permalink-p: Internal generic functions
Generic Function, item-class: Internal generic functions
Generic Function, items: Exported generic functions
Generic Function, last-build-date: Internal generic functions
Generic Function, link: Internal generic functions
Generic Function, make-feed-item: Exported generic functions
Generic Function, pub-date: Internal generic functions
Generic Function, title: Internal generic functions
guid: Internal generic functions
guid: Internal generic functions
guid-permalink-p: Internal generic functions
guid-permalink-p: Internal generic functions

I
iso8601-date-string: Internal functions
item-class: Internal generic functions
item-class: Internal generic functions
items: Exported generic functions
items: Exported generic functions

L
last-build-date: Internal generic functions
last-build-date: Internal generic functions
link: Internal generic functions
link: Internal generic functions
link: Internal generic functions

M
make-feed-item: Exported generic functions
make-feed-item: Exported generic functions
Method, (setf description): Internal generic functions
Method, (setf description): Internal generic functions
Method, (setf guid): Internal generic functions
Method, (setf guid-permalink-p): Internal generic functions
Method, (setf item-class): Internal generic functions
Method, (setf items): Exported generic functions
Method, (setf last-build-date): Internal generic functions
Method, (setf link): Internal generic functions
Method, (setf link): Internal generic functions
Method, (setf pub-date): Internal generic functions
Method, (setf pub-date): Internal generic functions
Method, (setf title): Internal generic functions
Method, (setf title): Internal generic functions
Method, add-feed-item: Exported generic functions
Method, checked-slots: Internal generic functions
Method, description: Internal generic functions
Method, description: Internal generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, guid: Internal generic functions
Method, guid-permalink-p: Internal generic functions
Method, item-class: Internal generic functions
Method, items: Exported generic functions
Method, last-build-date: Internal generic functions
Method, link: Internal generic functions
Method, link: Internal generic functions
Method, make-feed-item: Exported generic functions
Method, pub-date: Internal generic functions
Method, pub-date: Internal generic functions
Method, title: Internal generic functions
Method, title: Internal generic functions

P
pub-date: Internal generic functions
pub-date: Internal generic functions
pub-date: Internal generic functions
pubdate-string: Internal functions

T
title: Internal generic functions
title: Internal generic functions
title: Internal generic functions

Jump to:   (  
A   C   D   E   F   G   I   L   M   P   T  

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

A.3 Variables

Jump to:   *  
C   D   G   I   L   P   S   T  
Index Entry  Section

*
*generator-string*: Internal special variables
*short-month-names*: Internal special variables
*short-weekday-names*: Internal special variables

C
checked-slots: Internal classes

D
description: Exported classes
description: Exported classes

G
guid: Exported classes
guid-permalink-p: Exported classes

I
item-class: Exported classes
items: Exported classes

L
last-build-date: Exported classes
link: Exported classes
link: Exported classes

P
pub-date: Exported classes
pub-date: Exported classes

S
Slot, checked-slots: Internal classes
Slot, description: Exported classes
Slot, description: Exported classes
Slot, guid: Exported classes
Slot, guid-permalink-p: Exported classes
Slot, item-class: Exported classes
Slot, items: Exported classes
Slot, last-build-date: Exported classes
Slot, link: Exported classes
Slot, link: Exported classes
Slot, pub-date: Exported classes
Slot, pub-date: Exported classes
Slot, title: Exported classes
Slot, title: Exported classes
Special Variable, *generator-string*: Internal special variables
Special Variable, *short-month-names*: Internal special variables
Special Variable, *short-weekday-names*: Internal special variables

T
title: Exported classes
title: Exported classes

Jump to:   *  
C   D   G   I   L   P   S   T  

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

A.4 Data types

Jump to:   C   F   I   P   S   W  
Index Entry  Section

C
checked-slots-mixin: Internal classes
Class, checked-slots-mixin: Internal classes
Class, feed: Exported classes
Class, item: Exported classes

F
feed: Exported classes

I
item: Exported classes

P
Package, westbrook: The westbrook package

S
System, westbrook: The westbrook system

W
westbrook: The westbrook system
westbrook: The westbrook package

Jump to:   C   F   I   P   S   W