summaryrefslogtreecommitdiffstats
path: root/lurker/README
blob: b138eaad6fdff131f0b2b2e3f698664ab01cd52e (plain)
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
48
49
50
51
52
53
54
For installation instructions, please read INSTALL.
For contact information, please read AUTHORS.
For common questions, please read FAQ.

---------------
What is lurker?
---------------

 An archiver which can handle extremely large amounts of email.
 It is fast, intuitive, and customizable.
 
 Noteworthy features;
    - Full field *fast* searching
         This allows searches like "find me all messages with foo and bar in
         the body, and beer in the subject in this date range" and much more.

    - Chronological threading
         Every other package with threaded-view breaks the arrival order of
         messages in order to display linkage. Often, they also indent quite
         deeply and eventually break when people reply back and forth enough
         times.  Lurker uses a different approach which not only preserves
         arrival order, but also does not nest so deeply that it fails when
         the replies are too deep. Plus, it's prettier. :-)

    - Message threading navigation
         Lurker has a handy navigation graphic available in each message
         which allows a user to easily see and move between messages that
         are related.

    - File attachment support
         Not only does lurker fully understand MIME, it makes file
         attachments available for download and directly embeds those a
         browser can display in the message view.

    - Multi-lingual support
         Lurker uses utf-8 and can therefore support chinese characters in
         the same page as german. Further, it is easily localized with
         translations already available for English, German, and Japanese.

    - Cache files available directly to the web server
         Instead of generating each page dynamically, lurker operates as an
         error document and creates missing pages on the fly. These pages
         are then available direct to the server for later requests. This
         scheme allows lurker to survive a slashdotting more easily since
         the pages do not need to be rerendered each time.

    - Completely customizable output
         Lurker outputs XML which is formatted via XSLT. If a site wishes to
         simply change the formatting, colours, or graphics, it need merely
         change the stylesheet (or choose an existing alternative). If the
         site needs to make actual structural changes, this is as easy as
         editing the xsl used to render the html. Further, if browsers
         support it, lurker will transmit the gzipped xml directly thus
         reducing bandwidth usage for the heftier html.