[Emacs-diffs] Changes to emacs/doc/misc/newsticker.texi,v

[Ulf Jasper]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Ulf Jasper <u11>        08/06/14 10:01:39

Index: newsticker.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/misc/newsticker.texi,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- newsticker.texi     13 Jun 2008 04:20:25 -0000      1.4
+++ newsticker.texi     14 Jun 2008 10:01:39 -0000      1.5
@@ -1,8 +1,8 @@
 \input texinfo   @c -*-texinfo-*-
 @comment %**start of header
 @setfilename ../../info/newsticker
address@hidden VERSION 1.9
address@hidden UPDATED November 2005
address@hidden VERSION 1.99
address@hidden UPDATED June 2008
 @settitle Newsticker @value{VERSION}
 @syncodeindex vr cp
 @syncodeindex fn cp
@@ -46,7 +46,7 @@
 @subtitle for version @value{VERSION}, @value{UPDATED}
 @author Ulf Jasper
 @author @email{ulf.jasper@@web.de}
address@hidden @uref{http://de.geocities.com/ulf_jasper}
address@hidden @uref{http://ulf.epplejasper.de/}
 @page
 @vskip 0pt plus 1filll
 @insertcopying
@@ -81,7 +81,7 @@
 
 Headlines consist of a title and (possibly) a small description.  They
 are contained in "RSS" (RDF Site Summary) or "Atom" files.  Newsticker
-should work with the following RSS formats:
+works with the following RSS formats:
 
 @itemize
 @item RSS 0.91 (see @uref{http://backend.userland.com/rss091} or
@@ -97,8 +97,8 @@
 @uref{http://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt}).
 @end itemize
 
-That makes Newsticker.el an "Atom aggregator, "RSS reader", or "RSS
-aggregator".
+That makes Newsticker.el an ``Atom aggregator'', ``RSS reader'', ``Feed
+aggregator'', or ``Feed reader''.
 
 Newsticker provides several commands for reading headlines, navigating
 through them, marking them as read/unread, hiding old headlines etc.
@@ -131,9 +131,11 @@
 you are using XEmacs you want to get the @file{net-utils} package
 which contains @file{xml.el} for XEmacs.
 
-Newsticker requires a program which can retrieve files via http and
-prints them to stdout.  By default Newsticker will use
address@hidden://www.gnu.org/software/wget/wget.html, wget} for this task.
+Newsticker retrieves headlines either via Emacs' built-in retrieval
+functions, by an arbitrary external program that retrieves files via
+http and prints them to stdout (like
address@hidden://www.gnu.org/software/wget/wget.html, wget}, or -- on a
+per feed basis -- via an arbitrary Lisp command.
 
 
 @node Installation
@@ -157,12 +159,22 @@
 
 @findex newsticker-show-news
 The command @code{newsticker-show-news} will display all available
-headlines in a special buffer, called @samp{*newsticker*}.  It will
-also start the asynchronous download of headlines.  The modeline in
-the @samp{*newsticker*} buffer informs whenever new headlines have
-arrived.  Clicking mouse-button 2 or pressing RET in this buffer on a
-headline will call @code{browse-url} to load the corresponding news
-story in your favourite web browser.
+headlines.  It will also start the asynchronous download of headlines.
+
+You can choose between two different frontends for reading headlines:
address@hidden
address@hidden Newsticker's @emph{treeview} uses separate windows for the
+feeds (in tree form), a list of headlines for the current feed, and
+the content of the current headline. Feeds can be placed into groups
+which itself can be placed in groups and so on. 
address@hidden Newsticker's @emph{plainview} displays all headlines in a
+single buffer, called @samp{*newsticker*}. The modeline in the
address@hidden buffer informs whenever new headlines have
+arrived.
address@hidden itemize
+In both views clicking mouse-button 2 or pressing RET on a headline
+will call @code{browse-url} to load the corresponding news story in
+your favourite web browser.
 
 @findex newsticker-start-ticker
 @findex newsticker-stop-ticker
@@ -189,12 +201,13 @@
 cases it is not necessary to customize settings before starting Newsticker
 for the first time.
 
-Newsticker options are organized in the following groups.
+The following list shows the available groups of newsticker options
+and some of the most important options.
 
 @itemize
 
 @item
address@hidden contains options that define which news
address@hidden contains options that define which news
 feeds are retrieved and how this is done.  
 
 @itemize
@@ -203,6 +216,11 @@
 @code{newsticker-url-list} defines the list of headlines which are
 retrieved.
 @item
address@hidden newsticker-retrieval-method
address@hidden defines how headlines are
+retrieved. This is either done using Emacs' built-in download
+capabilities or using an external tool.
address@hidden
 @vindex newsticker-retrieval-interval
 @code{newsticker-retrieval-interval} defines how often headlines
 are retrieved.
@@ -218,59 +236,74 @@
 @code{newsticker-keep-obsolete-items} decides whether unread
 headlines that have been removed from the feed are kept in the
 Newsticker cache.
address@hidden
address@hidden newsticker-auto-mark-filter-list
address@hidden provides the possibility to
+automatically mark headlines as immortal or old.
 @end itemize
 
 @item
address@hidden contains options that define how the
-buffer for reading news headlines is formatted.
-
address@hidden contains options for hooking other Emacs
+commands to newsticker functions. 
 @itemize
 @item
address@hidden newsticker-heading-format
address@hidden defines how the title of a headline
-is formatted.
address@hidden newsticker-new-item-functions
address@hidden allows for automatic
+processing of headlines. See `newsticker-download-images', and
+`newsticker-download-enclosures' for sample functions.
address@hidden
address@hidden newsticker-plainview-hooks
+The subgroup @code{newsticker-plainview-hooks} contains hook which
+apply to the plainview reader only.
 @end itemize
 
 @item
address@hidden contains other Newsticker options.
+
address@hidden
 @code{newsticker-ticker} contains options that define how headlines
-are shown in the echo area.
+are shown in the echo area, i.e. the ``ticker''.
 
 @itemize
 @item
 @vindex newsticker-display-interval
 @vindex newsticker-scroll-smoothly
address@hidden and
address@hidden and
 @code{newsticker-scroll-smoothly} define how headlines are shown in
 the echo area.
 @end itemize
 
+
 @item
address@hidden contains options for hooking other Emacs
-commands to newsticker functions. 
address@hidden contains options for adjusting the headline reader.
+
 @itemize
 @item
address@hidden newsticker-new-item-functions
address@hidden allows for automatic
-processing of headlines. See `newsticker-download-images', and
-`newsticker-download-enclosures' for sample functions.
address@hidden newsticker-frontend
address@hidden determines the actual headline reader. The
+``plainview'' reader uses a single buffer, the ``treeview'' uses
+separate buffers and windows.
 @end itemize
 
address@hidden
 @item
address@hidden contains other Newsticker options.
address@hidden newsticker-plainview
+The subgroup @code{newsticker-plainview} contains options for the
+plainview reader.
address@hidden
address@hidden newsticker-treeview
+The subgroup @code{newsticker-treeview} contains options for the
+treeview reader.
address@hidden itemize
 
 @end itemize
 
-Please have a look at the customization buffers for the complete list
-of options.
+For the complete list of options please have a look at the
+customization buffers.
 
 @node Remarks
 @chapter Remarks
 
-This newsticker is designed do its job silently in the background
-without disturbing you.  However, it is probably impossible to prevent
-such a tool from slightly attenuating your Editor's responsiveness
-every once in a while.
-
 Byte-compiling newsticker.el is recommended.
 
 @node GNU Free Documentation License