tazweb annotate README @ rev 131

Tiny edits
author Paul Issott <paul@slitaz.org>
date Sat Jan 04 08:46:41 2014 +0000 (2014-01-04)
parents 0940993683ef
children b499c4de5634
rev   line source
pankso@0 1 TazWeb - SliTaz Web Browser
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
paul@42 5 TazWeb is a radically simple and very light web browser providing a single
paul@131 6 window with one small bottom toolbar using buttons, a URL and search entry,
pankso@71 7 and a contextual menu but no menubar or tabs. Please keep the code simple
paul@131 8 and clean. If you are motivated and want to add some more functionality,
paul@72 9 please talk to the AUTHOR before commiting anything in the repos.
pankso@0 10
paul@42 11 TazWeb uses a custom page in the user Freedesktop directory to let users add
paul@42 12 any content to it and get with one click from the toolbar. We may have
paul@42 13 an external apps/script to handle that file for users who can't manage to
pankso@38 14 edit pure xHTML.
pankso@38 15
paul@31 16 This application have been created for Tazpanel and future SliTaz integrated
paul@31 17 Web applications. The goal is by far to have a fully-featured web browser. But
paul@31 18 if you find a way to provide a simple plugins mechanism, that would be great.
pankso@0 19
paul@31 20 The idea with TazWeb is to have a minimal interface, the approach is to
pankso@15 21 build all the GUI with xHTML and CSS like in TazPanel.
pankso@0 22
pankso@0 23 For general and end-user documentation have a look at doc/tazweb.html.
paul@31 24 TazWeb is published, like webkit source under a free BSD license.
pankso@0 25
paul@72 26 BUG: Right clicking on "Open Link in New Window" is connecting to an event
pankso@71 27 but doesn't work.
pankso@0 28
pankso@0 29
pankso@0 30 Build and install
pankso@0 31 -----------------
pankso@0 32 TazWeb depends on GTK and libwebkit. To build and test, simply:
pankso@0 33
pankso@0 34 $ make
pankso@0 35 $ ./tazweb
pankso@0 36
al@121 37 Generate translation files:
al@121 38
al@121 39 $ make msgfmt
al@121 40
al@121 41 Install with 'make install' (PREFIX and DESTDIR are supported for packaging).
al@121 42
pankso@0 43
pankso@129 44 Qt Build and install
pankso@129 45 --------------------
paul@131 46 The Qt port is actually only a little toy to play with!
pankso@129 47
pankso@129 48 $ cd src
pankso@129 49 $ qmake
pankso@129 50 $ make
pankso@129 51
pankso@129 52
pankso@44 53 Coding notes
pankso@44 54 ------------
pankso@81 55 * To get the filename of a WebKitDownload:
pankso@45 56 file = webkit_download_get_suggested_filename (download);
pankso@44 57
pankso@44 58 * Check mime-type before download (needs a callback function)
pankso@44 59 g_signal_connect (web_view, "mime-type-policy-decision-requested",
pankso@81 60 G_CALLBACK (mime_type_decision_cb), webview);
pankso@44 61
pankso@81 62 * Get user config directory path in $HOME:
pankso@71 63 config = g_strdup_printf ("%s/.config/tazweb", g_get_home_dir ());
pankso@71 64
pankso@81 65 * Change font of a widget:
pankso@81 66 PangoFontDescription *font;
pankso@81 67 font = pango_font_description_from_string("8");
pankso@81 68 gtk_widget_modify_font(urientry, font);
pankso@81 69 pango_font_description_free(font);
pankso@81 70
pankso@81 71 * Change size of a widget:
pankso@81 72 gtk_widget_set_size_request(toolbar, 0, 28);
pankso@81 73
pankso@81 74 * Append a string
pankso@81 75 g_string_append(string, " - TazWeb");
pankso@84 76
al@121 77 * Editable webview
al@121 78 webkit_web_view_set_editable (webview, TRUE);
al@121 79
al@121 80
al@121 81 i18n
al@121 82 ----
al@121 83 Internationalization of TazWeb was introduced since version 1.6.4.
paul@131 84 Its standard GLib technique is described in developer notes:
al@121 85 http://developer.gnome.org/glib/2.32/glib-I18N.html
al@121 86
al@121 87 Translation template (tazweb.pot) and all translations (xx.po) contained
al@121 88 in the po/ folder. To start a new translation use msginit from the
al@121 89 po/ directory. Example for French/France locale (fr_FR):
al@121 90
al@121 91 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
al@121 92
al@121 93 If you run msginit directly without any parameters, locale settings of your
al@121 94 system will be used.
al@121 95
al@121 96 To update pot file from a newly updated sources:
al@121 97
al@121 98 $ make pot
al@121 99
al@121 100 To update all translations from a newly updated pot file:
al@121 101
al@121 102 $ make msgmerge
al@121 103
al@121 104 To clear the distro from temporary compiled and generated files:
al@121 105
al@121 106 $ make clean
pankso@44 107
pankso@0 108 ================================================================================