The feeder Reference Manual

Table of Contents

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

The feeder Reference Manual

This is the feeder Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:03:18 2020 GMT+0.


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

1 Introduction

## About Feeder
Feeder is a syndication feed library. It presents a general protocol for representation of feed items, as well as a framework to translate these objects from and to external formats. It also implements the RSS 2.0 and Atom formats within this framework.

## Translating Feeds
During this document code examples will assume that ``org.shirakumo.feeder`` has the local nickname ``feeder``.

In order to parse a feed, simply call ``parse-feed``:

:: common lisp
(feeder:parse-feed "Testtest1http://example.com" T)
::

It should determine the format used automatically and construct standardised ``feed`` instances out of the source. In order to reverse the process and turn a ``feed`` into an external format again, simply call ``serialize-feed``:

:: common lisp
(feeder:serialize-feed (first *) 'feeder:atom)
::

Note that while parsing is very lenient, serialising is not, and it will error if certain attributes are missing or malformed. You therefore cannot always round-trip feeds like this.

For ``xml-format``s, the resulting value of ``serialize-feed`` will be a ``plump:node`` that can be turned into a string with ``plump:serialize``:

:: common lisp
(plump:serialize * NIL)
::

## Generating Feeds
In order to generate feeds, you need to translate whatever internal representation of your items you have into ``entry`` instances, and then bundle them together into a ``feed`` instance. Both ``feed`` and ``entry`` instances require in the very least an ``:id``, ``:link``, ``:title``, and ``:summary``. The ``:id`` can be whatever you want it to be, but it should be an ID that uniquely identifies your item for all time, preferably even globally so. If the link to your item can be used as a unique identifier, you can supply the same ``link`` instance to ``:id`` and ``:link``. The ``:summary`` can either be a string of plain text content, or a ``plump:node`` for HTML content.

You should also strongly consider filling in the ``:authors`` and ``:published-on`` fields, as well as the ``:content`` field on ``entry`` instances. For the ``:content``, you may supply either plain text or HTML, just as for the ``:summary``.

In order to bundle the ``entry`` instances into the ``feed``, simply put them into a list and set that as the ``feed``'s ``:content``.

When generating and feed objects and serialising them, the system will check for validity of elements to some limited extent. For instance, required slots that are missing will be reported with errors. Generally whenever an error is signalled, plenty of restarts will be available to help deal with the problem both interactively and in an automated fashion.

Please see the descriptions of ``feed-condition``'s subtypes for more information on the error circumstances and possible restarts.

## Extending Feeds and Formats
If you need to extend the feed objects or add new feed formats, the functions you should look at are ``parse-to`` and ``serialize-to``. In both cases you should add methods to them that specialise on all three arguments, at least one of which must be on a class you control.

Assuming for instance you define an extended ``person`` that has an additional ``location`` field. Ensuring this field is output into the ``atom`` format, you would do something like this:

:: common lisp
(defclass extended-person (feeder:person)
  ((location :initarg :location :initform NIL :accessor location)))

(defmethod feeder:serialize-to ((target plump:element) (person extended-person) (format feeder:atom))
  (call-next-method)
  (when (location person)
    (feeder:make-element target :location - (location person))))
::

When parsing we need to substitute our new class for the instance to use when creating ``person``s. To do so, we require a new ``format`` subclass, and a method on ``instance-for-type``:

:: common lisp
(defclass extended-format (feeder:atom)
  ())

(defmethod feeder:instance-for-type ((type (eql 'person)) (format extended-format))
  (feeder:instance-for-type 'extended-person format))
::

Finally we can read out the field in a ``parse-to`` method:

:: common lisp
(defmethod feeder:parse-to ((person extended-person) (node plump:element) (format extended-format))
  (call-next-method)
  (feeder:with-child (child node :location)
    (setf (location person) (feeder:text child))))
::

Naturally, it is also possible to define entirely new formats that don't necessarily serialise to XML.


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 feeder

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://shinmera.github.io/feeder/

Source Control

(:git "https://github.com/shinmera/feeder.git")

Bug Tracker

https://github.com/shinmera/feeder/issues

License

zlib

Description

RSS, Atom and general feed parsing and generating

Version

1.0.0

Dependencies
Source

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

Location

feeder.asd

Systems

feeder (system)


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

3.1.2 feeder/package.lisp

Parent

feeder (system)

Location

package.lisp

Packages

org.shirakumo.feeder


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

3.1.3 feeder/toolkit.lisp

Dependency

package.lisp (file)

Parent

feeder (system)

Location

toolkit.lisp

Exported Definitions
Internal Definitions

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

3.1.4 feeder/protocol.lisp

Dependency

toolkit.lisp (file)

Parent

feeder (system)

Location

protocol.lisp

Exported Definitions

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

3.1.5 feeder/rss.lisp

Dependency

protocol.lisp (file)

Parent

feeder (system)

Location

rss.lisp

Exported Definitions

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

3.1.6 feeder/atom.lisp

Dependency

rss.lisp (file)

Parent

feeder (system)

Location

atom.lisp

Exported Definitions
Internal Definitions

parse-atom-content (function)


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

3.1.7 feeder/documentation.lisp

Dependency

atom.lisp (file)

Parent

feeder (system)

Location

documentation.lisp


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

4 Packages

Packages are listed by definition order.


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

4.1 org.shirakumo.feeder

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


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

5.1.1 Macros

Macro: make-element PARENT TAG-NAME &body ATTRIBUTES

Construct a new XML element.

ATTRIBUTES should be a plist of alternating keys and values. A key may either be a string or a symbol. If a symbol, it is treated as the attribute name in lowercase. The attribute is only set if the value is non-NIL.

If the key is a symbol with the name "-", the value is used as the text content of the element.

For example, constructing an element like

<foo bar="baz">bam</foo>

would be

(make-element parent "foo"
:bar "baz"
- "bam")

See PLUMP:MAKE-ELEMENT
See PLUMP:ATTRIBUTE
See PLUMP:MAKE-TEXT-NODE

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Macro: with-children (NAME ROOT) &body CLAUSES

Scans through the immediate children of ROOT and executes bodies as matching.

The format should be as follows:

CLAUSES ::= (TAG . form*)*
TAG — A string designator

The forms of a clause are executed with NAME bound to a PLUMP:ELEMENT whose tag-name matches that specified in the clause. Tag names are matched case-insensitively.

See PLUMP:CHILDREN
See PLUMP:TAG-NAME
See PLUMP:ELEMENT

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)


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

5.1.2 Functions

Function: text ENTITY

Returns the trimmed text contents of the given node.

This is like PLUMP:TEXT, but with ASCII whitespace trimmed off the front and end of the text.

See PLUMP:TEXT

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)


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

5.1.3 Generic functions

Generic Function: authors OBJECT

Accessor to the list of persons that authored the item.

See PERSON
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf authors) (generic function)

Methods
Method: authors (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

authors (generic function)

Methods
Method: (setf authors) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: cache-time OBJECT

Accessor to the amount of time the feed can be cached.

This value should be an integer representing the cache time in minutes.

See FEED

Package

org.shirakumo.feeder

Writer

(setf cache-time) (generic function)

Methods
Method: cache-time (FEED feed)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf cache-time) NEW-VALUE OBJECT
Package

org.shirakumo.feeder

Reader

cache-time (generic function)

Methods
Method: (setf cache-time) NEW-VALUE (FEED feed)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: categories OBJECT

Accessor to the list of categories that the item relates to.

Each category should be a simple string.

See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf categories) (generic function)

Methods
Method: categories (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

categories (generic function)

Methods
Method: (setf categories) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: comment-section OBJECT

Accessor to the link for a comment section for this item.

Should be a LINK or URL.

See LINK (type)
See ENTRY

Package

org.shirakumo.feeder

Writer

(setf comment-section) (generic function)

Methods
Method: comment-section (ENTRY entry)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf comment-section) NEW-VALUE OBJECT
Package

org.shirakumo.feeder

Reader

comment-section (generic function)

Methods
Method: (setf comment-section) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: content OBJECT

Accessor to the content of the item.

For FEEDs, the content should be a list of ENTRYs.
For ENTRYs this may be a plaintext string or a PLUMP:NODE.

See FEED
See ENTRY
See PLUMP:NODE
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf content) (generic function)

Methods
Method: content (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

content (generic function)

Methods
Method: (setf content) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: content-type OBJECT

Accessor to the content mime-type at the end of the link.

See LINK (type)

Package

org.shirakumo.feeder

Writer

(setf content-type) (generic function)

Methods
Method: content-type (CONDITION unknown-atom-content-type)
Source

atom.lisp (file)

Method: content-type (LINK link)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf content-type) NEW-VALUE OBJECT
Package

org.shirakumo.feeder

Reader

content-type (generic function)

Methods
Method: (setf content-type) NEW-VALUE (LINK link)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: contributors OBJECT

Accessor to the list of persons that contributed to the item.

See PERSON
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf contributors) (generic function)

Methods
Method: contributors (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

contributors (generic function)

Methods
Method: (setf contributors) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: email OBJECT

Accessor to the email address of the person.

No address validation is performed.

See PERSON

Package

org.shirakumo.feeder

Writer

(setf email) (generic function)

Methods
Method: email (PERSON person)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

email (generic function)

Methods
Method: (setf email) NEW-VALUE (PERSON person)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: generator OBJECT

Accessor to the generator that created this feed.

See GENERATOR (type)
See FEED

Package

org.shirakumo.feeder

Writer

(setf generator) (generic function)

Methods
Method: generator (FEED feed)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

generator (generic function)

Methods
Method: (setf generator) NEW-VALUE (FEED feed)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: id OBJECT

Accessor to the unique ID of the item.

This should either be a value that can be PRINCed to obtain a string representation of the unique identifier, or a LINK.

See LINK (type)
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf id) (generic function)

Methods
Method: id (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

id (generic function)

Methods
Method: (setf id) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: instance-for-type TYPE FORMAT

Returns an appropriate instance for the requested type under the specified format.

By default this constructs an empty (all slots set to NIL) instance
using the given type as a class name.

See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Methods
Method: instance-for-type TYPE (FORMAT format)
Generic Function: language OBJECT

Accessor to the language of the item

This should be a two or three letter code name of the language in which the item’s content is written, though no validation to this effect is performed.

See LINK (type)
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf language) (generic function)

Methods
Method: language (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

Method: language (LINK link)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

language (generic function)

Methods
Method: (setf language) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Method: (setf language) NEW-VALUE (LINK link)

automatically generated writer method

Source

protocol.lisp (file)

Accessor to the link of the item.

See LINK (type)
See REMOTE-ITEM

Package

org.shirakumo.feeder

Writer

(setf link) (generic function)

Methods

automatically generated reader method

Source

protocol.lisp (file)

Package

org.shirakumo.feeder

Reader

link (generic function)

Methods

automatically generated writer method

Source

protocol.lisp (file)

Accessor to the logo for the feed

This should be a LINK

See FEED

Package

org.shirakumo.feeder

Writer

(setf logo) (generic function)

Methods
Method: logo (FEED feed)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

logo (generic function)

Methods
Method: (setf logo) NEW-VALUE (FEED feed)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: name OBJECT

Accessor to the name of the item.

See PERSON
See GENERATOR (type)

Package

org.shirakumo.feeder

Writer

(setf name) (generic function)

Methods
Method: name (GENERATOR generator)

automatically generated reader method

Source

protocol.lisp (file)

Method: name (PERSON person)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

name (generic function)

Methods
Method: (setf name) NEW-VALUE (GENERATOR generator)

automatically generated writer method

Source

protocol.lisp (file)

Method: (setf name) NEW-VALUE (PERSON person)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: parse-feed SOURCE FORMAT

Parses the given source into standardised feed objects according to the specified format.

If FORMAT is T, the format is determined automatically depending on
the source’s contents.

Returns a list of FEED instances.

This function should construct the appropriate base object and then
call PARSE-TO.

See FEED
See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Methods
Method: parse-feed (SOURCE root) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-feed (SOURCE root) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-feed SOURCE (FORMAT (eql t))
Method: parse-feed SOURCE (FORMAT xml-format)
Method: parse-feed SOURCE (FORMAT symbol)
Generic Function: parse-to TARGET THING FORMAT

Fills the target with content from thing according to format.

This is used internally in the parsing process.

See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Methods
Method: parse-to (FEED feed) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (ENTRY entry) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (ITEM authored-item) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (GENERATOR generator) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (PERSON person) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (LINK link) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (DATE (eql date)) (NODE element) (FORMAT atom)
Source

atom.lisp (file)

Method: parse-to (FEED feed) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (ENTRY entry) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (ITEM authored-item) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (GENERATOR generator) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (PERSON person) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (LINK link) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (HTML (eql html)) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (DATE (eql date)) (NODE element) (FORMAT rss)
Source

rss.lisp (file)

Method: parse-to (NAME symbol) THING FORMAT
Generic Function: published-on OBJECT

Accessor to the date on which this item was first published.

The date should be a LOCAL-TIME:TIMESTAMP

See LOCAL-TIME:TIMESTAMP
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf published-on) (generic function)

Methods
Method: published-on (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf published-on) NEW-VALUE OBJECT
Package

org.shirakumo.feeder

Reader

published-on (generic function)

Methods
Method: (setf published-on) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: relation OBJECT

Accessor to the relation of the link.

The following values are typically recognised:

- "alternate"
- "related"
- "self"
- "enclosure"
- "via"

See RFC4287 for more information.

See LINK (type)

Package

org.shirakumo.feeder

Writer

(setf relation) (generic function)

Methods
Method: relation (LINK link)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

relation (generic function)

Methods
Method: (setf relation) NEW-VALUE (LINK link)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: rights OBJECT

Accessor to copyright information relating to the item.

This may be a plaintext string or a PLUMP:NODE

See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf rights) (generic function)

Methods
Method: rights (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

rights (generic function)

Methods
Method: (setf rights) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: serialize-feed FEED FORMAT

Turns the given feed into the specified format.

Returns the encoded feed.

For XML-FORMATs this will be a PLUMP:NODE

This function should construct the appropriate base object and then call SERIALIZE-TO.

See PLUMP:NODE
See XML-FORMAT
See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Methods
Method: serialize-feed (FEED feed) (FORMAT xml-format)
Method: serialize-feed FEED (FORMAT symbol)
Generic Function: serialize-to TARGET THING FORMAT

Fills the target with content from thing according to format.

This is used internally in the serialisation process.

See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Methods
Method: serialize-to (TARGET nesting-node) (FEED feed) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (ENTRY entry) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (ITEM authored-item) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (NODE node) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (STRING string) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (LINK link) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (GENERATOR generator) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (PERSON person) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (DATE timestamp) (FORMAT atom)
Source

atom.lisp (file)

Method: serialize-to (TARGET nesting-node) (FEED feed) (FORMAT rss)
Source

rss.lisp (file)

Method: serialize-to (TARGET nesting-node) (ENTRY entry) (FORMAT rss)
Source

rss.lisp (file)

Method: serialize-to (TARGET nesting-node) (ITEM authored-item) (FORMAT rss)
Source

rss.lisp (file)

Method: serialize-to (TARGET element) (PERSON person) (FORMAT rss)
Source

rss.lisp (file)

Method: serialize-to (TARGET nesting-node) (DATE timestamp) (FORMAT rss)
Source

rss.lisp (file)

Generic Function: source OBJECT

Accessor to the source of this item.

This is used if the entry is aggregated from elsewhere.

Should be a LINK.

see LINK (type)
See ENTRY

Package

org.shirakumo.feeder

Writer

(setf source) (generic function)

Methods
Method: source (ENTRY entry)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

source (generic function)

Methods
Method: (setf source) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: source-has-format-p SOURCE FORMAT

Returns T if the given source is encoded in the given format

See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Methods
Method: source-has-format-p (SOURCE root) (FORMAT atom)
Source

atom.lisp (file)

Method: source-has-format-p (SOURCE root) (FORMAT rss)
Source

rss.lisp (file)

Method: source-has-format-p SOURCE (FORMAT xml-format)
Method: source-has-format-p SOURCE (FORMAT symbol)
Generic Function: summary OBJECT

Accessor to the summary describing the item in short.

This may be a plaintext string or a PLUMP:NODE

In absence of a CONTENT value, it may also represent the full content.

See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf summary) (generic function)

Methods
Method: summary (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

summary (generic function)

Methods
Method: (setf summary) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: title OBJECT

Accessor to the title of the item

This may be a plaintext string or a PLUMP:NODE

See LINK (type)
See AUTHORED-ITEM
See PLUMP:NODE

Package

org.shirakumo.feeder

Writer

(setf title) (generic function)

Methods
Method: title (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

Method: title (LINK link)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

title (generic function)

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

automatically generated writer method

Source

protocol.lisp (file)

Method: (setf title) NEW-VALUE (LINK link)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: updated-on OBJECT

Accessor to the date on which this item was last updated.

The date should be a LOCAL-TIME:TIMESTAMP

See LOCAL-TIME:TIMESTAMP
See AUTHORED-ITEM

Package

org.shirakumo.feeder

Writer

(setf updated-on) (generic function)

Methods
Method: updated-on (AUTHORED-ITEM authored-item)

automatically generated reader method

Source

protocol.lisp (file)

Generic Function: (setf updated-on) NEW-VALUE OBJECT
Package

org.shirakumo.feeder

Reader

updated-on (generic function)

Methods
Method: (setf updated-on) NEW-VALUE (AUTHORED-ITEM authored-item)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: url ITEM

Accessor to the URL of a link or remote item.

The URL should be encoded as a string, and no URL validation is performed.

See LINK (type)
See REMOTE-ITEM

Package

org.shirakumo.feeder

Writer

(setf url) (generic function)

Methods
Method: url (ITEM authored-item)
Source

protocol.lisp (file)

Method: url (LINK link)

automatically generated reader method

Source

protocol.lisp (file)

Method: url (STRING string)
Source

protocol.lisp (file)

Method: url (ITEM remote-item)
Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

url (generic function)

Methods
Method: (setf url) NEW-VALUE (LINK link)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: version OBJECT

Accessor to the generator version.

See GENERATOR (type)

Package

org.shirakumo.feeder

Writer

(setf version) (generic function)

Methods
Method: version (GENERATOR generator)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

version (generic function)

Methods
Method: (setf version) NEW-VALUE (GENERATOR generator)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: webmaster OBJECT

Accessor to the webmaster responsible for this feed.

This should be a PERSON

See FEED

Package

org.shirakumo.feeder

Writer

(setf webmaster) (generic function)

Methods
Method: webmaster (FEED feed)

automatically generated reader method

Source

protocol.lisp (file)

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

org.shirakumo.feeder

Reader

webmaster (generic function)

Methods
Method: (setf webmaster) NEW-VALUE (FEED feed)

automatically generated writer method

Source

protocol.lisp (file)


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

5.1.4 Conditions

Condition: argument-missing ()

Error signalled when a required argument is missing.

This usually happens when you try to create an instance of an object but omitted an argument that is required to create a valid feed.

When this condition is signalled, the following restarts are available

- USE-VALUE
Requires an argument that is then used for the missing argument. - CONTINUE
Set the slot to NIL anyway.

See FEED-CONDITION

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Direct superclasses
Direct slots
Slot: argument
Initargs

:argument

Condition: feed-condition ()

Base condition for all feed related conditions.

See ARGUMENT-MISSING
See NIL-VALUE
See UNKNOWN-FORMAT
See UNKNOWN-ATOM-CONTENT-TYPE

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Condition: nil-value ()

Error signalled when a form returns NIL that should not be NIL.

This usually happens during feed serialisation when a slot is empty that is required to generate a valid feed.

When this condition is signalled, the following restarts are available

- USE-VALUE
Requires an argument that is then returned in place of the NIL.

See FEED-CONDITION

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Direct superclasses
Direct slots
Slot: form
Initargs

:form

Condition: unknown-atom-content-type ()

Error signalled on an unknown content type.

When this condition is signalled, the following restarts are available

- USE-TYPE
Requires an argument that specifies the alternate content-type to use.
- USE-VALUE
Requires an argument that specifies the content to use in its place.
- TREAT-AS-PLAINTEXT
Treats the content as plaintext and returns it.
- CONTINUE
Ignores the content and returns NIL

See FEED-CONDITION
See ATOM

Package

org.shirakumo.feeder

Source

atom.lisp (file)

Direct superclasses
Direct methods

content-type (method)

Direct slots
Slot: content-type
Initargs

:content-type

Readers

content-type (generic function)

Condition: unknown-format ()

Error signalled when the given feed source has an unknown format.

When this condition is signalled, the following restarts are available

- USE-VALUE
Requires an argument that designates the format to use.

See FEED-CONDITION
See PARSE-FEED

Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Direct superclasses
Direct slots
Slot: source
Initargs

:source


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

5.1.5 Classes

Class: atom ()

Atom Feed Format

As defined in RFC4287 https://tools.ietf.org/html/rfc4287 .

As opposed to RSS, Atom is rather strict, and as such parsing of the feed data does not attempt to guess either. However, just as with RSS, parsing a feed should not signal an error.

See XML-FORMAT

Package

org.shirakumo.feeder

Source

atom.lisp (file)

Direct superclasses

xml-format (class)

Direct methods
Class: authored-item ()

Representation of a basic feed item.

This is used as the base class for FEEDs and ENTRYs in a feed.

See REMOTE-ITEM
See ID
See CATEGORIES
See AUTHORS
See CONTRIBUTORS
See PUBLISHED-ON
See UPDATED-ON
See RIGHTS
See LANGUAGE
See LINK
See TITLE
See SUMMARY
See CONTENT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

remote-item (class)

Direct subclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(org.shirakumo.feeder::arg! :id)

Readers

id (generic function)

Writers

(setf id) (generic function)

Slot: categories
Initargs

:categories

Readers

categories (generic function)

Writers

(setf categories) (generic function)

Slot: authors
Initargs

:authors

Readers

authors (generic function)

Writers

(setf authors) (generic function)

Slot: contributors
Initargs

:contributors

Readers

contributors (generic function)

Writers

(setf contributors) (generic function)

Slot: published-on
Initargs

:published-on

Readers

published-on (generic function)

Writers

(setf published-on) (generic function)

Slot: updated-on
Initargs

:updated-on

Initform

(local-time:now)

Readers

updated-on (generic function)

Writers

(setf updated-on) (generic function)

Slot: rights
Initargs

:rights

Readers

rights (generic function)

Writers

(setf rights) (generic function)

Slot: language
Initargs

:language

Readers

language (generic function)

Writers

(setf language) (generic function)

Initform

(org.shirakumo.feeder::arg! :link)

Slot: title
Initargs

:title

Initform

(org.shirakumo.feeder::arg! :title)

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: summary
Initargs

:summary

Initform

(org.shirakumo.feeder::arg! :summary)

Readers

summary (generic function)

Writers

(setf summary) (generic function)

Slot: content
Initargs

:content

Readers

content (generic function)

Writers

(setf content) (generic function)

Class: entry ()

Representation of a feed item.

See AUTHORED-ITEM
See COMMENT-SECTION
See SOURCE

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

authored-item (class)

Direct methods
Direct slots
Slot: comment-section
Initargs

:comment-section

Readers

comment-section (generic function)

Writers

(setf comment-section) (generic function)

Slot: source
Initargs

:source

Readers

source (generic function)

Writers

(setf source) (generic function)

Class: feed ()

Representation of a syndication feed.

See AUTHORED-ITEM
See CACHE-TIME
See GENERATOR
See LOGO
See WEBMASTER

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

authored-item (class)

Direct methods
Direct slots
Slot: cache-time
Initargs

:cache-time

Readers

cache-time (generic function)

Writers

(setf cache-time) (generic function)

Slot: generator
Initargs

:generator

Readers

generator (generic function)

Writers

(setf generator) (generic function)

Slot: logo
Initargs

:logo

Readers

logo (generic function)

Writers

(setf logo) (generic function)

Slot: webmaster
Initargs

:webmaster

Readers

webmaster (generic function)

Writers

(setf webmaster) (generic function)

Class: format ()

Base class for an external format for a feed.

See SOURCE-HAS-FORMAT-P
See PARSE-FEED
See SERIALIZE-FEED
See PARSE-TO
See SERIALIZE-TO

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

xml-format (class)

Direct methods

instance-for-type (method)

Class: generator ()

Representation of a feed generator.

See REMOTE-ITEM
See NAME
See VERSION

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

remote-item (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Initform

(org.shirakumo.feeder::arg! :name)

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: version
Initargs

:version

Readers

version (generic function)

Writers

(setf version) (generic function)

Representation of a link to an external resource.

See URL
See RELATION
See CONTENT-TYPE
See LANGUAGE
See TITLE

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: url
Initargs

:url

Initform

(org.shirakumo.feeder::arg! :url)

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: relation
Initargs

:relation

Readers

relation (generic function)

Writers

(setf relation) (generic function)

Slot: content-type
Initargs

:content-type

Readers

content-type (generic function)

Writers

(setf content-type) (generic function)

Slot: language
Initargs

:language

Readers

language (generic function)

Writers

(setf language) (generic function)

Slot: title
Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Class: person ()

Representation of a person.

See REMOTE-ITEM
See NAME
See EMAIL

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

remote-item (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Initform

(org.shirakumo.feeder::arg! :name)

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: email
Initargs

:email

Initform

(org.shirakumo.feeder::arg! :email)

Readers

email (generic function)

Writers

(setf email) (generic function)

Class: remote-item ()

An item representing a remote resource of some kind.

See LINK
See URL

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
  • url (method)
  • link (method)
  • link (method)
Direct slots
Initargs

:link

Readers

link (generic function)

Writers

(setf link) (generic function)

Class: rss ()

RSS 2.0 Feed Format

As defined in https://validator.w3.org/feed/docs/rss2.html with select extensions such as content:encoded.

RSS is a very "web" format, which is to say that the files claiming to be RSS that can be found out there all do not adhere to any strict specifications, or anything at all for that matter. This makes parsing and dealing with RSS a pain in the ass.

This parser performs a best-effort at parsing the content you hand it, and attempts to standardise and culminate certain features together as appropriate. It should not error when parsing a feed, but may miss or misinterpret certain values present in the raw feed data. For instance, of duplicated tags that should only exist once, only the last tag is actually preserved in the generated objects.

Serialising to RSS will follow the description as closely as possible without touching undefined parts.

See XML-FORMAT

Package

org.shirakumo.feeder

Source

rss.lisp (file)

Direct superclasses

xml-format (class)

Direct methods
Class: xml-format ()

Base class for formats based on XML.

See FORMAT

Package

org.shirakumo.feeder

Source

protocol.lisp (file)

Direct superclasses

format (class)

Direct subclasses
Direct methods

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

5.2 Internal definitions


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

5.2.1 Macros

Macro: ! FORM
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Macro: set-attributes ELEMENT &body ATTRIBUTES
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Macro: with-child (NAME ROOT TAG-NAME) &body BODY
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)


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

5.2.2 Functions

Function: arg! ARGUMENT
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: ensure-attribute-name THING
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: ensure-string CONTENT
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: format-time TIME FORMAT
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: month-digit MONTH
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: parse-atom-content NODE &optional TYPE
Package

org.shirakumo.feeder

Source

atom.lisp (file)

Function: prefix-p PREFIX STRING
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: split SPLITTER STRING
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: trim STRING
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)

Function: tz-offset TZ
Package

org.shirakumo.feeder

Source

toolkit.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
feeder.asd: The feeder․asd file
feeder/atom.lisp: The feeder/atom․lisp file
feeder/documentation.lisp: The feeder/documentation․lisp file
feeder/package.lisp: The feeder/package․lisp file
feeder/protocol.lisp: The feeder/protocol․lisp file
feeder/rss.lisp: The feeder/rss․lisp file
feeder/toolkit.lisp: The feeder/toolkit․lisp file
File, Lisp, feeder.asd: The feeder․asd file
File, Lisp, feeder/atom.lisp: The feeder/atom․lisp file
File, Lisp, feeder/documentation.lisp: The feeder/documentation․lisp file
File, Lisp, feeder/package.lisp: The feeder/package․lisp file
File, Lisp, feeder/protocol.lisp: The feeder/protocol․lisp file
File, Lisp, feeder/rss.lisp: The feeder/rss․lisp file
File, Lisp, feeder/toolkit.lisp: The feeder/toolkit․lisp file

L
Lisp File, feeder.asd: The feeder․asd file
Lisp File, feeder/atom.lisp: The feeder/atom․lisp file
Lisp File, feeder/documentation.lisp: The feeder/documentation․lisp file
Lisp File, feeder/package.lisp: The feeder/package․lisp file
Lisp File, feeder/protocol.lisp: The feeder/protocol․lisp file
Lisp File, feeder/rss.lisp: The feeder/rss․lisp file
Lisp File, feeder/toolkit.lisp: The feeder/toolkit․lisp file

Jump to:   F   L  

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

A.2 Functions

Jump to:   !   (  
A   C   E   F   G   I   L   M   N   P   R   S   T   U   V   W  
Index Entry  Section

!
!: Internal macros

(
(setf authors): Exported generic functions
(setf authors): Exported generic functions
(setf cache-time): Exported generic functions
(setf cache-time): Exported generic functions
(setf categories): Exported generic functions
(setf categories): Exported generic functions
(setf comment-section): Exported generic functions
(setf comment-section): Exported generic functions
(setf content): Exported generic functions
(setf content): Exported generic functions
(setf content-type): Exported generic functions
(setf content-type): Exported generic functions
(setf contributors): Exported generic functions
(setf contributors): Exported generic functions
(setf email): Exported generic functions
(setf email): Exported generic functions
(setf generator): Exported generic functions
(setf generator): Exported generic functions
(setf id): Exported generic functions
(setf id): Exported generic functions
(setf language): Exported generic functions
(setf language): Exported generic functions
(setf language): Exported generic functions
(setf link): Exported generic functions
(setf link): Exported generic functions
(setf logo): Exported generic functions
(setf logo): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf published-on): Exported generic functions
(setf published-on): Exported generic functions
(setf relation): Exported generic functions
(setf relation): Exported generic functions
(setf rights): Exported generic functions
(setf rights): Exported generic functions
(setf source): Exported generic functions
(setf source): Exported generic functions
(setf summary): Exported generic functions
(setf summary): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf updated-on): Exported generic functions
(setf updated-on): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions
(setf version): Exported generic functions
(setf version): Exported generic functions
(setf webmaster): Exported generic functions
(setf webmaster): Exported generic functions

A
arg!: Internal functions
authors: Exported generic functions
authors: Exported generic functions

C
cache-time: Exported generic functions
cache-time: Exported generic functions
categories: Exported generic functions
categories: Exported generic functions
comment-section: Exported generic functions
comment-section: Exported generic functions
content: Exported generic functions
content: Exported generic functions
content-type: Exported generic functions
content-type: Exported generic functions
content-type: Exported generic functions
contributors: Exported generic functions
contributors: Exported generic functions

E
email: Exported generic functions
email: Exported generic functions
ensure-attribute-name: Internal functions
ensure-string: Internal functions

F
format-time: Internal functions
Function, arg!: Internal functions
Function, ensure-attribute-name: Internal functions
Function, ensure-string: Internal functions
Function, format-time: Internal functions
Function, month-digit: Internal functions
Function, parse-atom-content: Internal functions
Function, prefix-p: Internal functions
Function, split: Internal functions
Function, text: Exported functions
Function, trim: Internal functions
Function, tz-offset: Internal functions

G
generator: Exported generic functions
generator: Exported generic functions
Generic Function, (setf authors): Exported generic functions
Generic Function, (setf cache-time): Exported generic functions
Generic Function, (setf categories): Exported generic functions
Generic Function, (setf comment-section): Exported generic functions
Generic Function, (setf content): Exported generic functions
Generic Function, (setf content-type): Exported generic functions
Generic Function, (setf contributors): Exported generic functions
Generic Function, (setf email): Exported generic functions
Generic Function, (setf generator): Exported generic functions
Generic Function, (setf id): Exported generic functions
Generic Function, (setf language): Exported generic functions
Generic Function, (setf link): Exported generic functions
Generic Function, (setf logo): Exported generic functions
Generic Function, (setf name): Exported generic functions
Generic Function, (setf published-on): Exported generic functions
Generic Function, (setf relation): Exported generic functions
Generic Function, (setf rights): Exported generic functions
Generic Function, (setf source): Exported generic functions
Generic Function, (setf summary): Exported generic functions
Generic Function, (setf title): Exported generic functions
Generic Function, (setf updated-on): Exported generic functions
Generic Function, (setf url): Exported generic functions
Generic Function, (setf version): Exported generic functions
Generic Function, (setf webmaster): Exported generic functions
Generic Function, authors: Exported generic functions
Generic Function, cache-time: Exported generic functions
Generic Function, categories: Exported generic functions
Generic Function, comment-section: Exported generic functions
Generic Function, content: Exported generic functions
Generic Function, content-type: Exported generic functions
Generic Function, contributors: Exported generic functions
Generic Function, email: Exported generic functions
Generic Function, generator: Exported generic functions
Generic Function, id: Exported generic functions
Generic Function, instance-for-type: Exported generic functions
Generic Function, language: Exported generic functions
Generic Function, link: Exported generic functions
Generic Function, logo: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, parse-feed: Exported generic functions
Generic Function, parse-to: Exported generic functions
Generic Function, published-on: Exported generic functions
Generic Function, relation: Exported generic functions
Generic Function, rights: Exported generic functions
Generic Function, serialize-feed: Exported generic functions
Generic Function, serialize-to: Exported generic functions
Generic Function, source: Exported generic functions
Generic Function, source-has-format-p: Exported generic functions
Generic Function, summary: Exported generic functions
Generic Function, title: Exported generic functions
Generic Function, updated-on: Exported generic functions
Generic Function, url: Exported generic functions
Generic Function, version: Exported generic functions
Generic Function, webmaster: Exported generic functions

I
id: Exported generic functions
id: Exported generic functions
instance-for-type: Exported generic functions
instance-for-type: Exported generic functions

L
language: Exported generic functions
language: Exported generic functions
language: Exported generic functions
link: Exported generic functions
link: Exported generic functions
logo: Exported generic functions
logo: Exported generic functions

M
Macro, !: Internal macros
Macro, make-element: Exported macros
Macro, set-attributes: Internal macros
Macro, with-child: Internal macros
Macro, with-children: Exported macros
make-element: Exported macros
Method, (setf authors): Exported generic functions
Method, (setf cache-time): Exported generic functions
Method, (setf categories): Exported generic functions
Method, (setf comment-section): Exported generic functions
Method, (setf content): Exported generic functions
Method, (setf content-type): Exported generic functions
Method, (setf contributors): Exported generic functions
Method, (setf email): Exported generic functions
Method, (setf generator): Exported generic functions
Method, (setf id): Exported generic functions
Method, (setf language): Exported generic functions
Method, (setf language): Exported generic functions
Method, (setf link): Exported generic functions
Method, (setf logo): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf published-on): Exported generic functions
Method, (setf relation): Exported generic functions
Method, (setf rights): Exported generic functions
Method, (setf source): Exported generic functions
Method, (setf summary): Exported generic functions
Method, (setf title): Exported generic functions
Method, (setf title): Exported generic functions
Method, (setf updated-on): Exported generic functions
Method, (setf url): Exported generic functions
Method, (setf version): Exported generic functions
Method, (setf webmaster): Exported generic functions
Method, authors: Exported generic functions
Method, cache-time: Exported generic functions
Method, categories: Exported generic functions
Method, comment-section: Exported generic functions
Method, content: Exported generic functions
Method, content-type: Exported generic functions
Method, content-type: Exported generic functions
Method, contributors: Exported generic functions
Method, email: Exported generic functions
Method, generator: Exported generic functions
Method, id: Exported generic functions
Method, instance-for-type: Exported generic functions
Method, language: Exported generic functions
Method, language: Exported generic functions
Method, link: Exported generic functions
Method, logo: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, parse-feed: Exported generic functions
Method, parse-feed: Exported generic functions
Method, parse-feed: Exported generic functions
Method, parse-feed: Exported generic functions
Method, parse-feed: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, parse-to: Exported generic functions
Method, published-on: Exported generic functions
Method, relation: Exported generic functions
Method, rights: Exported generic functions
Method, serialize-feed: Exported generic functions
Method, serialize-feed: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, serialize-to: Exported generic functions
Method, source: Exported generic functions
Method, source-has-format-p: Exported generic functions
Method, source-has-format-p: Exported generic functions
Method, source-has-format-p: Exported generic functions
Method, source-has-format-p: Exported generic functions
Method, summary: Exported generic functions
Method, title: Exported generic functions
Method, title: Exported generic functions
Method, updated-on: Exported generic functions
Method, url: Exported generic functions
Method, url: Exported generic functions
Method, url: Exported generic functions
Method, url: Exported generic functions
Method, version: Exported generic functions
Method, webmaster: Exported generic functions
month-digit: Internal functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions

P
parse-atom-content: Internal functions
parse-feed: Exported generic functions
parse-feed: Exported generic functions
parse-feed: Exported generic functions
parse-feed: Exported generic functions
parse-feed: Exported generic functions
parse-feed: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
parse-to: Exported generic functions
prefix-p: Internal functions
published-on: Exported generic functions
published-on: Exported generic functions

R
relation: Exported generic functions
relation: Exported generic functions
rights: Exported generic functions
rights: Exported generic functions

S
serialize-feed: Exported generic functions
serialize-feed: Exported generic functions
serialize-feed: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
serialize-to: Exported generic functions
set-attributes: Internal macros
source: Exported generic functions
source: Exported generic functions
source-has-format-p: Exported generic functions
source-has-format-p: Exported generic functions
source-has-format-p: Exported generic functions
source-has-format-p: Exported generic functions
source-has-format-p: Exported generic functions
split: Internal functions
summary: Exported generic functions
summary: Exported generic functions

T
text: Exported functions
title: Exported generic functions
title: Exported generic functions
title: Exported generic functions
trim: Internal functions
tz-offset: Internal functions

U
updated-on: Exported generic functions
updated-on: Exported generic functions
url: Exported generic functions
url: Exported generic functions
url: Exported generic functions
url: Exported generic functions
url: Exported generic functions

V
version: Exported generic functions
version: Exported generic functions

W
webmaster: Exported generic functions
webmaster: Exported generic functions
with-child: Internal macros
with-children: Exported macros

Jump to:   !   (  
A   C   E   F   G   I   L   M   N   P   R   S   T   U   V   W  

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

A.3 Variables

Jump to:   A   C   E   F   G   I   L   N   P   R   S   T   U   V   W  
Index Entry  Section

A
argument: Exported conditions
authors: Exported classes

C
cache-time: Exported classes
categories: Exported classes
comment-section: Exported classes
content: Exported classes
content-type: Exported conditions
content-type: Exported classes
contributors: Exported classes

E
email: Exported classes

F
form: Exported conditions

G
generator: Exported classes

I
id: Exported classes

L
language: Exported classes
language: Exported classes
link: Exported classes
link: Exported classes
logo: Exported classes

N
name: Exported classes
name: Exported classes

P
published-on: Exported classes

R
relation: Exported classes
rights: Exported classes

S
Slot, argument: Exported conditions
Slot, authors: Exported classes
Slot, cache-time: Exported classes
Slot, categories: Exported classes
Slot, comment-section: Exported classes
Slot, content: Exported classes
Slot, content-type: Exported conditions
Slot, content-type: Exported classes
Slot, contributors: Exported classes
Slot, email: Exported classes
Slot, form: Exported conditions
Slot, generator: Exported classes
Slot, id: Exported classes
Slot, language: Exported classes
Slot, language: Exported classes
Slot, link: Exported classes
Slot, link: Exported classes
Slot, logo: Exported classes
Slot, name: Exported classes
Slot, name: Exported classes
Slot, published-on: Exported classes
Slot, relation: Exported classes
Slot, rights: Exported classes
Slot, source: Exported conditions
Slot, source: Exported classes
Slot, summary: Exported classes
Slot, title: Exported classes
Slot, title: Exported classes
Slot, updated-on: Exported classes
Slot, url: Exported classes
Slot, version: Exported classes
Slot, webmaster: Exported classes
source: Exported conditions
source: Exported classes
summary: Exported classes

T
title: Exported classes
title: Exported classes

U
updated-on: Exported classes
url: Exported classes

V
version: Exported classes

W
webmaster: Exported classes

Jump to:   A   C   E   F   G   I   L   N   P   R   S   T   U   V   W  

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

A.4 Data types

Jump to:   A   C   E   F   G   L   N   O   P   R   S   U   X  
Index Entry  Section

A
argument-missing: Exported conditions
atom: Exported classes
authored-item: Exported classes

C
Class, atom: Exported classes
Class, authored-item: Exported classes
Class, entry: Exported classes
Class, feed: Exported classes
Class, format: Exported classes
Class, generator: Exported classes
Class, link: Exported classes
Class, person: Exported classes
Class, remote-item: Exported classes
Class, rss: Exported classes
Class, xml-format: Exported classes
Condition, argument-missing: Exported conditions
Condition, feed-condition: Exported conditions
Condition, nil-value: Exported conditions
Condition, unknown-atom-content-type: Exported conditions
Condition, unknown-format: Exported conditions

E
entry: Exported classes

F
feed: Exported classes
feed-condition: Exported conditions
feeder: The feeder system
format: Exported classes

G
generator: Exported classes

L
link: Exported classes

N
nil-value: Exported conditions

O
org.shirakumo.feeder: The org․shirakumo․feeder package

P
Package, org.shirakumo.feeder: The org․shirakumo․feeder package
person: Exported classes

R
remote-item: Exported classes
rss: Exported classes

S
System, feeder: The feeder system

U
unknown-atom-content-type: Exported conditions
unknown-format: Exported conditions

X
xml-format: Exported classes

Jump to:   A   C   E   F   G   L   N   O   P   R   S   U   X