tazweb view README @ rev 187

Tiny edits
author Paul Issott <paul@slitaz.org>
date Tue Mar 14 17:21:58 2017 +0000 (2017-03-14)
parents a6d2bc6be4a4
children 9c7e46fe4fda
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 manager
27 * Text based config file
28 * Search engine entry box
29 * Favorites support
30 * Print, including to pdf
31 * Rich contextual menu
32
33
34 Build and install
35 --------------------------------------------------------------------------------
36 TazWeb depends on GTK and libwebkit. To build and test, simply:
37
38 $ make
39 $ ./tazweb
40
41 Generate translation files:
42
43 $ make msgfmt
44
45 Install with 'make install' (PREFIX and DESTDIR are supported for packaging).
46
47
48 Qt Build and install
49 --------------------------------------------------------------------------------
50 The Qt port is actually only a little toy to play with!
51
52 $ make qt
53 $ ./tazweb-qt
54
55
56 TazWeb helper script
57 --------------------------------------------------------------------------------
58 TazWeb uses a set of SHell functions from /usr/lib/tazweb/helper.sh. These
59 functions are used to handle bookmarks and cookies. The GTK gui parts use
60 yad and some functions will generate html files to be used by tazweb menu
61 or buttons.
62
63
64 Coding notes
65 --------------------------------------------------------------------------------
66
67 * To get the filename of a WebKitDownload:
68 file = webkit_download_get_suggested_filename (download);
69
70 * Check mime-type before download (needs a callback function)
71 g_signal_connect (web_view, "mime-type-policy-decision-requested",
72 G_CALLBACK (mime_type_decision_cb), webview);
73
74 * Get user config directory path in $HOME:
75 config = g_strdup_printf ("%s/.config/tazweb", g_get_home_dir ());
76
77 * Change font of a widget:
78 PangoFontDescription *font;
79 font = pango_font_description_from_string("8");
80 gtk_widget_modify_font(urientry, font);
81 pango_font_description_free(font);
82
83 * Change size of a widget:
84 gtk_widget_set_size_request(toolbar, 0, 28);
85
86 * Append a string
87 g_string_append(string, " - TazWeb");
88
89 * Editable webview
90 webkit_web_view_set_editable (webview, TRUE);
91
92
93 Translation (i18n)
94 --------------------------------------------------------------------------------
95 Internationalization of TazWeb was introduced since version 1.6.4.
96 Its standard GLib technique is described in developer notes:
97 http://developer.gnome.org/glib/2.32/glib-I18N.html
98
99 Translation template (tazweb.pot) and all translations (xx.po) contained
100 in the po/ folder. To start a new translation use msginit from the
101 po/ directory. Example for French/France locale (fr_FR):
102
103 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
104
105 If you run msginit directly without any parameters, locale settings of your
106 system will be used.
107
108 To update pot file from a newly updated sources:
109
110 $ make pot
111
112 To update all translations from a newly updated pot file:
113
114 $ make msgmerge
115
116 To clear the distro from temporary compiled and generated files:
117
118 $ make clean
119
120 ================================================================================