/[debian]/fullquottel/branches/upstream/current/doc_user/html/index.html
ViewVC logotype

Contents of /fullquottel/branches/upstream/current/doc_user/html/index.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 120 - (show annotations)
Sat Feb 25 16:41:21 2006 UTC (15 years, 5 months ago) by gregoa
File MIME type: text/html
File size: 5854 byte(s)
[svn-inject] Installing original source of fullquottel
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>fullquottel: Documentation for fullquottel</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.4.4 -->
7 <h1>Documentation for fullquottel </h1>
8 <p>
9 <h2><a class="anchor" name="Introduction">
10 Introduction</a></h2>
11 fullquottel is a program that helps to distinguish whether an email has the "tofu" style (tofu ... german "Text oben, Fullquote unten" for "text above, fullquote below"; cf. "top posting", "jeopardy style", ...) or not. It takes the (already decoded) email body as input (standard input) and returns one of the words: 'Goodquottel' or 'Fullquottel' on stdout.<h2><a class="anchor" name="Details">
12 Details</a></h2>
13 The program performs several tests to decide whether the mail is a tofu mail or not. Each test produces a score. The final sum of the individual test scores is compared to a threshold. If it is above it, the mail is classified as tofu mail ('Fullquottel' is returned). Further more, the score itself is returned as number and as as row of where each score point produces one *.<p>
14 Each test can be customized:<ul>
15 <li>It can be turned on and off (all tests are turned on by default).</li><li>Its score can be specified (most of the tests have the score of 1.0 by default).</li><li>The individual threshold of some tests can be specified.</li><li>Some tests have additional parameters.</li></ul>
16 <h2><a class="anchor" name="doc_tests">
17 The Tests</a></h2>
18 <h3><a class="anchor" name="doc_ownSigTest">
19 Own Signature Test (ownSigTest)</a></h3>
20 This test searches for the own email signature (default in file: ~/.signature), no matter if it is quoted or not. If the own signature is included in a reply, this is a strong sign for a tofu mail.<h3><a class="anchor" name="doc_msTest">
21 Microsoft Attribution Line Test (msTest)</a></h3>
22 People using MS Outlook (Express) often have the original mail at the bottom of their reply below a line like "----- Original Message -----". This test searches for this kind of lines. It is possible to compare the line number where it was found to a certain threshold. If the line number is equal to or higher than this threshold, the test is positive and the specified score is added.<p>
23 Why the line number? It is possible that a user replies in a non-tofu way but has this "original message" line at the very beginning of his reply.<h3><a class="anchor" name="doc_quotedToAllTest">
24 Ratio Quoted Lines To All Lines Test (quotedToAllTest)</a></h3>
25 This test calculates the ratio between the number of quoted lines and the number of all lines. The ratio has a value between 0 and 1. It is compared to a threshold (default: 0.5) and in case the ratio is higher than the threshold the score is added to the final score. Additionally a factor can be specified that adds an additional weighted score:<p>
26 score(quotedToAllTest) = ratio &gt; threshold ? score + ratio * factor : 0<h3><a class="anchor" name="doc_bottomQuotedToAllTest">
27 Ratio Quoted Lines At Bottom Of The Mail To All Lines Test (bottomQuotedToAllTest)</a></h3>
28 This test calculates the ratio between the number of quoted lines at the bottom of the mail and the number of all lines. The ratio has a value between 0 and 1. It is compared to a threshold (default: 0.5) and in case the ratio is higher than the threshold the score is added to the final score. Additionally a factor can be specified that adds an additional weighted score:<p>
29 score(bottomQuotedToAllTest) = ratio &gt; threshold ? score + ratio * factor : 0<h3><a class="anchor" name="doc_bottomQuotedToQuotedTest">
30 Ratio Quoted Lines At Bottom Of The Mail To Quoted Lines Test (bottomQuotedToQuotedTest)</a></h3>
31 This test calculates the ratio between the number of quoted lines at the bottom of the mail and the number of all quoted lines. The ratio has a value between 0 and 1. It is compared to a threshold (default: 0.5) and in case the ratio is higher than the threshold the score is added to the final score. Additionally a factor can be specified that adds an additional weighted score:<p>
32 score(bottomQuotedToQuotedTest) = ratio &gt; threshold ? score + ratio * factor : 0<h3><a class="anchor" name="doc_singleBottomQuoteTest">
33 Single Quote Block At The Bottom of The Mail Test (mailSingleBottomQuote)</a></h3>
34 This tests checks if the mail has only one quote block and if this quote block is at the bottom of the mail - the classical tofu style.<h2><a class="anchor" name="doc_links">
35 Links used for programming</a></h2>
36 <h3><a class="anchor" name="links_optionParser">
37 option parser</a></h3>
38 <ul>
39 <li><a href="http://getpot.sourceforge.net/">http://getpot.sourceforge.net/</a></li><li><a href="http://platon.sk/projects/main_page.php?project_id=3">http://platon.sk/projects/main_page.php?project_id=3</a></li><li><a href="http://www.gubbe.ch/code/libcfgparse.php">http://www.gubbe.ch/code/libcfgparse.php</a></li><li><a href="http://stlplus.sourceforge.net/stlplus/docs/ini_manager.html">http://stlplus.sourceforge.net/stlplus/docs/ini_manager.html</a></li><li><a href="http://config-plus.sourceforge.net/">http://config-plus.sourceforge.net/</a></li></ul>
40 <h3><a class="anchor" name="links_mimeDecoder">
41 Mime decoder</a></h3>
42 <ul>
43 <li><a href="http://directory.fsf.org/libs/cpp/mimetic.html">http://directory.fsf.org/libs/cpp/mimetic.html</a></li><li><a href="http://codesink.org/mimetic_mime_library.html#snippets">http://codesink.org/mimetic_mime_library.html#snippets</a> </li></ul>
44 <hr size="1"><address style="align: right;"><small>Generated on Fri Sep 2 16:27:02 2005 for fullquottel by&nbsp;
45 <a href="http://www.doxygen.org/index.html">
46 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
47 </body>
48 </html>

  ViewVC Help
Powered by ViewVC 1.1.26