tazpanel view README @ rev 34

Forgot hg add for doc/ and fix some things
author Christophe Lincoln <pankso@slitaz.org>
date Tue Apr 05 06:18:39 2011 +0200 (2011-04-05)
parents 1d93d0dcddb1
children 251c2c53c38d
line source
1 SliTaz Web Control Panel
2 ================================================================================
5 Tazpanel is the SliTaz Control Panel, a web interface who let you manage the
6 full system in a redically simple way. The output xHTML code is valid xHTML 5
7 and all theming is done with standard CSS 3.
10 i18n
11 ----
12 TazPanel have been coded from the beginning with gettext support. Please
13 forget 'echo' and use gettext, but remember that gettext "" is equivalent
14 to echo -n. Each script have it own TEXTDOMAIN and pot files as well, all
15 translations goes in the po/ folder. To start a new translation please
16 use msginit from the pot file directory. Example for French/France
17 locale (fr_FR):
19 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
21 To update all translations from a newly updated the pot file:
23 $ make msgmerge
26 User interface
27 --------------
28 If you develope an official SliTaz GUI for TazPanel, please follow the style.
29 If you need more CSS markup and you not a coder, please ask an official
30 developer the better way to implement your idea. TazPanel is fully themable
31 and more than one theme can be installed, this will let us make packages
32 for TazPanel style! All the GUI is done with xHTML 5 and CSS 3, some
33 javascript can be used, but with precaution... one more time, it's better
34 to check with a main contributor before adding to much stuff, the goal is,
35 as for the all SliTaz project: KISS
38 CGI template and files
39 ----------------------
40 To start or test new function with TazPanel you will find a a file in
41 utils/template.cgi that need to be in the $PANEL root to work, all TazPanel
42 CGI scripts are in that location. If you think your code is too big to fit
43 in an other script you can eventually creat a new CGI page and update all
44 links, but please to talk to the AUTHORS before.
46 * index.cgi Main Tazpanel CGI script (some stuff may be splited
47 into users.cgi, boot.cgi, etc if too big or slow)
48 * pkgs.cgi Tazpkg packages CGI interface
49 * live.cgi All tools related to Live systems (CD, USB, Frugal)
52 Web server
53 ----------
54 Tazpanel can run with Busybox httpd applet or LightTPD an propably Apache.
55 Start the webserver with custom config to listen only on local port for
56 security reason since we run as root to perform system actions, example:
58 # httpd -p 8080 u root -c /etc/slitaz/tazpanel-httpd.conf
60 Or use tazpanel cmdline:
62 # ./tazpanel start
65 Quick notes
66 -----------
68 Panel password is defined in httpd.conf
69 When cat is used: `gettext "Text to translate"`
70 Devel can run the web server with root in the src tree