File: nnfeed.el.html
Generic Gnus backend (intended) for implementing backends for web feeds (Atom, RSS).
This backend is abstract - it doesn't implement a parser for any specific web feed type, and so can't be used independently.
Instead, it implements a generic parser, feed data storage and most of the Gnus backend interface; the intended use for this backend is to be a source of inheritance for backends supporting new web feed types.
To implement new backends, use nnfeed-define-basic-backend-interface:
...
(require 'nnfeed)
(nnoo-declare nnfoo nnfeed)
(nnfeed-define-basic-backend-interface nnfoo)
...
[ definitions of parsing functions, see the "Feed parser interface"
section for more information. ]
(defvoo nnfoo-read-feed-function #'nnfoo--read-feed
nil nnfeed-read-feed-function)
...
(gnus-declare-backend (symbol-name nnfeed-backend) 'none 'address)
(provide 'nnfoo)
Defined variables (25)
nnfeed-backend | Symbol which identifies this backend. |
nnfeed-date-format | Format of displayed dates (see function ‘format-time-string’). |
nnfeed-group | Name of the current group. |
nnfeed-group-article-ids | Hash table mapping article IDs to their article number. |
nnfeed-group-article-max-num | Maximum article number for the current group. |
nnfeed-group-article-min-num | Minimum article number for the current group. |
nnfeed-group-articles | Hash table mapping article numbers to articles and their attributes. |
nnfeed-group-names | Hash table mapping real group names to their custom name. |
nnfeed-print-content-function | Function returning a single piece of content for an article (a string). |
nnfeed-read-article-function | Function returning a cons cell of an article and remaining data from a group. |
nnfeed-read-author-function | Function returning the author of an article (a string), or nil. |
nnfeed-read-description-function | Function returning the description of a group (a string), or nil. |
nnfeed-read-feed-function | Function returning a Lisp object representing a feed (or part of it). |
nnfeed-read-group-author-function | Function returning the author of a group (a string), or nil. |
nnfeed-read-group-function | Function returning a cons cell of a group and remaining data from a feed. |
nnfeed-read-headers-function | Function returning an alist of article-wide MIME headers. |
nnfeed-read-id-function | Function returning the ID of an article. |
nnfeed-read-links-function | Function returning all links contained in an article. |
nnfeed-read-parts-function | Function returning an alist associating parts of an article to their headers. |
nnfeed-read-publish-date-function | Function returning the publish date of an article (a time value), or nil. |
nnfeed-read-subject-function | Function returning the subject of an article (a string), or nil. |
nnfeed-read-title-function | Function returning the title of a group (a string). |
nnfeed-read-update-date-function | Function returning the update date of an article (a time value), or nil. |
nnfeed-servers | Hash table mapping known servers to their groups. |
nnfeed-status-string | Last status message reported by this backend. |