Added a README file for the Dillo plugin
[claws.git] / src / plugins / dillo_viewer / README
1 Dillo Viewer: HTML mail viewing in Sylpheed-Claws
2 -------------------------------------------------
3
4 The plugin uses the Dillo (http://dillo.auriga.wearlab.de/) browser to
5 view text/html MIME parts inside Sylpheed-Claws.
6
7 When the plugin is loaded, if the MIME part to be viewed is of
8 text/html type, then the MIME part is saved in a temporary file and
9 Dillo is launched with special options to embed it inside
10 Sylpheed-Claws' message view and to "safely" view the part. Dillo is
11 also run in the fullwindow mode, where the toolbar, menubar and the
12 status bar are hidden so the message is viewed in a larger area. The
13 fullwindow mode is toggled on and off by double clicking in an empty
14 part of the page or by clicking on the icon in the lower right corner.
15
16 The "safe" viewing the text/html message part is achieved by using the
17 -l (or --local) option of Dillo. This option prevent Dillo from
18 retrieving remote web resources, like images. This way, no connection
19 to the Internet is done.  If the user want to view the message without
20 this restriction, s/he just reloads the page by clicking on the
21 "Reload" button in Dillo's toolbar.
22
23 This plugin is provided as is. The author does not guarantee safe
24 viewing of text/html messages although he tried hard to achieve this
25 goal.
26
27 What Dillo version should be used?
28 ----------------------------------
29
30 Dillo 0.7.0 was the first version that included the features needed by
31 Claws, although it had a small bug where remote resources could be
32 accessed even with the --local option (when a BASE element is present
33 in the message).
34
35 Since 2002-03-16, the CVS tree of Dillo fixed that bug.
36
37 Dillo 0.7.2 and newer do not have that bug, and are the recommended
38 versions to be used.
39
40 Acknowledgment:
41 ---------------
42
43 The author of this plugin thanks the author of Dillo, Jorge Arellano
44 Cid, who accepted to integrate and improve the different patches
45 needed for this functionality.
46
47 -- 
48 Melvin Hadasht