elfeed-score

Table of Contents

Next:   [Contents][Index]

elfeed-score

Gnus-style scoring for Elfeed.

This manual corresponds to elfeed-score version 0.7.2.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

elfeed-score brings Gnus-style scoring to elfeed. If you’re not sure what that means, you’re in the right place. If you know exactly what that means and you just want the technical details, you are also in the right place.

If you are new to elfeed, elfeed-score, or Emacs altogether... read on. This manual is intended to be read front-to-back by new users.

If you are looking for technical details: for a list of elfeed-score functions, refer to the Function Index. For a list of elfeed-score variables, see the Variable Index. For detailed documentation on rule types, see Rule Types.

For information on obtaining & installing elfeed-score, see the project README. For information on building & hacking on elfeed-score, see the Wiki.


Next: , Previous: , Up: Top   [Contents][Index]

2 Getting Started


Next: , Up: Getting Started   [Contents][Index]

2.1 Scoring

elfeed is an extensible RSS & Atom reader for Emacs. By default, it will display entries in reverse chronological order. This package defines a bit of metadata for each of your elfeed entries: a "score". A score is an integer (negative or positive), and higher scores denote entries of greater interest to you. This package also (optionally) installs a new sort function, so that Elfeed will display entries with higher scores before entries with lower scores (entries with the same scores will still be sorted in reverse chronological order). It also provides an entry display function for the search buffer that displays each entry’s score, should you choose to install it.

While you can manually assign a score to an entry, you will likely find it more convenient to create rules for scoring that will be automatically applied to each new entry every time you update Elfeed. You can score against title, feed, content & authors by defining strings that will be matched against those attributes by substring, regexp or whole-word match. You can score against the feed. You can also score against the presence or absence of tags. Most kinds of rules can be scoped by Elfeed entry tags, so that a rule will only be applied if an entry has certain tags (or does not have certain tags). Many kinds of rules may also be scoped by feed, so that a rule will only be applied to entries from certain feeds (or not from certain feeds). Each rule defines an integral value, and the rules are applied in order of definition. The new entry’s score begins at elfeed-score-scoring-default-score, and is adjusted by the value defined by each matching scoring rule.

User Option: elfeed-score-scoring-default-score

The default score for an elfeed entry.

For instance, here’s a subset of my scoring file at the moment:

;;; Elfeed score file                                     -*- lisp -*-
  (("title"
    (:text "OPEN THREAD" :value -1000 :type S :date 1576681345.4086394)
    (:text "raymond c\\(hen\\)?" :value 250 :type r
    :date 1576808786.1558545) :tags (t .(@dev)))
   ("content"
    (:text "type erasure" :value 500 :type s :date 1576808786.043517))
   ("title-or-content"
    (:text "california" 150 100 :type s :date 1576808786.4068587)
    (:text "china" 150 100 :type w :date 1576808786.1848788))
   ("feed"
    (:text "Essays in Idleness" :value 250 :type S :attr t
    :date 1576808786.1956885)
    (:text "Irreal" :value 250 :type S :attr t
    :date 1576808786.1765869)
    (:text "Julia Evans" :value 100 :type :type s :attr t
    :date 1576808786.4092398)
    (:text "National Weather Service" :value 400 :type S :attr t
    :date 1576808786.1117532)
    (:text "emacs-news – sacha chua" :value 350 :type S :attr t
    :date 1576808785.3807983))
   ("authors"
     (:text "Jim Geraghty" :value 500 :type s :date 1611757856.1711636
      :hits 150))
   ("tag"
    (:tags (t . reddit-question)
     :value 750))
   (mark -2500))

Like Gnus scoring, this may look like Lisp code, but it is not directly evaluated. It will be read by the Lisp reader, so it must at least be a valid Lisp s-expression.

For details of how to form s-expressions elfeed-score will understand, see below.


Previous: , Up: Getting Started   [Contents][Index]

2.2 Starting elfeed-score

Once you’ve setup your score file, and assuming you’ve installed elfeed-score, begin or switch to your Emacs session and say:

(require 'elfeed-score)

Just loading the library will *not* modify elfeed; you need to explicitly enable the package for that:

(elfeed-score-enable)

This will install the new sort function & new entry hook, as well as read your score file. NB. elfeed-score-enable is autoloaded, so if you’ve installed this package in the usual way, you should be able to just invoke the function & have the package loaded & enabled automatically.

Command: elfeed-score-enable

Install the new sort function & the new entry hook. Read the score file. With prefix arg do not install the custom sort function.

Some elfeed users have already customized elfeed-search-sort-function and may not wish to have elfeed-score install a new one. elfeed-score-enable takes a prefix argument: if present, it will install the new entry hook & commence scoring, but will not install the new sort function. Such users may refer to elfeed-score-sort if they would like to incorporate scoring into their sort functions.

Utility: elfeed-score-sort

elfeed-search-sort-function-compliant function that will sort elfeed entries by score first, then timestamp.

The package defines a keymap, but does not bind it to any key. I like to set it to the = key:

(define-key elfeed-search-mode-map "=" elfeed-score-map)

Now, only when you’re in the elfeed-score search buffer, you can access elfeed-score commands on the = key.

elfeed allows us to customize how entries are displayed in the elfeed search buffer through the variable elfeed-search-print-entry-function. Because users have customized this, elfeed-score does not alter this variable directly Rather, it offers a replacement implementation, elfeed-score-print-entry, should you wish to use it.

Utility: elfeed-score-print-entry

Prefix each entry with its score when displayed in the elfeed search buffer.

Install it like so:

(setq elfeed-search-print-entry-function #'elfeed-score-print-entry)

While this is not turned on by elfeed-score-enable, elfeed-score-unload will remove it, if it’s there.

Command: elfeed-score-unload

Unload elfeed-score.

Even if you’ve customized the elfeed print function, if you would like to incorporate the score into your version, you can use the elfeed-score-print-entry implementation for inspiration.


Next: , Previous: , Up: Top   [Contents][Index]

3 The Score File

The rules for scoring are written down in the score file, a plain-text file containing a single Lisp form. The location of the score file is defined in elfeed-score-serde-score-file.

User Option: elfeed-score-serde-score-file

The location at which scoring rules are maintained.

The default value is elfeed.score in user-emacs-directory, which see user-emacs-directory in Emacs Lisp.

We’ll go over the format in more detail below.

One important thing to note is that while the score file is initially hand-authored by the user, elfeed-score itself updates it. In other words, the score file is maintained collaboratively by the user and by elfeed-score. The user is responsible for authoring rules. elfeed-score, on startup, will read the file into memory, and after each scoring operation, will write the contents back out to the scoring file, with attributes such as last match time and the number of matches for each rule updated. This means that if you update your rules by hand, you need to tell elfeed-score to re-load it before (re-)scoring any elfeed entries. You can do this by invoking elfeed-score-load-score-file (= l):

Command: elfeed-score-load-score-file

Load the score file into the current session.


Next: , Up: The Score File   [Contents][Index]

3.1 Score File Format

The score file is plain-text file containing a single Lisp form. Under the hood, elfeed-score opens your file, inserts its contents into a temporary buffer, and calls read-from-string (see read-from-string in Emacs Lisp) on the contents.

The form is a list of lists; each sub-list begins with a symbol or a string identifying that sub-list’s nature & purpose. The sub-list identifiers elfeed-score recognizes are:

Until elfeed-score 0.7, all rules were serialized to flat lists, with each attribute in a known position in the list (for instance, title rules wrote down their match text in position 0, the match value in position 1, and so forth, while the other rule types each had their own format).

As time went on, the number of attributes for any given rule type grew. Using flat lists as a serialization format became untenable for two reasons:

  1. Having to "just know" that slot i was for this & slot j was for that became increasingly burdensome for the package author, let alone contributors & users.
  2. It makes validation hard: if the score file author forgets that slot i is for this thing, but provides the thing that goes in slot i + 1, then when elfeed-score calls (nth in i) it will get something back, but will not discover that it’s the wrong sort of thing for some time, which makes it hard to craft a usable error message; worse, elfeed-score may never discover it & instead fail silently.

Beginning with build 0.7.3 (format version 6), elfeed-score now uses property lists as its serialization format. This will address these two issues, at the cost of making authoring rules more prolix: instead of saying:

("match text" 100...)

you’ll now have to say:

(:text "match text" :value 100...)

Given that fields set to their default values do not have to be specified, this will hopefully not be too inconvenient, and will enable better error messages on reading score files.


Next: , Previous: , Up: The Score File   [Contents][Index]

3.2 Types of Rules


Next: , Up: Types of Rules   [Contents][Index]

3.2.1 title Rules

“title rules” are rules that are matched against each entry’s title. You may match by substring, regexp or whole word. The match may be case sensitive or case-insensitive. Of course, the rule needs to specify the amount to be added to an entry’s score on successful match.

In the score file (see The Score File), title rules are represented by a property list of up to seven attributes:

  1. :text: The match text.
  2. :value: The match value. This is an integer specifying the amount by which the entry’s score should be adjusted, should the text match
  3. :type: The match type.

    This is a symbol, and must be one of s, S, r, R, w or W for case-insensitive substring match, case-sensitive substring match, case-insensitive regexp match or case-sensitive regexp match, and case-insensitive or case-sensitive whole word match, respectively.

    Note that regular expressions use Emacs Lisp regular expression syntax (see Regular Expressions in Emacs Lisp).

    Whole word matching just feeds the match text to word-search-regexp (see String Search in Emacs Lisp) before doing a regexp search.

  4. :date: Last match time.

    The last time this rule matched an entry, in seconds since Unix epoch. When defining rules, this element & all those following are optional & need not be supplied by the score file author. This field will be automatically kept up-to-date by elfeed-score.

  5. :tags: Tag scoping rules.

    You may wish to apply this rule only to entries that have certain tags (or that do not have certain tags). See Scoping Rules by Tags for how to do that.

    This property is optional.

  6. :hits: Hit count.

    The number of times this rule has matched an entry. This field will be automatically kept up-to-date by elfeed-score.

  7. :feeds: Feed scoping rules.

    You may wish to apply this rule only to entries that came from certain feeds (or did not come from certain feeds). See Scoping Rules by Feed for how to do that.

    This property is optional.

So, for instance, the following rule:

("title"
  (:text "rust.*who.s hiring" :value 1500 :type r))

would match each entry’s title against the regular expression “rust.*who.s hiring” (without regard to case) and adds 1500 to the score of any entry that matches.

Note that it takes advantage of the fact that only the :text, :value & :type properties are required.

After this rule has been running for some time, and the rule has been updated by elfeed-score, it will be written down in the score file as something like this:

("title"
  (:text "rust.*who.s hiring" :value 1500 :type r
  :date 1612278560.2936354 :hits 46))

The additional elements indicate that this was last matched at Tuesday, February 2, 2021 3:09:20.293 PM UTC & that it has matched forty-six entries since it was created. Note that since it is not scoped to any particular tags or to any particular feed(s), those properties are not recorded.


Next: , Previous: , Up: Types of Rules   [Contents][Index]

3.2.2 content Rules

“content rules” are very similar to title Rules except that they match against an entry’s content rather than its title. For that reason, this section will be very brief– refer to title Rules for the details of each element.

In the score file (see The Score File), content rules are represented by seven properties:

  1. :text The match text
  2. :value The match value
  3. :type The match type as per above.
  4. :date Last match time
  5. :tags Tag scoping rules
  6. :hits Hit count
  7. :feeds Feed scoping rules

As above, only the first three elements are required, and elfeed-score will manage the last match time & hit count.


Next: , Previous: , Up: Types of Rules   [Contents][Index]

3.2.3 title-or-content Rules

When searching for text in entries on which to score, it can be convenient to check both title and content. Rather than repeating each rule in both the “title” and “content” elements of the score file, you can use “title-or-content” rules. These rules consist of eight elements, not seven:

  1. :text The match text, as with title & content rules
  2. :title-value The title match value

    The value by which an entry’s score will be adjusted when the title matches. This allows different scoring values for title & content matches, on the assumption that a title match would be considered more significant.

  3. :content-value The content match value

    The value by which an entry’s score will be adjusted when the content matches.

  4. :type The match type as per above.
  5. :date Last match time Again, this & all following elements are optional, and elfeed-score will keep this element up-to-date.
  6. :tags Tag scoping rules
  7. :hits Hit count
  8. :feeds Feed scoping rules

Note that both entry attributes are checked, so both score values have the potential to added to any given entry.

For instance, the following rule:

("title-or-content"
  (:text "california" :title-value 150 :content-value 100 :type s))

would add 150 to any element who’s title contains the string “california”, as well as 100 if its content also contains that text.


Next: , Previous: , Up: Types of Rules   [Contents][Index]

3.2.4 feed Rules

You can adjust an entry’s score on the basis of the feed that produced it with a “feed” rule. For instance I use this to prioritize certain sources. A feed rule is defined by the following seven elements:

  1. :text: Match text The text to be matched against the feed title, URL or author
  2. :value: Match value The value by which an entry’s score will be adjusted should there be a match
  3. :type: Match type The match type as per above.
  4. :attr: Feed attribute One of the symbols t, u or a for title, URL, or author respectively; this determines the attribute of the feed against which this rule’s text will be matched.
  5. :date: Last match date The last time this rule matched, in seconds since Unix epoch. This element and all that follow it are optional. This element will be maintained by elfeed-score.
  6. :tags: Tag scoping rules You may wish to apply this rule only to entries that have certain tags (or that do not have certain tags). See below for how to do that.
  7. :hits: Hit count The number of times this rule has matched an entry. This field will be automatically kept up-to-date by elfeed-score.

For example, this rule:

("feed"
  (:text "National Weather Service" :value 400 :type S :attr t))

will check the feed title for each entry against the string “National Weather Service” (case will count). Should there be a match, the corresponding entry will have 400 added to its score.


Next: , Previous: , Up: Types of Rules   [Contents][Index]

3.2.5 authors Rules

Some feeds are not produced by a single author. A feed that contains academic papers, for instance, may tag each entry with the authors of the paper to which that entry corresponds. You can score against an entry’s authors with an authors rule.

  1. :text: The match text For each entry, if the “authors” meta-data is present, the authors’ names will be concatenated (separated by “, “) and matched against this text for scoring purposes.
  2. :value: The match value This is an integer specifying the amount by which the entry’s score should be adjusted, should the text match
  3. :type: The match type
  4. :date: Last match time

    The last time this rule matched an entry, in seconds since Unix epoch. When defining rules, this element & all those following are optional & need not be supplied by the score file author. This field will be automatically kept up-to-date by elfeed-score.

  5. :tags: Tag scoping rules

    You may wish to apply this rule only to entries that have certain tags (or that do not have certain tags). See below for how to do that.

  6. :hits: Hit count

    The number of times this rule has matched an entry. This field will be automatically kept up-to-date by elfeed-score.

  7. :feeds: Feed scoping rules

    You may wish to apply this rule only to entries that came from certain feeds (or did not come from certain feeds). See below for how to do that.


Next: , Previous: , Up: Types of Rules   [Contents][Index]

3.2.6 tag Rules

elfeed allows one to automatically tag new entries as they are discovered. It can therefore be convenient to group entries that come from many different feeds but share a tag or tags. That is the purpose of “tag” rules.

“tag” rules are defined by four properties:

  1. :tags: Tags

    The tags whose presence or absence will trigger this rule. They are specified as a cons cell (see cons cell in Emacs Lisp) of the form:

    (switch . tags)
    

    switch is either t or nil and tags is either a tag (i.e. a symbol) or a list of tags. If switch is true, this rule will apply to any entry tagged with one or more tags listed in tags. Conversely, if switch is false, the rule will apply to entries who posses none of the tags in tags.

  2. :value: Match value The amount by which an entry’s score shall be adjusted should this rule match.
  3. :date: Last matched time The time, in seconds since Unix epoch, at which this rule last matched an entry. This and the next element are optional, and elfeed-score will keep this entry up-to-date.
  4. :hits: Hit count The number of times this rule has matched any entry. elfeed-score will keep this entry up-to-date.

Next: , Previous: , Up: Types of Rules   [Contents][Index]

3.2.7 adjust-tags Rules

Until now, all the rules have been used to determine an entry’s score. The “adjust-tags” rule (and the “mark” rule below) act on entries after their scores have been determined.

The adust-tags rule was inspired by John Kitchin’s article Scoring Elfeed Articles. He computes a score and adds one or two tags to entries whose score is sufficiently high. It always bothered me that elfeed-score couldn’t do that, so in build 0.4.3, I added this rule type. These will add or remove tags based on whether the entry’s score is above or below a given threshold.

adjust-tags rules are given by four properties:

  1. :threshold: The threshold at which the rule shall apply

    This is defined by a cons cell (see cons cell in Emacs Lisp) of the form:

    (switch . threshold)
    

    switch may be t or nil and threshold is the threshold against which each entry’s score shall be compared. If switch is t, the rule applies if the score is greater than or equal to threshold; if switch is nil the rule applies if score is less than or equal to threshold.

  2. :tags: The tags to be added or removed

    This is also given by a cons cell

    (switch . tags)
    

    If switch is t & the rule applies, tags (either a single tag or a list of tags) will be added to the entry; if switch is nil, they will be removed

  3. :date: Last match time

    The last time this rule matched an entry, in seconds since Unix epoch. This element is optional, need not be supplied by the score file author, and will be automatically kept up-to-date by the package.

  4. :hits: Hit count

    The number of times this rule has matched an entry. This element is optional, need not be supplied by the score file author, and will be automatically kept up-to-date by the package.

For example, the following rules:

(("adjust-tags"
  (:threshold (t . 1000) :tags (t . a))
  (:threshold (nil . -1000) :tags (nil . b)))

will add the tag 'a to all entries whose score is 1000 or more, and remove tag 'b from all entries whose score is -1000 or less.


Previous: , Up: Types of Rules   [Contents][Index]

3.2.8 mark Rule

Like the “adjust-tag” rule (see above, the mark rule operates on an entry after scoring has completed. If present, it simply specifies an integer; any entry whose score is below this number will be marked as read (in that it will have the 'unread tag removed from it). Since bookmarked elfeed searches typically specify the 'unread tag as a criterion, this essentially means “if an entry’s score is below this number, don’t even show it to me.”

Unlike the other rules, there may only be one mark rule.

Example:

(mark -2500)

Next: , Previous: , Up: The Score File   [Contents][Index]

3.3 Scoping Rule Application

You may find that you only want some rules to not be applied to every entry, but only in certain contexts. Many of the rules described above can be scoped to apply to only entries with certain tags, or to only entries from certain feeds.


Next: , Up: Scoping Rule Application   [Contents][Index]

3.3.1 Scoping Rules by Tags

“title”, “content”, “title-or-content”, “authors” & “feed” rules can be scoped by tag (see Types of Rules). In the description of each of these type of rules above, you will note a slot reserved for “tag scoping rules”. In each case these rules are expressed as a cons cell of the form:

(boolean . (tag...))

The car is a boolean, and the cdr is a list of tags. If the former is t, the rule will only be applied if the entry has at least one of the tags listed. If the boolean value is nil, the rule will only apply if the entry has *none* of the tags listed.

For instance, this is an entry in my score file at the time of this writing:

("title-or-content
  (:text "workspace" :title-value 150 :content-value 75 :type s
   :date 1611937077.6047099
   :tags (t linux)
   :hits 48)

It performs a case-insensitive substring match against entry title and content, adding 150 & 75 points to an entry’s score on match, respectively. It matched most recently at Friday, January 29, 2021 8:17:57.604 AM PST, and has matched 48 times in total.

Of particular interest here is the fact that it will only be applied to entries with the tag 'linux, since “workspace” is fairly generic term, and I am only specific interested in the term as it applies to Linux window managers.


Previous: , Up: Scoping Rule Application   [Contents][Index]

3.3.2 Scoping Rules by Feed

“title”, “content”, “title-or-content” & “authors” rules can also be scoped by feed; that is, you can arrange to have such rules only apply to entries from certain feeds (or apply only to entries not from certain feeds) (see Types of Rules).

Each of these rule types reserves a slot in their definiotn for “feed scope rules”. Such fules are expressed as a cons cell:

(boolean . ((attr match-type matex-text)...))

The car is a boolean, and the cdr is a list of feed selectors. If the former is t, the rule will only be applied if the entry’s feed matches at least one of the selectors listed. If the boolean value is nil, the rule will only apply if the entry’s feed matches none of the selectors listed.

Each selector is itself a three-tuple consisting of:

  1. Feed attribute One of the symbols t, u or a for title, URL, or author respectively; this determines the attribute of the feed against which this rule’s text will be matched.
  2. Match type The match type as per above.
  3. Match text

Example:

("title"
  (:text "foo" :value 100 :type s
   :feeds (t . ((t S "Bar")))))

This defines a title rule See title Rules that checks for a substring matching “foo” in the entry title and adds 100 points to its score on match. However, it will only match entries originating from feeds whose title contains the string “Bar” (case-sensitive).


Previous: , Up: The Score File   [Contents][Index]

3.4 A Complete Score File

This is a small subset of my current score file at the time of this writing. Working score files tend to grow much larger than this (see Rule Maintenance below), but it is a complete example.

;;; Elfeed score file                                     -*- lisp -*-
((version 5)
 ("title"
  (:text "rust.*who.s hiring" :value 1500 :type r
   :date 1612278560.2936354 :hits 46)
  (:text "Microsoft Security Response Center" :value 1500 :type s))
 ("content"
  (:text "/u/I_am_dom_" :value 250 :type s :date 1592054264.5130005
   :tags (t @china)))
 ("title-or-content"
  (:text "california" :title-value 150 :content-value 100 :type s
   :date 1612451934.031678 :hits 3077)
  (:text "melpa" :title-value 250 :content-value 150 :type s
   :date 1612363625.193721
   :tags (t @dev @emacs)
   :hits 108)
  (:text "workspace" :title-value 150 :content-value 75 :type s
   :date 1612451475.3151736
   :tags (t linux)
   :hits 50))
 ("tag"
  (:tags (t . reddit-question)
   :value 750 :date 1602258238.98633))
 ("authors"
  (:text "Jim Geraghty" :value 500 :type s
   :date 1612451618.429526 :hits 172))
 ("feed"
  (:text "Hacker News" :value 150 :type S :attr t
   :date 1612451901.966745 :hits 985))
 (mark -2500)
 ("adjust-tags"))

Next: , Previous: , Up: Top   [Contents][Index]

4 Using elfeed-score


Next: , Up: Using elfeed-score   [Contents][Index]

4.1 Startup in Detail

Once you’ve setup your score file (see The Score File), and started elfeed-score (see Starting elfeed-score), any new entries will be scored automatically, but the entries already in your database have not yet been scored. Scoring is idempotent in that scoring an entry more than once will always result in it having the same score assigned. This means you can load an Elfeed search, and then, in the Elfeed search buffer *elfeed-search*, score all results with elfeed-score-score-search, or = v. When the command completes, the view will be re-sorted by score. Your score file will also have been updated on disk (to record the last time that each rule matched).

Command: elfeed-score-score-search

Score the current set of search results.

You can configure score logging by setting the variable elfeed-score-log-level.

User Option: elfeed-score-log-log-level

Level at which ‘elfeed-score’ shall log; may be one of ’debug, ’info, ’warn, or ’error.

By default it will be 'warn, which will produce very little output. To trouble-shoot a balky rule, type

(setq elfeed-score-log-log-level 'debug)

re-score your current view (= s), and switch to buffer *elfeed-score*.

You can also trouble-shoot rules using the “explain” feature below.


Next: , Previous: , Up: Using elfeed-score   [Contents][Index]

4.2 Asking elfeed-score How It’s Scoring an Entry

If you’ve got an entry that’s not being scored in the manner you expect, you can ask elfeed-score to explain itself by selecting the offending entry & invoking elfeed-score-scoring-explain-entry (= x):

Command: elfeed-score-scoring-explain-entry

Explain an Elfeed ENTRY.

This function will apply all scoring rules to an entry, but will not change anything (e.g. update the entry’s meta-data, or the last-matched timestamp in the matching rules); instead, it will provide a human-readable description of what would happen if the entry were to be scored, presumably for purposes of debugging or understanding of scoring rules.


Previous: , Up: Using elfeed-score   [Contents][Index]

4.3 Rule Maintenance

As time goes by, you may find your score file growing considerably in size & complexity. elfeed-score offers a few reporting functions for looking at the totality of your rules in a few ways:

elfeed-score-maint-display-rules-by-last-match(&optional: category)

Display all scoring rules in descending order of last match.

CATEGORY may be used to narrow the scope of rules displayed. If nil, display all rules. If one of the following symbols, display only that category of rules:

:title :feed :content :title-or-content :authors :tag :adjust-tags

Finally, CATEGORY may be a list of symbols in the preceding list, in which case the union of the corresponding rule categories will be displayed.

Command: elfeed-score-maint-display-rules-by-match-hits (&optional category)

Display all scoring rules in descending order of match hits.

CATEGORY may be used to narrow the scope of rules displayed. If nil, display all rules. If one of the following symbols, display only that category of rules:

:title :feed :content :title-or-content :authors :tag :adjust-tags

Finally, CATEGORY may be a list of symbols in the preceding list, in which case the union of the corresponding rule categories will be displayed.


Next: , Previous: , Up: Top   [Contents][Index]

5 Roadmap & Contributing

I’ve sketched some thoughts on elfeed-score’s future in the README. The focus now is getting it to a place where I’d feel comfortable calling it “1.0”. This includes re-factoring the code and re-writing the serialization logic.

Bugs & feature requests are welcome in the Issues section of the project.

If you’d like to hack on elfeed-score, I’ve started a Wiki for that and am always happy to discuss PRs.

Finally, you can just reach out directly at sp1ff@pobox.com, or in my public inbox.


Next: , Previous: , Up: Top   [Contents][Index]

Index

Jump to:   A   C   E   F   M   N   R   S   T   U  
Index Entry  Section

A
adjust-tags rules: adjust-tags Rules
authors rules: authors Rules

C
complete score file, example: A Complete Score File
content rules: content Rules

E
elfeed-score initialization: Starting elfeed-score

F
feed rules: feed Rules

M
mark rule: mark Rule
match type: title Rules

N
new score file format: Score File Format

R
regular expression syntax: title Rules
rule scoping, feed: Scoping Rules by Feed
rule scoping, tags: Scoping Rules by Tags

S
scoping: Scoping Rule Application
score file: Score File Format
score file entries: Score File Format
score file version: Score File Format
score file, introduction: The Score File
starting elfeed-score: Starting elfeed-score

T
tag rules: tag Rules
title rules: title Rules
title-or-content rules: title-or-content Rules

U
using: Using elfeed-score

Jump to:   A   C   E   F   M   N   R   S   T   U  

Next: , Previous: , Up: Top   [Contents][Index]

Function Index

Jump to:   C   E  
Index Entry  Section

C
category): Rule Maintenance

E
elfeed-score-enable: Starting elfeed-score
elfeed-score-load-score-file: The Score File
elfeed-score-maint-display-rules-by-match-hits: Rule Maintenance
elfeed-score-print-entry: Starting elfeed-score
elfeed-score-score-search: Startup in Detail
elfeed-score-scoring-explain-entry: Asking elfeed-score How It's Scoring an Entry
elfeed-score-sort: Starting elfeed-score
elfeed-score-unload: Starting elfeed-score

Jump to:   C   E  

Previous: , Up: Top   [Contents][Index]

Variable Index

Jump to:   E  
Index Entry  Section

E
elfeed-score-log-log-level: Startup in Detail
elfeed-score-scoring-default-score: Scoring
elfeed-score-serde-score-file: The Score File

Jump to:   E