tazpanel annotate README @ rev 40

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