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