tazweb view README @ rev 203

Prepare for release
author Christophe Lincoln <pankso@slitaz.org>
date Sat Mar 18 15:30:11 2017 +0100 (2017-03-18)
parents 9c7e46fe4fda
children
line source
1 TazWeb - SliTaz Web Browser
2 ================================================================================
3
4
5 TazWeb is a modern, radically simple and very light web browser providing all
6 needed functions for daily browsing on the internet. TazWeb is aware of users
7 privacy, it handle cookies but will NOT store any passwords or other user info.
8
9 It consists of a single window with one small toolbar using buttons, a URL and
10 search entry, but no menubar. Please keep the code simple and clean. If you are
11 motivated and want to add some more functionality, please talk to the AUTHOR
12 before committing anything in the repos.
13
14 This application has been created for Tazpanel and future SliTaz integrated
15 Web applications and it's become a daily usable browser. The idea with TazWeb
16 is to have a minimal interface, the approach is to build all of the GUI with
17 xHTML and CSS like in TazPanel or well-known web applications.
18
19 For general and end-user documentation have a look at doc/tazweb.html.
20 TazWeb is published, like webkit source under a free BSD license.
21
22 Major features:
23
24 * Tabbed browsing (under development: 2.0 next generation)
25 * Cookie support
26 * Download support
27 * Text based config file
28 * Search engine entry box
29 * Bookmarks manager
30 * Print, including to pdf
31 * Rich contextual menu
32 * Private browsing
33
34
35 Build and install
36 --------------------------------------------------------------------------------
37 TazWeb depends on GTK and libwebkit. To build and test, simply:
38
39 $ make
40 $ ./tazweb
41
42 Generate translation files:
43
44 $ make msgfmt
45
46 Install with 'make install' (PREFIX and DESTDIR are supported for packaging).
47
48
49 Qt Build and install
50 --------------------------------------------------------------------------------
51 The Qt port is actually only a little toy to play with!
52
53 $ make qt
54 $ ./tazweb-qt
55
56
57 TazWeb helper script
58 --------------------------------------------------------------------------------
59 TazWeb uses a set of SHell functions from /usr/lib/tazweb/helper.sh. These
60 functions are used to handle bookmarks and cookies. The GTK gui parts use
61 yad and some functions will generate html files to be used by tazweb menu
62 or buttons.
63
64
65 Coding notes
66 --------------------------------------------------------------------------------
67
68 * To get the filename of a WebKitDownload:
69 file = webkit_download_get_suggested_filename (download);
70
71 * Check mime-type before download (needs a callback function)
72 g_signal_connect (web_view, "mime-type-policy-decision-requested",
73 G_CALLBACK (mime_type_decision_cb), webview);
74
75 * Get user config directory path in $HOME:
76 config = g_strdup_printf ("%s/.config/tazweb", g_get_home_dir ());
77
78 * Change font of a widget:
79 PangoFontDescription *font;
80 font = pango_font_description_from_string("8");
81 gtk_widget_modify_font(urientry, font);
82 pango_font_description_free(font);
83
84 * Change size of a widget:
85 gtk_widget_set_size_request(toolbar, 0, 28);
86
87 * Append a string
88 g_string_append(string, " - TazWeb");
89
90 * Editable webview
91 webkit_web_view_set_editable (webview, TRUE);
92
93
94 Translation (i18n)
95 --------------------------------------------------------------------------------
96 Internationalization of TazWeb was introduced since version 1.6.4.
97 Its standard GLib technique is described in developer notes:
98 http://developer.gnome.org/glib/2.32/glib-I18N.html
99
100 Translation template (tazweb.pot) and all translations (xx.po) contained
101 in the po/ folder. To start a new translation use msginit from the
102 po/ directory. Example for French/France locale (fr_FR):
103
104 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
105
106 If you run msginit directly without any parameters, locale settings of your
107 system will be used.
108
109 To update pot file from a newly updated sources:
110
111 $ make pot
112
113 To update all translations from a newly updated pot file:
114
115 $ make msgmerge
116
117 To clear the distro from temporary compiled and generated files:
118
119 $ make clean
120
121 ================================================================================