Variable: gnus-score-parameters

gnus-score-parameters is a variable defined in gnus-cus.el.gz.

Value

((mark (number :tag "Mark")
       "The value of this entry should be a number.\nAny articles with a score lower than this number will be marked as read.")
 (expunge (number :tag "Expunge")
	  "The value of this entry should be a number.\nAny articles with a score lower than this number will be removed from\nthe summary buffer.")
 (mark-and-expunge (number :tag "Mark-and-expunge")
		   "The value of this entry should be a number.\nAny articles with a score lower than this number will be marked as\nread and removed from the summary buffer.")
 (thread-mark-and-expunge (number :tag "Thread-mark-and-expunge")
			  "The value of this entry should be a number.\nAll articles that belong to a thread that has a total score below this\nnumber will be marked as read and removed from the summary buffer.\n`gnus-thread-score-function' says how to compute the total score\nfor a thread.")
 (files (repeat :inline t :tag "Files" file)
	"The value of this entry should be any number of file names.\nThese files are assumed to be score files as well, and will be loaded\nthe same way this one was.")
 (exclude-files (repeat :inline t :tag "Exclude-files" file)
		"The clue of this entry should be any number of files.\nThese files will not be loaded, even though they would normally be so,\nfor some reason or other.")
 (eval (sexp :tag "Eval" :value nil)
       "The value of this entry will be `eval'uated.\nThis element will be ignored when handling global score files.")
 (read-only (boolean :tag "Read-only" :value t)
	    "Read-only score files will not be updated or saved.\nGlobal score files should feature this atom.")
 (orphan (number :tag "Orphan")
	 "The value of this entry should be a number.\nArticles that do not have parents will get this number added to their\nscores.  Imagine you follow some high-volume newsgroup, like\n`comp.lang.c'.  Most likely you will only follow a few of the threads,\nalso want to see any new threads.\n\nYou can do this with the following two score file entries:\n\n     (orphan -500)\n     (mark-and-expunge -100)\n\nWhen you enter the group the first time, you will only see the new\nthreads.  You then raise the score of the threads that you find\ninteresting (with `I T' or `I S'), and ignore (`C y') the rest.\nNext time you enter the group, you will see new articles in the\ninteresting threads, plus any new threads.\n\nI.e.---the orphan score atom is for high-volume groups where there\nexist a few interesting threads which can't be found automatically\nby ordinary scoring rules.")
 (adapt
  (choice :tag "Adapt" (const t) (const ignore)
	  (sexp :format "%v" :hide-front-space t))
  "This entry controls the adaptive scoring.\nIf it is t, the default adaptive scoring rules will be used.  If it\nis `ignore', no adaptive scoring will be performed on this group.  If\nit is a list, this list will be used as the adaptive scoring rules.\nIf it isn't present, or is something other than t or `ignore', the\ndefault adaptive scoring rules will be used.  If you want to use\nadaptive scoring on most groups, you'd set `gnus-use-adaptive-scoring'\nto t, and insert an `(adapt ignore)' in the groups where you do not\nwant adaptive scoring.  If you only want adaptive scoring in a few\ngroups, you'd set `gnus-use-adaptive-scoring' to nil, and insert\n`(adapt t)' in the score files of the groups where you want it.")
 (adapt-file (file :tag "Adapt-file")
	     "All adaptive score entries will go to the file named by this entry.\nIt will also be applied when entering the group.  This atom might\nbe handy if you want to adapt on several groups at once, using the\nsame adaptive file for a number of groups.")
 (local
  (repeat :tag "Local"
	  (group :value (nil nil) (symbol :tag "Variable")
		 (sexp :tag "Value")))
  "The value of this entry should be a list of `(VAR VALUE)' pairs.\nEach VAR will be made buffer-local to the current summary buffer,\nand set to the value specified.  This is a convenient, if somewhat\nstrange, way of setting variables in some groups if you don't like\nhooks much.")
 (touched (sexp :format "Touched\n") "Internal variable."))

Documentation

Alist of valid symbolic score parameters.

Each entry has the form (NAME TYPE DOC), where NAME is the parameter itself (a symbol), TYPE is the parameters type (a sexp widget), and DOC is a documentation string for the parameter.

Source Code

;; Defined in /usr/src/emacs/lisp/gnus/gnus-cus.el.gz
;;; Score Customization:

(defconst gnus-score-parameters
  '((mark (number :tag "Mark") "\
The value of this entry should be a number.
Any articles with a score lower than this number will be marked as read.")

    (expunge (number :tag "Expunge") "\
The value of this entry should be a number.
Any articles with a score lower than this number will be removed from
the summary buffer.")

    (mark-and-expunge (number :tag "Mark-and-expunge") "\
The value of this entry should be a number.
Any articles with a score lower than this number will be marked as
read and removed from the summary buffer.")

    (thread-mark-and-expunge (number :tag "Thread-mark-and-expunge") "\
The value of this entry should be a number.
All articles that belong to a thread that has a total score below this
number will be marked as read and removed from the summary buffer.
`gnus-thread-score-function' says how to compute the total score
for a thread.")

    (files (repeat :inline t :tag "Files" file) "\
The value of this entry should be any number of file names.
These files are assumed to be score files as well, and will be loaded
the same way this one was.")

    (exclude-files (repeat :inline t :tag "Exclude-files" file) "\
The clue of this entry should be any number of files.
These files will not be loaded, even though they would normally be so,
for some reason or other.")

    (eval (sexp :tag "Eval" :value nil) "\
The value of this entry will be `eval'uated.
This element will be ignored when handling global score files.")

    (read-only (boolean :tag "Read-only" :value t) "\
Read-only score files will not be updated or saved.
Global score files should feature this atom.")

    (orphan (number :tag "Orphan") "\
The value of this entry should be a number.
Articles that do not have parents will get this number added to their
scores.  Imagine you follow some high-volume newsgroup, like
`comp.lang.c'.  Most likely you will only follow a few of the threads,
also want to see any new threads.

You can do this with the following two score file entries:

     (orphan -500)
     (mark-and-expunge -100)

When you enter the group the first time, you will only see the new
threads.  You then raise the score of the threads that you find
interesting (with `I T' or `I S'), and ignore (`C y') the rest.
Next time you enter the group, you will see new articles in the
interesting threads, plus any new threads.

I.e.---the orphan score atom is for high-volume groups where there
exist a few interesting threads which can't be found automatically
by ordinary scoring rules.")

    (adapt (choice :tag "Adapt"
		   (const t)
		   (const ignore)
		   (sexp :format "%v"
			 :hide-front-space t)) "\
This entry controls the adaptive scoring.
If it is t, the default adaptive scoring rules will be used.  If it
is `ignore', no adaptive scoring will be performed on this group.  If
it is a list, this list will be used as the adaptive scoring rules.
If it isn't present, or is something other than t or `ignore', the
default adaptive scoring rules will be used.  If you want to use
adaptive scoring on most groups, you'd set `gnus-use-adaptive-scoring'
to t, and insert an `(adapt ignore)' in the groups where you do not
want adaptive scoring.  If you only want adaptive scoring in a few
groups, you'd set `gnus-use-adaptive-scoring' to nil, and insert
`(adapt t)' in the score files of the groups where you want it.")

    (adapt-file (file :tag "Adapt-file") "\
All adaptive score entries will go to the file named by this entry.
It will also be applied when entering the group.  This atom might
be handy if you want to adapt on several groups at once, using the
same adaptive file for a number of groups.")

    (local (repeat :tag "Local"
		   (group :value (nil nil)
			  (symbol :tag "Variable")
			  (sexp :tag "Value"))) "\
The value of this entry should be a list of `(VAR VALUE)' pairs.
Each VAR will be made buffer-local to the current summary buffer,
and set to the value specified.  This is a convenient, if somewhat
strange, way of setting variables in some groups if you don't like
hooks much.")
    (touched (sexp :format "Touched\n") "Internal variable."))
  "Alist of valid symbolic score parameters.

Each entry has the form (NAME TYPE DOC), where NAME is the parameter
itself (a symbol), TYPE is the parameters type (a sexp widget), and DOC is a
documentation string for the parameter.")