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