diff options
| author | Glenn Morris | 2012-10-05 00:34:10 -0700 |
|---|---|---|
| committer | Glenn Morris | 2012-10-05 00:34:10 -0700 |
| commit | d259be38357793eb743ed2813d6f72a3d7728624 (patch) | |
| tree | b29802c48c9fb757b597ec04b82ef343be161416 /doc | |
| parent | 204f3953f905810cdf0cbc797df9c583ef283a23 (diff) | |
| download | emacs-d259be38357793eb743ed2813d6f72a3d7728624.tar.gz emacs-d259be38357793eb743ed2813d6f72a3d7728624.zip | |
* newsticker.texi (Overview, Requirements, Usage, Configuration): Copyedits.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/misc/newsticker.texi | 34 |
2 files changed, 23 insertions, 16 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 950a379b5fb..874252c34c7 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2012-10-05 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * newsticker.texi (Overview, Requirements, Usage, Configuration): | ||
| 4 | Copyedits. | ||
| 5 | |||
| 1 | 2012-08-24 Chong Yidong <cyd@gnu.org> | 6 | 2012-08-24 Chong Yidong <cyd@gnu.org> |
| 2 | 7 | ||
| 3 | * Version 24.2 released. | 8 | * Version 24.2 released. |
diff --git a/doc/misc/newsticker.texi b/doc/misc/newsticker.texi index 919ca21cc3e..5add229724c 100644 --- a/doc/misc/newsticker.texi +++ b/doc/misc/newsticker.texi | |||
| @@ -69,14 +69,14 @@ developing GNU and promoting software freedom.'' | |||
| 69 | @node Overview | 69 | @node Overview |
| 70 | @chapter Overview | 70 | @chapter Overview |
| 71 | 71 | ||
| 72 | Newsticker provides a newsticker for Emacs. A newsticker is a thing | 72 | Newsticker provides a newsticker for Emacs. A newsticker is a thing |
| 73 | that asynchronously retrieves headlines from a list of news sites, | 73 | that asynchronously retrieves headlines from a list of news sites, |
| 74 | prepares these headlines for reading, and allows for loading the | 74 | prepares these headlines for reading, and allows for loading the |
| 75 | corresponding articles in a web browser. | 75 | corresponding articles in a web browser. |
| 76 | 76 | ||
| 77 | 77 | ||
| 78 | Headlines consist of a title and (possibly) a small description. They | 78 | Headlines consist of a title and (possibly) a small description. They |
| 79 | are contained in "RSS" (RDF Site Summary) or "Atom" files. Newsticker | 79 | are contained in ``RSS'' (RDF Site Summary) or ``Atom'' files. Newsticker |
| 80 | works with the following RSS formats: | 80 | works with the following RSS formats: |
| 81 | 81 | ||
| 82 | @itemize | 82 | @itemize |
| @@ -105,8 +105,9 @@ messages in a stock-quote ticker, or just changing. | |||
| 105 | 105 | ||
| 106 | Newsticker allows for automatic processing of headlines by providing | 106 | Newsticker allows for automatic processing of headlines by providing |
| 107 | hooks and (sample) functions for automatically downloading images and | 107 | hooks and (sample) functions for automatically downloading images and |
| 108 | enclosed files (as delivered by podcasts, e.g.). | 108 | enclosed files (as delivered by, e.g., podcasts). |
| 109 | 109 | ||
| 110 | @ignore | ||
| 110 | @ifhtml | 111 | @ifhtml |
| 111 | Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | 112 | Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 |
| 112 | (current version)} and some older screen shots: | 113 | (current version)} and some older screen shots: |
| @@ -116,6 +117,7 @@ Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | |||
| 116 | @uref{newsticker-1.3.png, version 1.3}, | 117 | @uref{newsticker-1.3.png, version 1.3}, |
| 117 | @uref{newsticker-1.0.png, version 1.0}. | 118 | @uref{newsticker-1.0.png, version 1.0}. |
| 118 | @end ifhtml | 119 | @end ifhtml |
| 120 | @end ignore | ||
| 119 | 121 | ||
| 120 | @node Requirements | 122 | @node Requirements |
| 121 | @chapter Requirements | 123 | @chapter Requirements |
| @@ -123,7 +125,7 @@ Here are screen shots of the @uref{newsticker-1.7.png, version 1.7 | |||
| 123 | Newsticker can be used with | 125 | Newsticker can be used with |
| 124 | @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version | 126 | @uref{http://www.gnu.org/software/emacs/emacs.html, GNU Emacs} version |
| 125 | 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It | 127 | 21.1 or later as well as @uref{http://www.xemacs.org, XEmacs}. It |
| 126 | requires an XML-parser (@file{xml.el}) which is part of GNU Emacs. If | 128 | requires an XML-parser (@file{xml.el}), which is part of GNU Emacs. If |
| 127 | you are using XEmacs you want to get the @file{net-utils} package | 129 | you are using XEmacs you want to get the @file{net-utils} package |
| 128 | which contains @file{xml.el} for XEmacs. | 130 | which contains @file{xml.el} for XEmacs. |
| 129 | 131 | ||
| @@ -161,11 +163,11 @@ You can choose between two different frontends for reading headlines: | |||
| 161 | @itemize | 163 | @itemize |
| 162 | @item Newsticker's @emph{treeview} uses separate windows for the | 164 | @item Newsticker's @emph{treeview} uses separate windows for the |
| 163 | feeds (in tree form), a list of headlines for the current feed, and | 165 | feeds (in tree form), a list of headlines for the current feed, and |
| 164 | the content of the current headline. Feeds can be placed into groups | 166 | the content of the current headline. Feeds can be placed into groups, |
| 165 | which itself can be placed in groups and so on. | 167 | which themselves can be placed in groups and so on. |
| 166 | @item Newsticker's @emph{plainview} displays all headlines in a | 168 | @item Newsticker's @emph{plainview} displays all headlines in a |
| 167 | single buffer, called @samp{*newsticker*}. The modeline in the | 169 | single buffer, called @samp{*newsticker*}. The modeline in the |
| 168 | @samp{*newsticker*} buffer informs whenever new headlines have | 170 | @samp{*newsticker*} buffer informs you whenever new headlines have |
| 169 | arrived. | 171 | arrived. |
| 170 | @end itemize | 172 | @end itemize |
| 171 | In both views clicking mouse-button 2 or pressing RET on a headline | 173 | In both views clicking mouse-button 2 or pressing RET on a headline |
| @@ -175,13 +177,13 @@ your favorite web browser. | |||
| 175 | @findex newsticker-start-ticker | 177 | @findex newsticker-start-ticker |
| 176 | @findex newsticker-stop-ticker | 178 | @findex newsticker-stop-ticker |
| 177 | The scrolling, or flashing of headlines in the echo area, can be | 179 | The scrolling, or flashing of headlines in the echo area, can be |
| 178 | started with the command @code{newsticker-start-ticker}. It can be | 180 | started with the command @code{newsticker-start-ticker}. It can be |
| 179 | stopped with @code{newsticker-stop-ticker}. | 181 | stopped with @code{newsticker-stop-ticker}. |
| 180 | 182 | ||
| 181 | @findex newsticker-start | 183 | @findex newsticker-start |
| 182 | @findex newsticker-stop | 184 | @findex newsticker-stop |
| 183 | If you just want to start the periodic download of headlines use the | 185 | If you just want to start the periodic download of headlines use the |
| 184 | command @code{newsticker-start}. Calling @code{newsticker-stop} will | 186 | command @code{newsticker-start}. Calling @code{newsticker-stop} will |
| 185 | stop the periodic download, but will call | 187 | stop the periodic download, but will call |
| 186 | @code{newsticker-stop-ticker} as well. | 188 | @code{newsticker-stop-ticker} as well. |
| 187 | 189 | ||
| @@ -189,7 +191,7 @@ stop the periodic download, but will call | |||
| 189 | @chapter Configuration | 191 | @chapter Configuration |
| 190 | 192 | ||
| 191 | All Newsticker options are customizable, i.e. they can be changed with | 193 | All Newsticker options are customizable, i.e. they can be changed with |
| 192 | Emacs customization methods: Call the command | 194 | Emacs customization methods. Call the command |
| 193 | @code{customize-group} and enter @samp{newsticker} for the customization | 195 | @code{customize-group} and enter @samp{newsticker} for the customization |
| 194 | group. | 196 | group. |
| 195 | 197 | ||
| @@ -209,7 +211,7 @@ feeds are retrieved and how this is done. | |||
| 209 | @itemize | 211 | @itemize |
| 210 | @item | 212 | @item |
| 211 | @vindex newsticker-url-list | 213 | @vindex newsticker-url-list |
| 212 | @code{newsticker-url-list} defines the list of headlines which are | 214 | @code{newsticker-url-list} defines the list of headlines that are |
| 213 | retrieved. | 215 | retrieved. |
| 214 | @item | 216 | @item |
| 215 | @vindex newsticker-retrieval-method | 217 | @vindex newsticker-retrieval-method |
| @@ -245,11 +247,11 @@ commands to newsticker functions. | |||
| 245 | @item | 247 | @item |
| 246 | @vindex newsticker-new-item-functions | 248 | @vindex newsticker-new-item-functions |
| 247 | @code{newsticker-new-item-functions} allows for automatic | 249 | @code{newsticker-new-item-functions} allows for automatic |
| 248 | processing of headlines. See `newsticker-download-images', and | 250 | processing of headlines. See @code{newsticker-download-images}, and |
| 249 | `newsticker-download-enclosures' for sample functions. | 251 | @code{newsticker-download-enclosures} for sample functions. |
| 250 | @item | 252 | @item |
| 251 | @vindex newsticker-plainview-hooks | 253 | @vindex newsticker-plainview-hooks |
| 252 | The subgroup @code{newsticker-plainview-hooks} contains hook which | 254 | The subgroup @code{newsticker-plainview-hooks} contains hooks that |
| 253 | apply to the plainview reader only. | 255 | apply to the plainview reader only. |
| 254 | @end itemize | 256 | @end itemize |
| 255 | 257 | ||
| @@ -276,7 +278,7 @@ the echo area. | |||
| 276 | @itemize | 278 | @itemize |
| 277 | @item | 279 | @item |
| 278 | @vindex newsticker-frontend | 280 | @vindex newsticker-frontend |
| 279 | @code{newsticker-frontend} determines the actual headline reader. The | 281 | @code{newsticker-frontend} determines the actual headline reader. The |
| 280 | ``plainview'' reader uses a single buffer, the ``treeview'' uses | 282 | ``plainview'' reader uses a single buffer, the ``treeview'' uses |
| 281 | separate buffers and windows. | 283 | separate buffers and windows. |
| 282 | @end itemize | 284 | @end itemize |