tazweb annotate doc/tazweb.en.html @ rev 144

Tiny edits
author Paul Issott <paul@slitaz.org>
date Sat Apr 05 20:15:13 2014 +0100 (2014-04-05)
parents b499c4de5634
children f9c2b5aeacbd
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
paul@144 40 user interface. The content is powered by CGI scripts and the preferred
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>
paul@131 55 TazWeb provides a Kiosk mode useful for computers in public areas. The
pankso@130 56 Kiosk mode will start TazWeb in fullscreen. It will not allow users to
paul@131 57 bookmark a page, download anything or open a 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@141 63 <h3>Home Page and bookmarks</h3>
pankso@36 64 <p>
paul@144 65 TazWeb handles a home page located in your system wide standard
paul@144 66 configuration directory, the path is: /usr/share/webhome.
pankso@36 67 </p>
pankso@36 68 <p>
pankso@141 69 The bookmark.txt file is a simple text document with, by default, a
pankso@141 70 list of links. You can edit this file with you favorite editor
paul@144 71 and add bookmark entries or use the Tazweb right click menu. At first
pankso@141 72 start TazWeb will create and copy your personal bookmarks file to
pankso@141 73 your config directory.
pankso@39 74 </p>
pankso@39 75 <p>
pankso@93 76 Bookmarks can be handled by TazWeb and you can easily add a bookmark to
pankso@141 77 your home page with the right click menu item: <i>"Add a bookmark"</i>.
paul@144 78 Tazweb also lets you manage your bookmarks via a nifty CGI web interface.
pankso@93 79 </p>
pankso@93 80 <p>
paul@144 81 Note: You will find the default bookmarks.txt in: /usr/share/tazweb or
paul@144 82 you can get an original copy with the following command in a terminal:
pankso@36 83 </p>
pankso@36 84 <pre>
pankso@141 85 $ cp -f /usr/share/tazweb/bookmarks.html $HOME/.config/tazweb
pankso@36 86 </pre>
pankso@36 87
pankso@78 88 <h3>Start page and url in argument</h3>
pankso@3 89
pankso@3 90 <p>
paul@31 91 The default start page has been defined in the source code and can't be
pankso@93 92 changed and is the default SliTaz WebHome, but TazWeb accepts an URL as
pankso@93 93 a first argument, you can for example execute:
pankso@93 94 </p>
pankso@93 95 <pre>
pankso@93 96 $ tazweb <a href="http://www.slitaz.org/">http://www.slitaz.org/</a>
pankso@93 97 </pre>
pankso@93 98 <p>
pankso@93 99 In this way you can for example create your own and custom home page in
pankso@93 100 a pretty xHTML document and start tazweb with a standard desktop file or
pankso@93 101 from the command line: tazweb file://$HOME/.config/tazweb/home.html.
pankso@3 102 </p>
pankso@3 103 <p>
pankso@78 104 If you want a custom start page for your Live system or all system users,
pankso@3 105 you can create your own slitaz-configs package or edit the xHTML file
pankso@3 106 located in /usr/share/webhome/index.html. If you modify it, make sure
paul@31 107 to block slitaz-configs or make a backup because it will be overwritten
pankso@3 108 with a slitaz-configs package update.
pankso@3 109 </p>
pankso@93 110 <p>
paul@144 111 When you start TazWeb from the cmdline with an URL in the argument you don’t
paul@94 112 have to put http:// since TazWeb will transform URLs for you.
pankso@93 113 </p>
pankso@93 114
pankso@93 115 <h3>URL and search entry</h3>
pankso@93 116 <p>
paul@94 117 The URL entry in the toolbar lets you enter a website address and shows
pankso@93 118 the current website location. You can use selection, copy and paste in
paul@94 119 the URL entry and don't have to put http:// before a location, Tazweb
paul@94 120 will transform URLs for you. To activate a new URL you must press
pankso@93 121 ENTER.
pankso@93 122 </p>
pankso@93 123 <p>
paul@94 124 The search entry lets you search the web at anytime using Google. Just
paul@94 125 enter your query and press ENTER or click on the entry icon to validate
pankso@93 126 your request.
pankso@93 127 </p>
pankso@3 128
pankso@3 129 <h3>Web applications</h3>
pankso@3 130 <p>
pankso@3 131 TazWeb browser is perfect to launch web applications via a simple
pankso@3 132 desktop file. Once created with a simple text editor, the desktop
pankso@3 133 file can stand on the desktop with a nice icon or in the standard
pankso@36 134 SliTaz menu. Example of a web application launcher that you could
pankso@36 135 name scn.desktop:
pankso@3 136 </p>
pankso@3 137 <pre>
pankso@3 138 [Desktop Entry]
pankso@3 139 Type=Application
pankso@3 140 Name=SliTaz SCN
pankso@3 141 Icon=slitaz-menu
pankso@3 142 Exec=tazweb http://scn.slitaz.org/
pankso@3 143 </pre>
pankso@3 144
pankso@93 145 <h3>Bugs and development</h3>
pankso@93 146 <p>
paul@94 147 TazWeb is an open-source project under a BSD license and all resources are
pankso@93 148 provided by SliTaz GNU/Linux, we use a Mercurial repository for code
paul@94 149 management, discussion and support is done through the SliTaz community
paul@94 150 <a href="http://forum.slitaz.org/">forum</a>. If you're missing any features in
paul@94 151 TazWeb or find any bugs ? Please post an issue on our Roundup bug tracker
pankso@93 152 at: <a href="http://bugs.slitaz.org/">bugs.slitaz.org</a>
pankso@93 153 </p>
pankso@93 154 <p>
paul@94 155 If you want to help and get involved in development, you can start by cloning the
paul@94 156 TazWeb repository and then submit your patch, improved documentation or artwork
paul@94 157 to the SliTaz mailing list or on the <a href="http://scn.slitaz.org/">SCN</a>. To
paul@94 158 clone or browse the TazWeb Hg repository:
pankso@93 159 </p>
pankso@93 160 <pre>
pankso@93 161 $ hg clone <a href="http://hg.slitaz.org/tazweb">http://hg.slitaz.org/tazweb</a>
pankso@93 162 </pre>
pankso@93 163
pankso@3 164 <!-- End content -->
pankso@3 165 </div>
pankso@3 166
pankso@3 167 <div id="footer">
pascal@132 168 Copyright &copy; <span class="year"></span> TazWeb contributors
pankso@3 169 </div>
pankso@3 170
pankso@3 171 </body>
pankso@3 172 </html>
pankso@3 173