tazweb view doc/tazweb.en.html @ rev 130
Add a Kiosk mode and fullscreen button for normal use
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Sat Jan 04 03:12:36 2014 +0100 (2014-01-04) |
| parents | c9e4365230ec |
| children | 131267d07b58 |
line source
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <title>TazWeb Documentation</title>
5 <meta charset="utf-8" />
6 <link rel="stylesheet" type="text/css" href="style.css" />
7 </head>
8 <body>
10 <div id="header">
11 <h1>TazWeb Documentation</h1>
12 </div>
14 <!-- Start content -->
15 <div id="content">
17 <h2>SliTaz Web Browser</h2>
19 <p>
20 TazWeb is a radically simple and very light web browser providing a
21 single window with a small toolbar and a contextual menu, but without
22 any menubar or tabs. Navigation is done with a right click anywhere in
23 the browser window or from the toolbar. It can also handle bookmarks in a
24 personal home page, provide a source view mode and zoom and printing
25 functions. TazWeb lets you quickly search the web through a search
26 entry and Google. This documentation file is always accessible from the
27 right-hand side of the toolbar.
28 </p>
29 <p>
30 The browser fast, very fast and small, the binary is about 24 Kb and uses
31 the Webkit engine for page rendering and therefore supports all the latest
32 web standards as well as Javascript and Flash animations or videos.
33 </p>
35 <h3>History</h3>
36 <p>
37 The SliTaz Web Browser was created for the needs of TazPanel which is
38 the SliTaz administration and packages manager panel and made with
39 the latest technologies such as xHTML 5 and CSS 3 for the graphical
40 user interface. The content is powered by CGI scripts and the prefered
41 web server is Busybox httpd.
42 </p>
44 <h3>Security and personal data</h3>
45 <p>
46 TazWeb is a very secure browser and doesn't store any personal data, therefore
47 no sessions, cookies or history files are created. So your websites settings
48 will not be saved and you will have to enter login information each
49 time you restart the browser (by the way websites can track you
50 with cookies!).
51 </p>
53 <h3>Kiosk mode</h3>
54 <p>
55 TazWeb provide a Kiosk mode useful for computer in public area. The
56 Kiosk mode will start TazWeb in fullscreen. It will not allow users to
57 bookmarks a page, download anything or open an URL in a new window.
58 </p>
59 <pre>
60 $ tazweb --kiosk
61 </pre>
63 <h3>My Home Page and bookmarks</h3>
64 <p>
65 TazWeb handles a personal page located in your Freedesktop standard
66 configuration directory, the path is: $HOME/.config/tazweb/home.html.
67 It lets you have a custom page with bookmarks and other content. The
68 CSS style is defined in $HOME/.config/tazweb/style.css.
69 </p>
70 <p>
71 The file is a simple xHTML 5 document with, by default, a list of
72 links and a box. You can edit this file with you favorite editor
73 and add content such as bookmarks entries or change the look and
74 feel as you want. At first start TazWeb will create and copy your
75 personal page and style to your config directory.
76 </p>
77 <p>
78 To add some life to your pages you can use your own Javascript
79 widgets or some from a third party website such as the famous
80 <a href="http://twitter.com/about/resources/widgets">
81 Twitter Widget</a> as seen on the SliTaz main website.
82 </p>
83 <p>
84 Bookmarks can be handled by TazWeb and you can easily add a bookmark to
85 your home page with the right click menu item: <i>"Add a bookmark"</i>. To function
86 TazWeb uses markup in your home.html document; this markup should not
87 be removed if you want bookmarking to work since each new item will be
88 added just before the line: <i><!-- end:bookmarks --></i>
89 </p>
90 <p>
91 Note: You will find the default home.html in: /usr/share/tazweb and
92 can get an original copy with the following commands in a terminal:
93 </p>
94 <pre>
95 $ cp -r /usr/share/tazweb $HOME/.config/tazweb
96 </pre>
98 <h3>Start page and url in argument</h3>
100 <p>
101 The default start page has been defined in the source code and can't be
102 changed and is the default SliTaz WebHome, but TazWeb accepts an URL as
103 a first argument, you can for example execute:
104 </p>
105 <pre>
106 $ tazweb <a href="http://www.slitaz.org/">http://www.slitaz.org/</a>
107 </pre>
108 <p>
109 In this way you can for example create your own and custom home page in
110 a pretty xHTML document and start tazweb with a standard desktop file or
111 from the command line: tazweb file://$HOME/.config/tazweb/home.html.
112 </p>
113 <p>
114 If you want a custom start page for your Live system or all system users,
115 you can create your own slitaz-configs package or edit the xHTML file
116 located in /usr/share/webhome/index.html. If you modify it, make sure
117 to block slitaz-configs or make a backup because it will be overwritten
118 with a slitaz-configs package update.
119 </p>
120 <p>
121 When you start TazWeb from the cmdline with an URL in the argument, you dont
122 have to put http:// since TazWeb will transform URLs for you.
123 </p>
125 <h3>URL and search entry</h3>
126 <p>
127 The URL entry in the toolbar lets you enter a website address and shows
128 the current website location. You can use selection, copy and paste in
129 the URL entry and don't have to put http:// before a location, Tazweb
130 will transform URLs for you. To activate a new URL you must press
131 ENTER.
132 </p>
133 <p>
134 The search entry lets you search the web at anytime using Google. Just
135 enter your query and press ENTER or click on the entry icon to validate
136 your request.
137 </p>
139 <h3>Web applications</h3>
140 <p>
141 TazWeb browser is perfect to launch web applications via a simple
142 desktop file. Once created with a simple text editor, the desktop
143 file can stand on the desktop with a nice icon or in the standard
144 SliTaz menu. Example of a web application launcher that you could
145 name scn.desktop:
146 </p>
147 <pre>
148 [Desktop Entry]
149 Type=Application
150 Name=SliTaz SCN
151 Icon=slitaz-menu
152 Exec=tazweb http://scn.slitaz.org/
153 </pre>
155 <h3>Bugs and development</h3>
156 <p>
157 TazWeb is an open-source project under a BSD license and all resources are
158 provided by SliTaz GNU/Linux, we use a Mercurial repository for code
159 management, discussion and support is done through the SliTaz community
160 <a href="http://forum.slitaz.org/">forum</a>. If you're missing any features in
161 TazWeb or find any bugs ? Please post an issue on our Roundup bug tracker
162 at: <a href="http://bugs.slitaz.org/">bugs.slitaz.org</a>
163 </p>
164 <p>
165 If you want to help and get involved in development, you can start by cloning the
166 TazWeb repository and then submit your patch, improved documentation or artwork
167 to the SliTaz mailing list or on the <a href="http://scn.slitaz.org/">SCN</a>. To
168 clone or browse the TazWeb Hg repository:
169 </p>
170 <pre>
171 $ hg clone <a href="http://hg.slitaz.org/tazweb">http://hg.slitaz.org/tazweb</a>
172 </pre>
174 <!-- End content -->
175 </div>
177 <div id="footer">
178 Copyright (C) 2014 TazWeb contributors
179 </div>
181 </body>
182 </html>