tazweb view doc/tazweb.en.html @ rev 188

Docs: reformat html and use html5 tags, up css; Makefile: use gettext to translate .desktop file, up po files.
author Aleksej Bobylev <al.bobylev@gmail.com>
date Tue Mar 14 20:15:40 2017 +0200 (2017-03-14)
parents f9c2b5aeacbd
children 0a8ab376898d
line source
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8">
5 <title>TazWeb Documentation</title>
6 <link rel="stylesheet" href="style.css">
7 </head>
8 <body>
10 <header>
11 <h1>TazWeb Documentation</h1>
12 </header>
14 <main>
16 <h2>SliTaz Web Browser</h2>
18 <p>TazWeb is a radically simple and very light web browser providing a single window with a small
19 toolbar and a contextual menu, but without any menubar or tabs.
20 Navigation is done with a right click anywhere in the browser window or from the toolbar.
21 It can also handle bookmarks in a personal home page, provide a source view mode and zoom and
22 printing functions.
23 TazWeb lets you quickly search the web through a search entry and Google.
24 This documentation file is always accessible from the right-hand side of the toolbar.</p>
26 <p>The browser's fast, very fast and small, the binary is about 24 Kb and uses the Webkit engine
27 for page rendering and therefore supports all the latest web standards as well as Javascript and
28 Flash animations or videos.</p>
31 <h3>History</h3>
33 <p>The SliTaz Web Browser was created for the needs of TazPanel which is the SliTaz administration
34 and packages manager panel and made with the latest technologies such as HTML 5 and CSS 3 for the
35 graphical user interface.
36 The content is powered by CGI scripts and the preferred web server is Busybox httpd.</p>
39 <h3>Security and personal data</h3>
41 <p>TazWeb is a very secure browser and doesn't store any personal data, therefore no sessions,
42 cookies or history files are created.
43 So your websites settings will not be saved and you will have to enter login information each time
44 you restart the browser (by the way websites can track you with cookies!).</p>
47 <h3>Kiosk mode</h3>
49 <p>TazWeb provides a Kiosk mode useful for computers in public areas.
50 The Kiosk mode will start TazWeb in fullscreen.
51 It will not allow users to bookmark a page, download anything or open a URL in a new window.</p>
53 <pre>
54 $ tazweb --kiosk
55 </pre>
58 <h3>Home Page and bookmarks</h3>
60 <p>TazWeb handles a home page located in your system wide standard configuration directory, the
61 path is: /usr/share/webhome.</p>
63 <p>The bookmark.txt file is a simple text document with, by default, a list of links.
64 You can edit this file with you favorite editor and add bookmark entries or use the Tazweb right
65 click menu.
66 At first start TazWeb will create and copy your personal bookmarks file to your config
67 directory.</p>
69 <p>Bookmarks can be handled by TazWeb and you can easily add a bookmark to your home page with the
70 right click menu item: <i>“Add a bookmark”</i>.
71 Tazweb also lets you manage your bookmarks via a nifty CGI web interface.</p>
73 <p>Note: You will find the default bookmarks.txt in: /usr/share/tazweb or you can get an original
74 copy with the following command in a terminal:</p>
76 <pre>
77 $ cp -f /usr/share/tazweb/bookmarks.html $HOME/.config/tazweb
78 </pre>
81 <h3>Start page and URL in argument</h3>
83 <p>The default start page has been defined in the source code and can't be changed and is the
84 default SliTaz WebHome but TazWeb accepts a URL as a first argument, you can for example
85 execute:</p>
87 <pre>
88 $ tazweb <a href="http://www.slitaz.org/">http://www.slitaz.org/</a>
89 </pre>
91 <p>In this way you can for example create your own and custom home page in a pretty HTML document
92 and start tazweb with a standard desktop file or from the command line:
93 tazweb file://$HOME/.config/tazweb/home.html.</p>
95 <p>If you want a custom start page for your Live system or all system users, you can create your
96 own slitaz-configs package or edit the HTML file located in /usr/share/webhome/index.html.
97 If you modify it, make sure to block slitaz-configs or make a backup because it will be overwritten
98 with a slitaz-configs package update.</p>
100 <p>When you start TazWeb from the cmdline with a URL in the argument you don’t have to put http://
101 since TazWeb will transform URLs for you.</p>
104 <h3>URL and search entry</h3>
106 <p>The URL entry in the toolbar lets you enter a website address and shows the current website
107 location.
108 You can use selection, copy and paste in the URL entry and don't have to put http:// before
109 a location, Tazweb will transform URLs for you.
110 To activate a new URL you must press ENTER.</p>
112 <p>The search entry lets you search the web at anytime using Google.
113 Just enter your query and press ENTER or click on the entry icon to validate your request.</p>
116 <h3>Web applications</h3>
118 <p>TazWeb browser is perfect to launch web applications via a simple desktop file.
119 Once created with a simple text editor, the desktop file can stand on the desktop with a nice icon
120 or in the standard SliTaz menu.
121 Example of a web application launcher that you could name scn.desktop:</p>
123 <pre>
124 [Desktop Entry]
125 Type=Application
126 Name=SliTaz SCN
127 Icon=slitaz-menu
128 Exec=tazweb http://scn.slitaz.org/
129 </pre>
132 <h3>Bugs and development</h3>
134 <p>TazWeb is an open-source project under a BSD license and all resources are provided by SliTaz
135 GNU/Linux, we use a Mercurial repository for code management, discussion and support is done
136 through the SliTaz community <a href="http://forum.slitaz.org/">forum</a>.
137 If you're missing any features in TazWeb or find any bugs, please post an issue on our bug tracker
138 at <a href="http://bugs.slitaz.org/">bugs.slitaz.org</a>.</p>
140 <p>If you want to help and get involved in development, you can start by cloning the TazWeb
141 repository and then submit your patch, improved documentation or artwork to the SliTaz mailing list
142 or on the <a href="http://scn.slitaz.org/">SCN</a>.
143 To clone or browse the TazWeb Hg repository:</p>
145 <pre>
146 $ hg clone <a href="http://hg.slitaz.org/tazweb">http://hg.slitaz.org/tazweb</a>
147 </pre>
149 </main>
151 <footer>
152 Copyright &copy; <span class="year"></span> TazWeb contributors
153 </footer>
155 </body>
156 </html>