The westbrook Reference Manual

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

The westbrook Reference Manual

This is the westbrook Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 06:11:10 2022 GMT+0.

Table of Contents


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!


2 Systems

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


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

2.1 westbrook

An RSS feed generator.

Author

Zach Beane <xach@xach.com>

License

BSD

Dependency

cxml (system).

Source

westbrook.asd.

Child Components

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   [Contents][Index]

3.1.1 westbrook/westbrook.asd

Source

westbrook.asd.

Parent Component

westbrook (system).

ASDF Systems

westbrook.


3.1.2 westbrook/package.lisp

Source

westbrook.asd.

Parent Component

westbrook (system).

Packages

westbrook.


3.1.3 westbrook/pubdate.lisp

Dependency

package.lisp (file).

Source

westbrook.asd.

Parent Component

westbrook (system).

Internals

3.1.4 westbrook/feed.lisp

Dependency

pubdate.lisp (file).

Source

westbrook.asd.

Parent Component

westbrook (system).

Public Interface
Internals

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

3.1.5 westbrook/generate-xml.lisp

Dependency

feed.lisp (file).

Source

westbrook.asd.

Parent Component

westbrook (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 westbrook

Source

package.lisp.

Use List
  • common-lisp.
  • cxml.
Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary functions

Function: generate-to (file object)
Package

westbrook.

Source

generate-xml.lisp.


5.1.2 Generic functions

Generic Function: add-feed-item (feed &rest initargs &key &allow-other-keys)
Package

westbrook.

Source

feed.lisp.

Methods
Method: add-feed-item (feed &rest initargs &key &allow-other-keys)
Generic Function: generate (object)
Package

westbrook.

Source

generate-xml.lisp.

Methods
Method: generate ((item item))
Method: generate (feed)
Method: generate :around ((feed feed))
Generic Reader: items (object)
Package

westbrook.

Methods
Reader Method: items ((feed feed))

automatically generated reader method

Source

feed.lisp.

Target Slot

items.

Generic Writer: (setf items) (object)
Package

westbrook.

Methods
Writer Method: (setf items) ((feed feed))

automatically generated writer method

Source

feed.lisp.

Target Slot

items.

Generic Function: make-feed-item (feed &rest initargs &key &allow-other-keys)
Package

westbrook.

Source

feed.lisp.

Methods
Method: make-feed-item (feed &rest initargs &key &allow-other-keys)

5.1.3 Standalone methods

Method: print-object ((feed feed) stream)
Source

feed.lisp.

Method: print-object ((item item) stream)
Source

feed.lisp.

Method: shared-initialize :after ((object checked-slots-mixin) slot-names &rest initargs &key &allow-other-keys)
Source

feed.lisp.


5.1.4 Classes

Class: feed
Package

westbrook.

Source

feed.lisp.

Direct superclasses

checked-slots-mixin.

Direct methods
Direct Default Initargs
InitargValue
:checked-slots(quote (title link))
Direct slots
Slot: title

Required. A short description/title for the feed.

Initargs

:title

Readers

title.

Writers

(setf title).

Required. A link to the RSS feed itself.

Initargs

:link

Readers

link.

Writers

(setf link).

Slot: description

Required. A long-ish description of the feed.

Initargs

:description

Readers

description.

Writers

(setf description).

Slot: pub-date
Initform

(get-universal-time)

Initargs

:pub-date

Readers

pub-date.

Writers

(setf pub-date).

Slot: last-build-date
Initform

(get-universal-time)

Initargs

:last-build-date

Readers

last-build-date.

Writers

(setf last-build-date).

Slot: items
Initform

(quote nil)

Initargs

:items

Readers

items.

Writers

(setf items).

Slot: item-class

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

Initform

(quote westbrook:item)

Initargs

:item-class

Readers

item-class.

Writers

(setf item-class).

Class: item
Package

westbrook.

Source

feed.lisp.

Direct superclasses

checked-slots-mixin.

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

Required. A string title.

Initargs

:title

Readers

title.

Writers

(setf title).

Required. A string link to view this item.

Initargs

:link

Readers

link.

Writers

(setf link).

Slot: description
Initform

""

Initargs

:description

Readers

description.

Writers

(setf description).

Slot: pub-date

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

Initform

(get-universal-time)

Initargs

:pub-date

Readers

pub-date.

Writers

(setf pub-date).

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.

Writers

(setf guid).

Initargs

:guid-permalink-p

Readers

guid-permalink-p.

Writers

(setf guid-permalink-p).


5.2 Internals


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

5.2.1 Special variables

Special Variable: *generator-string*
Package

westbrook.

Source

feed.lisp.

Special Variable: *short-month-names*
Package

westbrook.

Source

pubdate.lisp.

Special Variable: *short-weekday-names*
Package

westbrook.

Source

pubdate.lisp.


5.2.2 Ordinary functions

Function: check-required-slots (object slots)
Package

westbrook.

Source

feed.lisp.

Function: element (name value)
Package

westbrook.

Source

generate-xml.lisp.

Function: elements (&rest names-and-values)
Package

westbrook.

Source

generate-xml.lisp.

Function: iso8601-date-string (universal-time)
Package

westbrook.

Source

pubdate.lisp.

Function: pubdate-string (universal-time)
Package

westbrook.

Source

pubdate.lisp.


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

5.2.3 Generic functions

Generic Reader: checked-slots (object)
Package

westbrook.

Methods
Reader Method: checked-slots ((checked-slots-mixin checked-slots-mixin))

automatically generated reader method

Source

feed.lisp.

Target Slot

checked-slots.

Generic Reader: description (object)
Package

westbrook.

Methods
Reader Method: description ((item item))

automatically generated reader method

Source

feed.lisp.

Target Slot

description.

Reader Method: description ((feed feed))

Required. A long-ish description of the feed.

Source

feed.lisp.

Target Slot

description.

Generic Writer: (setf description) (object)
Package

westbrook.

Methods
Writer Method: (setf description) ((item item))

automatically generated writer method

Source

feed.lisp.

Target Slot

description.

Writer Method: (setf description) ((feed feed))

Required. A long-ish description of the feed.

Source

feed.lisp.

Target Slot

description.

Generic Reader: guid (object)
Generic Writer: (setf guid) (object)
Package

westbrook.

Methods
Reader Method: guid ((item item))
Writer Method: (setf guid) ((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.

Target Slot

guid.

Package

westbrook.

Methods

automatically generated reader method

Source

feed.lisp.

Target Slot

guid-permalink-p.

Package

westbrook.

Methods

automatically generated writer method

Source

feed.lisp.

Target Slot

guid-permalink-p.

Generic Reader: item-class (object)
Generic Writer: (setf item-class) (object)
Package

westbrook.

Methods
Reader Method: item-class ((feed feed))
Writer Method: (setf item-class) ((feed feed))

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

Source

feed.lisp.

Target Slot

item-class.

Generic Reader: last-build-date (object)
Package

westbrook.

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

automatically generated reader method

Source

feed.lisp.

Target Slot

last-build-date.

Generic Writer: (setf last-build-date) (object)
Package

westbrook.

Methods
Writer Method: (setf last-build-date) ((feed feed))

automatically generated writer method

Source

feed.lisp.

Target Slot

last-build-date.

Package

westbrook.

Methods

Required. A string link to view this item.

Source

feed.lisp.

Target Slot

link.

Required. A link to the RSS feed itself.

Source

feed.lisp.

Target Slot

link.

Generic Reader: pub-date (object)
Package

westbrook.

Methods
Reader Method: pub-date ((item item))

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

Source

feed.lisp.

Target Slot

pub-date.

Reader Method: pub-date ((feed feed))

automatically generated reader method

Source

feed.lisp.

Target Slot

pub-date.

Generic Writer: (setf pub-date) (object)
Package

westbrook.

Methods
Writer Method: (setf pub-date) ((item item))

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

Source

feed.lisp.

Target Slot

pub-date.

Writer Method: (setf pub-date) ((feed feed))

automatically generated writer method

Source

feed.lisp.

Target Slot

pub-date.

Generic Reader: title (object)
Generic Writer: (setf title) (object)
Package

westbrook.

Methods
Reader Method: title ((item item))
Writer Method: (setf title) ((item item))

Required. A string title.

Source

feed.lisp.

Target Slot

title.

Reader Method: title ((feed feed))
Writer Method: (setf title) ((feed feed))

Required. A short description/title for the feed.

Source

feed.lisp.

Target Slot

title.


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

5.2.4 Classes

Class: checked-slots-mixin
Package

westbrook.

Source

feed.lisp.

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

:checked-slots

Readers

checked-slots.

Writers

This slot is read-only.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

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

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

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

C
check-required-slots: Private ordinary functions
checked-slots: Private generic functions
checked-slots: Private generic functions

D
description: Private generic functions
description: Private generic functions
description: Private generic functions

E
element: Private ordinary functions
elements: Private ordinary functions

F
Function, check-required-slots: Private ordinary functions
Function, element: Private ordinary functions
Function, elements: Private ordinary functions
Function, generate-to: Public ordinary functions
Function, iso8601-date-string: Private ordinary functions
Function, pubdate-string: Private ordinary functions

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

I
iso8601-date-string: Private ordinary functions
item-class: Private generic functions
item-class: Private generic functions
items: Public generic functions
items: Public generic functions

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

M
make-feed-item: Public generic functions
make-feed-item: Public generic functions
Method, (setf description): Private generic functions
Method, (setf description): Private generic functions
Method, (setf guid): Private generic functions
Method, (setf guid-permalink-p): Private generic functions
Method, (setf item-class): Private generic functions
Method, (setf items): Public generic functions
Method, (setf last-build-date): Private generic functions
Method, (setf link): Private generic functions
Method, (setf link): Private generic functions
Method, (setf pub-date): Private generic functions
Method, (setf pub-date): Private generic functions
Method, (setf title): Private generic functions
Method, (setf title): Private generic functions
Method, add-feed-item: Public generic functions
Method, checked-slots: Private generic functions
Method, description: Private generic functions
Method, description: Private generic functions
Method, generate: Public generic functions
Method, generate: Public generic functions
Method, generate: Public generic functions
Method, guid: Private generic functions
Method, guid-permalink-p: Private generic functions
Method, item-class: Private generic functions
Method, items: Public generic functions
Method, last-build-date: Private generic functions
Method, link: Private generic functions
Method, link: Private generic functions
Method, make-feed-item: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, pub-date: Private generic functions
Method, pub-date: Private generic functions
Method, shared-initialize: Public standalone methods
Method, title: Private generic functions
Method, title: Private generic functions

P
print-object: Public standalone methods
print-object: Public standalone methods
pub-date: Private generic functions
pub-date: Private generic functions
pub-date: Private generic functions
pubdate-string: Private ordinary functions

S
shared-initialize: Public standalone methods

T
title: Private generic functions
title: Private generic functions
title: Private generic functions

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