Explain variables in README
This commit is contained in:
parent
8eb0e5e7ff
commit
e0743061b0
2 changed files with 97 additions and 3 deletions
32
README.org
32
README.org
|
@ -60,6 +60,38 @@ The following table shows the customizable settings for /elfeed-export/:
|
|||
| elfeed-export-include-tags | Export entries that have any of these tags. |
|
||||
| elfeed-export-predicates | Entries that match all of these predicates are exported. |
|
||||
|
||||
** Customize export fields
|
||||
|
||||
Which fields are exported can be configured with the ~elfeed-export-fields~ variable. You may want to remove certain fields from the default, or add new fields. The variable is an alist, each element has a symbol in the car for the column name, and a function in the cdr to retrieve a value.
|
||||
|
||||
Some elfeed extensions supplement the elfeed index with their data, such as elfeed-score. To add a field to the export which shows the score per entry, add the following in your configuration file:
|
||||
|
||||
#+begin_src elisp
|
||||
(add-to-list 'elfeed-export-fields
|
||||
'(score . elfeed-score-scoring-get-score-from-entry)
|
||||
t)
|
||||
#+end_src
|
||||
|
||||
Likewise, if you use elfeed-annotate, you can export annotations as follows:
|
||||
|
||||
#+begin_src elisp
|
||||
(add-to-list 'elfeed-export-fields
|
||||
'(annotation . elfeed-curate-get-entry-annotation)
|
||||
t)
|
||||
#+end_src
|
||||
|
||||
** Customize entry filters
|
||||
|
||||
The variable ~elfeed-export-predicates~ is a list of predicates applied to each entry. An entry that matches all predicates makes it into the export. Each predicate takes two arguments: the entry object and the corresponding feed URL.
|
||||
|
||||
By default, there is a tag-based predicate, which is configured by the variables ~elfeed-export-include-tags~ and ~elfeed-export-exclude-tags~. They're a list of symbols that represent a tag. E.g., to export unread items only, use:
|
||||
|
||||
#+begin_src elisp
|
||||
(add-to-list 'elfeed-export-include-tags 'unread)
|
||||
#+end_src
|
||||
|
||||
By default, items tagged as =noexport= are omitted.
|
||||
|
||||
** COMMENT Attribution :noexport:
|
||||
|
||||
The code to generate the table of configuration items was inspired by an idea of [[https://xenodium.com/generating-elisp-org-docs/][Álvaro Ramírez]] (a.k.a. xenodium).
|
||||
|
|
|
@ -13,6 +13,14 @@ elfeed-export
|
|||
* Installation::
|
||||
* Configuration::
|
||||
|
||||
-- The Detailed Node Listing --
|
||||
|
||||
Configuration
|
||||
|
||||
* Customize export fields::
|
||||
* Customize entry filters::
|
||||
|
||||
|
||||
|
||||
File: elfeed-export.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
|
||||
|
||||
|
@ -60,13 +68,67 @@ elfeed-export-fields Which fields to export per entry and a function to
|
|||
elfeed-export-include-tags Export entries that have any of these tags.
|
||||
elfeed-export-predicates Entries that match all of these predicates are exported.
|
||||
|
||||
* Menu:
|
||||
|
||||
* Customize export fields::
|
||||
* Customize entry filters::
|
||||
|
||||
|
||||
File: elfeed-export.info, Node: Customize export fields, Next: Customize entry filters, Up: Configuration
|
||||
|
||||
3.1 Customize export fields
|
||||
===========================
|
||||
|
||||
Which fields are exported can be configured with the
|
||||
‘elfeed-export-fields’ variable. You may want to remove certain fields
|
||||
from the default, or add new fields. The variable is an alist, each
|
||||
element has a symbol in the car for the column name, and a function in
|
||||
the cdr to retrieve a value.
|
||||
|
||||
Some elfeed extensions supplement the elfeed index with their data,
|
||||
such as elfeed-score. To add a field to the export which shows the
|
||||
score per entry, add the following in your configuration file:
|
||||
|
||||
(add-to-list 'elfeed-export-fields
|
||||
'(score . elfeed-score-scoring-get-score-from-entry)
|
||||
t)
|
||||
|
||||
Likewise, if you use elfeed-annotate, you can export annotations as
|
||||
follows:
|
||||
|
||||
(add-to-list 'elfeed-export-fields
|
||||
'(annotation . elfeed-curate-get-entry-annotation)
|
||||
t)
|
||||
|
||||
|
||||
File: elfeed-export.info, Node: Customize entry filters, Prev: Customize export fields, Up: Configuration
|
||||
|
||||
3.2 Customize entry filters
|
||||
===========================
|
||||
|
||||
The variable ‘elfeed-export-predicates’ is a list of predicates applied
|
||||
to each entry. An entry that matches all predicates makes it into the
|
||||
export. Each predicate takes two arguments: the entry object and the
|
||||
corresponding feed URL.
|
||||
|
||||
By default, there is a tag-based predicate, which is configured by
|
||||
the variables ‘elfeed-export-include-tags’ and
|
||||
‘elfeed-export-exclude-tags’. They're a list of symbols that represent
|
||||
a tag. E.g., to export unread items only, use:
|
||||
|
||||
(add-to-list 'elfeed-export-include-tags 'unread)
|
||||
|
||||
By default, items tagged as ‘noexport’ are omitted.
|
||||
|
||||
|
||||
|
||||
Tag Table:
|
||||
Node: Top87
|
||||
Node: Introduction251
|
||||
Node: Installation759
|
||||
Node: Configuration1164
|
||||
Node: Introduction357
|
||||
Node: Installation865
|
||||
Node: Configuration1270
|
||||
Node: Customize export fields2004
|
||||
Node: Customize entry filters3020
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
|
Loading…
Reference in a new issue