tazweb view README @ rev 180

Update README
author Christophe Lincoln <pankso@slitaz.org>
date Mon Mar 13 16:39:57 2017 +0100 (2017-03-13)
parents 02eed5624373
children a6d2bc6be4a4
line source
1 TazWeb - SliTaz Web Browser
2 ================================================================================
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 take of users
7 privacy, it handle cookies but will NOT store any passwords or other user info.
9 a single
10 window with one small toolbar using buttons, a URL and search entry,
11 and a but no menubar. Please keep the code simple
12 and clean. If you are motivated and want to add some more functionality,
13 please talk to the AUTHOR before committing anything in the repos.
15 This application have been created for Tazpanel and future SliTaz integrated
16 Web applications and it become a daily usable browser. The idea with TazWeb
17 is to have a minimal interface, the approach is to build all the GUI with
18 xHTML and CSS like in TazPanel or welkow web applications.
20 For general and end-user documentation have a look at doc/tazweb.html.
21 TazWeb is published, like webkit source under a free BSD license.
23 Major features:
25 * Tabbed browsing (under developement: 2.0 next generation)
26 * Cookie support
27 * Download manager
28 * Text based config file
29 * Search engine entry box
30 * Favorites support
31 * Print, including to pdf
32 * Rich contextual menu
35 Build and install
36 --------------------------------------------------------------------------------
37 TazWeb depends on GTK and libwebkit. To build and test, simply:
39 $ make
40 $ ./tazweb
42 Generate translation files:
44 $ make msgfmt
46 Install with 'make install' (PREFIX and DESTDIR are supported for packaging).
49 Qt Build and install
50 --------------------------------------------------------------------------------
51 The Qt port is actually only a little toy to play with!
53 $ make qt
54 $ ./tazweb-qt
57 TazWeb helper script
58 --------------------------------------------------------------------------------
59 TazWeb use 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 generated html files to be used by tazweb menu
62 or buttons.
65 Coding notes
66 --------------------------------------------------------------------------------
68 * To get the filename of a WebKitDownload:
69 file = webkit_download_get_suggested_filename (download);
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);
75 * Get user config directory path in $HOME:
76 config = g_strdup_printf ("%s/.config/tazweb", g_get_home_dir ());
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);
84 * Change size of a widget:
85 gtk_widget_set_size_request(toolbar, 0, 28);
87 * Append a string
88 g_string_append(string, " - TazWeb");
90 * Editable webview
91 webkit_web_view_set_editable (webview, TRUE);
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
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):
104 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
106 If you run msginit directly without any parameters, locale settings of your
107 system will be used.
109 To update pot file from a newly updated sources:
111 $ make pot
113 To update all translations from a newly updated pot file:
115 $ make msgmerge
117 To clear the distro from temporary compiled and generated files:
119 $ make clean
121 ================================================================================