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