MicroPlanet Gravity - Rules (part 3 of 3)

[continued from part 2] . . .

MicroPlanet Gravity > Help [F1] > Index > Rules > Rules with User Input

Rules with User Input
%s  (percent sign and lower case 's')
If you enter the string '%s' in a Rules Condition,  Gravity will prompt the
user for a text string when the rule is run. The text will be substituted into
the rule condition.
This is useful for running rules manually. However, it can also be used in a
rule that is "enabled" to apply to incoming articles automatically. If enabled,
Gravity will display the text entry dialog when you retrieve headers (which you
might find annoying after a while).
* If '%s' is entered as a Regular Expression, the user input will be treated
  as a PCRE
* %s can be used with From or Subject (or both with Headers).
* You can combine %s with other rule conditions, as:
  From contains "%s"
  And
  Subject does not contain "gravity"
The "User-Specified Word in Subject" Standard Rule uses "%s", which can be
enabled or run manually if you want to see it in action (it marks articles as
important).
Example
We will make the rule Action to discard (delete) articles. Make a rule with a
Condition like this:
 Subject contains reg. expr. "%s"
Be careful when discarding (deleting) articles. If you make a typing or rule
mistake, Gravity deletes what it is told without warning!
If we run this rule manually, Gravity will open a text box that asks for input,
after which the rule will delete (discard) all articles with the Subject
containing the input text.
If you are ON-line, and use %s in a "BODY Contains" rule condition, Gravity
will try to fetch the articles, including bodies, from the server. The bodies
are not saved after the rule finishes. Be aware that this can be a server
intensive operation for large groups.
If you are OFF-line, Gravity will warn that you are offline and do nothing if
you proceed.
You should NOT use a "BODY Contains .." condition in binary groups.

MicroPlanet Gravity > Help [F1] > Index > Rules > Standard Rules:

Standard Rules
Gravity includes the following standard (built in) rules you can use or modify.
These are found in the Rules list (Tools - Rules).
The Watch Thread rule and Ignore Thread rule appear automatically when you
first add threads to the Watch or Ignore list. You may not see them at first -
Gravity hides them until used once.
Important Words Rule
Use this rule to mark articles as Important if they contain certain words or
phrases (to work automatically, it should be Enabled in the main Rules dialog.
1. From the Tools menu, select Important Words.
2. Type the new word or phrase in the New Word field, then click the Add Word
  button or press the Enter key.
3. To remove a word from the list, select the word, then click the Delete Word
  button. You can also right-click a word while you are reading an article,
  then select the Add Important Word command from the Article pop-up menu to
  add the word or phrase to the list of Important Words.
Watch Thread  (W) Rule
Use the Watch Thread rule to follow a particular discussion thread.
1. In the thread pane, right-click the thread you want to watch, then select
  the Watch Thread command. It is easier to remember and use the keyboard
  command (W), or use the toolbar icon.
2. You see the Watch icon graphic in the status column of articles belonging
  to threads you want to watch. To view and change the list of watched
  threads, choose the Watch List command from the View - Other Windows menu.
  You see the Watch List dialog box, where you can set options for watching
  threads.
By default, The Watch Thread Rule downloads article bodies.
  (Also see the Ignore and Watch Threads topic)
Ignore Thread  (I)  Rule
Use the Ignore Thread rule to discard a particular discussion thread.
1. In the thread pane, right-click the thread you want to watch, then select
  the Ignore Thread command. It is easier to remember and use the keyboard
  command (I), or use the toolbar icon.
2. You see the  Stop icon in the status column of articles belonging to
  threads you want to ignore. To view and change the list of threads being
  ignored, choose the Ignore List command from the View menu. You see the
  Ignore List dialog box, where you can set options for ignoring threads.
  (Also see the Ignore and Watch Threads topic)
"User-Specified Word in Subject" Rule
Use the User-Specified Word in Subject rule to find articles that contain a
word in their subject lines. The rule marks found articles as Important. But
you could edit it to add to the score and so forth.
When you first install Gravity, this rule is disabled (i.e., it does not
automatically apply to incoming articles).
When you run the rule manually (through the rule dialog bar or through the
manual rule dialog box), enter the word you want to look for, then Gravity
searches for the word in the subjects of articles in the current newsgroup.
Enable the rule to search for a user-specified word in article subjects and
mark found articles as Important. The rule will open a dialog and ask for
input every time you fetch article headers.
Tips
Most users accept the default actions for these rules, but advanced users
can edit them. For example you may want to add to or subject from the
article score. Or to not download article bodies for the Watch Thread Rule
(they will still be flagged and watched).
If you accidentally remove one of these rules or have upgraded from a
previous version of the program and do not see them, you can re-generate
these rules by deleting all your rules then re-starting Gravity. If you
want to save your current rules, you can export them before deleting them,
restart Gravity to re-generate the standard rules, then restore your
previous rules by importing them from the exported file.

MicroPlanet Gravity > Help [F1] > Index > Rules > The Main Rules Dialog:

The Main Rules Dialog
Rules  (Tools - Rules)
Use the Main Rules Dialog to manage, create, edit, or delete rules.
Main Rules Dialog
Columns
Rules - The rules are not listed in alphabetic order, because:
* Rules are processed in the order listed in the Rules dialog
Apply to incoming - Shows whether the rule has been "enabled" to apply
to all incoming articles or not.
Days Before Expiration - You can set a rule to expire if it has not
fired in x days.
Buttons and Commands
Add/Delete  - Create a New rule or delete an existing rule.
Copy - You can make a copy of a rule to simplify new creation.
Edit - Edit an existing rule.
Rename  - Rename a rule.
Up/Down - change the order in the list. You can control the order that
rules are evaluated by moving them up and down.
Enable/Disable - Very Important. Enabled means the rule will apply to
all incoming articles. Disabled means the rule will not apply to
incoming articles and must be run manually.
Export/Import - You can save your rules in a text file and import them.

MicroPlanet Gravity > Help [F1] > Index > Rules > The Parts of the Rule
System:

Parts of the Rule System
What Parts of Gravity Make up the Rule System? How are they all related?
The following table summarizes all of the parts of Gravity that are
related to rules and indicates when they should be used. You might not
see some of the Standard Rules in the Rule List until you the rule once.
Rules Dialog
Tools - Rules
Opens the Main Rules dialog to create, edit, enable and disable, or import
and export rules. Use the Newsgroups tab to specify to which groups the rule
should apply. Use the Conditions tab to specify the conditions that an
article must satisfy. Use the Actions tab to specify the actions to be taken
if the article matches the rule.
Apply a Rule Manually
If you enable a rule, its conditions are applied to incoming headers. If you
want to apply rules to a group or selected articles on command, use the
Apply a Rule Manually command.  You can also manually apply a rule to
multiple groups at once.
Rule Bar
Use the Rule Bar to apply rules manually.  Select the rule you want, then
click the Run button.
Important Words Rule
Important Words are phrases you want Gravity to call to your attention. The
rule evaluates article subjects for words or phrases that are in the
Important Word List (see next) and flags the article as Important
If enabled, this happens automatically when retrieving headers. The default
action for the Important Words rule is to mark the article as Important, but
it can be edited by the advanced user.
Important Words List
Tools - Important Words - Enter your important words in the Important Words
List. These are the words used by the Important Words Rule. You can make
other rules that flag articles important, or even mark articles manually,
but this list is used by the Important Word Rule.
Watch Thread Command, Rule and List
Use the Watch Thread Command (W) to automatically retrieve all articles in a
thread.  When you are reading an article and choose Watch Thread, Gravity
looks at each article within the thread and adds its references (ancestor
message-ids) to the Watch List (see below). It then applies the Watch Rule
to each article.  Gravity fetches the articles (or tags them for retrieval
if off-line) and automatically retrieves any article in the future that
belongs to the thread.It also flags the article as watched
The Watch Thread Rule is a Standard Rule and will appear after first use.
Like other rules, it can be edited (advanced users).
Watch List
The Watch List (View - Other Windows) is a list of threads Gravity is
currently watching. The Watch Rule tests articles to see if one of its
ancestors is in the Watch List, and if so, applies the specified rule
actions to the article ("Retrieve Body" and "Add to Watch list" are the
default actions).
There are two list settings. One setting controls how many days can elapse
between the time an article in the thread was last seen and when the thread
is removed from the Watch List.  The other setting controls whether articles
with identical subjects but not related Message-IDs are treated as belonging
to the same thread.
You do not have to remove Watched threads from this window. It is easier to
re-use the watch thread command (W) in the main window and Gravity will
remove the thread from the list automatically.
Ignore Thread Command, Rule and List
Use the Ignore Thread Command (I) to automatically ignore all articles in a
thread.  When you choose Ignore Thread, Gravity looks at each article within
the thread and adds all of its references (ancestor message-ids) to the
Ignore List (see below). 
It then applies the Ignore Rule to each of the articles in the thread.
Gravity marks the articles as read and removes them from the display and
automatically marks any article in the future that belongs to the thread
marked as Read and Ignored.
The Ignore Thread Rule is a Standard Rule and will appear after first use.
Like other rules, it can be edited.
Ignore List
The Ignore List (View - Other Windows) is the list of threads Gravity is
currently ignoring. The Ignore Rule tests articles to see if one of its
ancestors is in the Ignore List, and if so, applies the specified actions
to the article ("Mark as Read" and "Add to Ignore list" are the default
actions).
There are two list settings. One setting controls how many days can elapse
between the time an article in the thread was last seen and when the thread
is removed from the Ignore List.  The other setting controls whether
articles with identical subjects, but not related message-ids, are treated
as belonging to the same thread.
You do not have to remove ignored threads from this window. It is easier to
re-use the ignore thread command (I) in the main window and Gravity will
remove the thread from the list automatcially.
Rule Statistics Dialog
View - Other Windows - The Rule Statistics dialog monitors which rules are
running and how much processing time they are taking up. It shows the total
number of headers examined in this session, the number of times the actions
were fired, and the total percentage of rule time spent in the rule.
Example Rules
Gravity includes a few example rules, including the "Ignore the spam!" rule,
and the "User-specified word in subject" rule.  Use these rules as models
for your own rules, or delete or modify them, as you like.

MicroPlanet Gravity > Help [F1] > Index > Rules > When are Rules Evaluated?:

When are Rules Evaluated?
When Gravity evaluates a rule varies depending on its conditions and actions. 
First, you must enable a rule (use the Rules dialog to do so).  When you
receive an article header, Gravity tries to evaluate the rule. 
If the rule or related action applies to the article's body, Gravity defers
the evaluation until it sees the body.
In general, Gravity evaluates enabled rules when you download each article's
header.  Then, when you download the article's body, which may be in a
different user session, Gravity performs any deferred rule condition
evaluations or actions. If you have set the global storage mode to the Save
article headers only option, then Gravity may not evaluate the rule until
you explicitly download the article's body.
* Do not "Enable" a rule if you do not want it applied to incoming articles
  (you intend to run the rule manually)

[end quoted plain text, part 3 of 3]

MicroPlanet Gravity v3.0.11 (2021):
https://www.grc.com/discussions.htm