[pmg-devel] [PATCH docs] pmg-mail-filter: grammar, typo, phrasing fixes

[Aaron Lauterer]

Looks good overall and some nice catches.

Some nits regarding spelling inline.

On 4/21/20 5:14 PM, Oguz Bektas wrote:
> also change a confusing example in the regex guide
> 
> Signed-off-by: Oguz Bektas <o.bektas at proxmox.com>
> ---
>   pmg-mail-filter.adoc | 24 ++++++++++++------------
>   1 file changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git a/pmg-mail-filter.adoc b/pmg-mail-filter.adoc
> index 91e9a00..734f4d2 100644
> --- a/pmg-mail-filter.adoc
> +++ b/pmg-mail-filter.adoc
> @@ -3,7 +3,7 @@ Rule-Based Mail Filter
>   ======================
>   
>   {pmg} ships with a highly configurable mail filter. It’s an easy but
> -powerful way to define filter rules by user, domains, time frame,
> +powerful way to define filter rules by user, domains, timeframe,

my thunderbird dict does not like `timeframe`. What about a dash in between?
Merriam Webster opts for the space variant
https://www.merriam-webster.com/dictionary/time%20frame

>   content type and resulting action.
>   
>   [thumbnail="pmg-gui-mail-filter-rules.png", big=1]
> @@ -65,7 +65,7 @@ reset the filter rules.
>   
>   [thumbnail="pmg-gui-mail-filter-actions.png", big=1]
>   
> -Please note that some actions stops further rule precessing. We call
> +Please note that some actions stop further rule precessing. We call

s/precessing/processing/

>   such actions 'final'.
>   
>   Accept
> @@ -125,7 +125,7 @@ removed attachments.
>   Header Attributes
>   ~~~~~~~~~~~~~~~~~
>   
> -This object is able to add or modify mail header attributes. As notice above, you can use xref:rule_system_macros[macros], making this a very powerful object. For example, the 'Modify Spam Level' actions adds detailed infomation about detected Spam characteristics to the ` X-SPAM-LEVEL` header.
> +This object is able to add or modify mail header attributes. As with notifications above, you can use xref:rule_system_macros[macros], making this a very powerful object. For example, the 'Modify Spam Level' actions adds detailed infomation about detected Spam characteristics to the ` X-SPAM-LEVEL` header.

s/infomation/information

>   
>   .'Modify Spam Level' Header Attribute
>   ----
> @@ -170,7 +170,7 @@ Add a Disclaimer.
>   [thumbnail="pmg-gui-mail-filter-who-objects.png", big=1]
>   
>   This type of objects can be used for the 'TO' and/or 'FROM' category,
> -and macth the sender or receiver of the e-mail. A single object can
> +and match the sender or receiver of the e-mail. A single object can

possibly s/e-mail/email/

>   combine multiple items, and the following item types are available:
>   
>   EMail::
> @@ -191,10 +191,10 @@ This can be used to match the senders IP address.
>   
>   LDAP User or Group::
>   
> -Test if the mail address belong to a specific LDAP user or group.
> +Test if the mail address belongs to a specific LDAP user or group.
>   
>   We have two important 'Who' - objects called 'Blacklist' and
> -'Whitelist'. Those are used in the default ruleset to globally block
> +'Whitelist'. These are used in the default ruleset to globally block

possible s/ruleset/rule-set/
at least the dict in my thunderbird does not like `ruleset`. But I think 
this is used much more throughout the docs and would probably need to be 
addressed in a specific patch to align it

>   or allow specific senders.
>   
>   
> @@ -246,7 +246,7 @@ This also matches the filenames for all regular (non-archived) attachments.
>   [thumbnail="pmg-gui-mail-filter-when-objects.png", big=1]
>   
>   'When' - objects are use to activate rules at specific daytimes. You
> -can compose them of one or more time-frame items.
> +can compose them of one or more timeframe items.

same as above, would leave it or put a space instead of dash

>   
>   The default ruleset defines 'Office Hours', but this is not used by
>   the default rules.
> @@ -274,15 +274,15 @@ Metacharacters
>   Some characters have a special meaning. These characters are called
>   metacharacters.  The Period (`.`) is a commonly used metacharacter. It
>   matches exactly one character, regardless of what the character is.
> -`e.mail` would match either "e-mail" or "e-mail" or "e2mail" but not
> -"e-some-mail".
> +`e.mail` would match either "e-mail" or "e2mail" but not
> +"e-some-mail" or "email".
>   
>   The question mark (`?`) indicates that the character immediately
> -preceding it either zero or one time. `e?mail` would match
> +preceding it shows up either zero or one time. `e?mail` would match
>   either "email" or "mail" but not "e-mail".
>   
>   Another metacharacter is the star (`*`). This indicates that the
> -character immediately to its left may repeated any number of times,
> +character immediately preceding it may be repeated any number of times,
>   including zero. `e*mail` would match either "email" or "mail" or
>   "eeemail".
>   
> @@ -296,4 +296,4 @@ including the null string. For example: `.*company.*` matches
>   "company at domain.com" or "company at domain.co.uk" or
>   "department.company at domain.com".
>   
> -The book xref:Friedl97[] provides a more comprehensive introduction.
> \ No newline at end of file
> +The book xref:Friedl97[] provides a more comprehensive introduction.
>