readme.html 2.58 KB
Newer Older
Gaston Dombiak's avatar
Gaston Dombiak committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
	<title>ContentFilter Plugin Readme</title>
    <style type="text/css">
        BODY {
            font-size : 100%;
        }
        BODY, TD, TH {
            font-family : tahoma, verdana, arial, helvetica, sans-serif;
            font-size : 0.8em;
        }
        H2 {
             font-size : 10pt;
             font-weight : bold;
        }
        A:hover {
            text-decoration : none;
        }
        H1 {
            font-family : tahoma, arial, helvetica, sans-serif;
            font-size : 1.4em;
            font-weight: bold;
            border-bottom : 1px #ccc solid;
            padding-bottom : 2px;
        }

        TT {
            font-family : courier new;
            font-weight : bold;
            color : #060;
        }
        PRE {
            font-family : courier new;
            font-size : 100%;
        }
    </style>
</head>
<body>

<h1>
ContentFilter Plugin Readme
</h1>

<h2>Overview</h2>
<p>
48
The content filter plugin allows admins to configure various actions based on
Gaston Dombiak's avatar
Gaston Dombiak committed
49 50 51 52 53 54 55 56
message content. These actions include notifying the admin of content matches,
notifying the sender that a message was rejected or masking the content with
alternative content.
</p>

<h2>Installation</h2>
<p>
Copy the contentfilter.jar into the plugins directory of your Jive Messenger
57
installation. The plugin will then be automatically deployed. To upgrade to a
Gaston Dombiak's avatar
Gaston Dombiak committed
58 59 60 61 62
new version, copy the new contentfilter.jar file over the existing file.
</p>

<h2>Configuration</h2>
<p>
63
By default, after the plugin has been deployed all of its features are disabled.
Gaston Dombiak's avatar
Gaston Dombiak committed
64
This plugin is configured via the "Content Filter" sidebar item located under the
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
"System" tab in the Jive Messenger Admin Console.
</p>

<p>
The default comma separated patterns are "fox,dog". This will perform a case
sensitive match on all words containing these strings. e.g. "fox", "firefox",
"foxy", "dog", "hotdog", "dogdays" but not "Fox", "firefoX". These simple patterns
can be enhanced with more complex regular expressions as required e.g.:
<ul>
  <li>for a complete word match, add boundary checks with \b e.g. \bfox\b will match against the word "fox" and nothing else.
  <li>for case insensitive matchs add (?i) e.g. (?i)\bfox\b will match against "fox", "Fox", "foX" etc.
</ul>

Want to know more about regular expressions in Java? This official <a href="http://java.sun.com/docs/books/tutorial/extra/regex/">tutorial</a>
is useful.
Gaston Dombiak's avatar
Gaston Dombiak committed
80 81 82 83 84 85 86 87 88
</p>

<h2>Using the Plugin</h2>
<p>
After the plugin has been configured, nothing else needs to be done to use it.
</p>

</body>
</html>