[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/webfeeder 1355a7b 08/22: webfeeder.el: Copy the readme
From: |
Pierre Neidhardt |
Subject: |
[elpa] externals/webfeeder 1355a7b 08/22: webfeeder.el: Copy the readme into the commentary |
Date: |
Tue, 26 Mar 2019 07:10:01 -0400 (EDT) |
branch: externals/webfeeder
commit 1355a7bf8a9469a7b2179f159cbd3d6b02f8555c
Author: Pierre Neidhardt <address@hidden>
Commit: Pierre Neidhardt <address@hidden>
webfeeder.el: Copy the readme into the commentary
---
webfeeder.el | 35 ++++++++++++++++++++++++++++++++---
1 file changed, 32 insertions(+), 3 deletions(-)
diff --git a/webfeeder.el b/webfeeder.el
index 0b526df..312b04a 100644
--- a/webfeeder.el
+++ b/webfeeder.el
@@ -26,10 +26,39 @@
;;; Commentary:
;;
-;; The entry point is `webfeeder-build': run it over a set of HTML files to
-;; produce the corresponding webfeed.
+;; Webfeeder is an Emacs library to generate RSS
+;; (https://en.wikipedia.org/wiki/RSS) and Atom
+;; (https://en.wikipedia.org/wiki/Atom_(Web_standard)) feeds from HTML files.
;;
-;; See https://validator.w3.org/feed/ for an online validation service.
+;; Other webfeed generators have been written for Emacs, but either they are
+;; tied to other projects like blog generators, or they only work on Org files
+;; like `ox-rss'. Since Webfeeder generates webfeeds from HTML files, it is
+;; more general.
+;;
+;; The various elements of the HTML input are parsed with customizable
+;; functions. For instance, Webfeeder offers two functions to parse the title:
+;; `webfeeder-title-libxml' (using libxml if your Emacs is linked against it)
+;; and the less reliable `webfeeder-title-default'. Feel free to write you own
+;; function and bind `webfeeder-title-function' before generating the feeds.
+;;
+;; The generated feeds should be valid on https://validator.w3.org/feed/. If
not,
+;; it's a bug, please report.
+;;
+;; The full list of customizable functions is documented in
+;; `feed-builder-html-files-to-items'.
+;;
+;; The entry point is `webfeeder-build': consult its documentation for more
+;; information.
+;;
+;; Example:
+;;
+;; (feed-builder-build
+;; "atom.xml"
+;; "./public"
+;; "https://example.org/"
+;; '("post1.html" "post2.html" "post3.html")
+;; :title "My homepage"
+;; :description "A collection of articles in Atom")
;;; Code:
- [elpa] branch externals/webfeeder created (now b5148b4), Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder f6032b2 03/22: readme.org: Remove spurious (delete...) from base examples, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 06fab2c 04/22: webfeeder-test.el: Rename "page" to "rss" in test names, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 640b214 05/22: readme.org: Recommend libxml, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 1355a7b 08/22: webfeeder.el: Copy the readme into the commentary,
Pierre Neidhardt <=
- [elpa] externals/webfeeder bfeb09c 16/22: RSS: Remove subtitle from items since they are not supported by the standard, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder f34e3d6 07/22: readme.org: Fix rename feed-builder -> webfeeder, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 989c576 10/22: Atom: Remove <summary> from parent node, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 73b905e 14/22: Atom: Specify type for content, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 4e980b2 17/22: RSS: Only include author if an email address is found in the string, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder be073b5 06/22: webfeeder.el: Edit most docstrings, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 2b10906 18/22: Atom: Add support for email address in author field, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder b5148b4 22/22: Version 1.0.0, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 272bad4 02/22: webfeeder-test.el: Privatize -test-pages, Pierre Neidhardt, 2019/03/26
- [elpa] externals/webfeeder 9083513 21/22: Assign copyright to the Free Software Foundation, Pierre Neidhardt, 2019/03/26