tazpanel annotate README @ rev 617

revision of german messages
author Hans-G?nter Theisgen
date Mon Oct 09 17:15:22 2017 +0100 (2017-10-09)
parents 831e551d12d4
children
rev   line source
pankso@0 1 SliTaz Web Control Panel
pankso@0 2 ================================================================================
pankso@0 3
pankso@0 4
al@419 5 Tazpanel is the SliTaz Control Panel, a web interface which lets you manage the
al@419 6 full system in a radically simple way. The output xHTML code is valid xHTML 5
al@419 7 and all theming is done with standard CSS 3. TazPanel is published under
al@419 8 a BSD License.
pankso@0 9
pankso@0 10
pankso@44 11 Use it!
al@419 12 -------
al@419 13 You can clone the tazpanel repo into /var/www/tazpanel and work on this copy or
al@419 14 clone it somewhere else and 'make install'. After, add tazpanel to your
al@419 15 /etc/hosts, type './tazpanel start' to start the server and go to the URL:
al@419 16 http://tazpanel:82. Panel user and password are defined in the httpd.conf and
al@419 17 default is root:root
pankso@44 18
pankso@44 19
pankso@19 20 i18n
pankso@19 21 ----
al@419 22 TazPanel has been coded from the beginning with gettext support. Please forget
al@419 23 'echo' and use gettext, but remember that gettext "" is equivalent to echo -n.
al@419 24 All scripts use the same TEXTDOMAIN and the same pot files, and all translations
al@419 25 go in the po/ folder. To start a new translation please use msginit from the pot
al@419 26 file directory. Example for French/France locale (fr_FR):
pankso@27 27
al@419 28 $ msginit -l fr_FR -o fr.po -i tazpanel.pot
pankso@27 29
paul@82 30 To update all translations from a newly updated pot file:
pankso@27 31
al@419 32 $ make msgmerge
pankso@19 33
pankso@19 34
pankso@19 35 User interface
pankso@19 36 --------------
al@419 37 If you develop an official SliTaz GUI for TazPanel, please follow the default
al@419 38 style. If you need more CSS markup and you are not a coder, please ask an offi-
al@419 39 cial developer for the best way to implement your idea. TazPanel is fully thema-
al@419 40 ble and more than one theme can be installed, this will allow us to make packa-
al@419 41 ges in a TazPanel style! All the GUI is done with xHTML 5 and CSS 3; some java-
al@419 42 script can be used, but with precautions... one more time, it's better to check
al@419 43 with a main contributor before adding too much stuff; the goal is, as for all
al@419 44 the SliTaz projects: KISS
pankso@19 45
pankso@19 46
pankso@19 47 CGI template and files
pankso@19 48 ----------------------
al@419 49 To start or test a new function with TazPanel you will find a file in
al@419 50 utils/template.cgi that needs to be in the $PANEL root to work, all TazPanel CGI
al@419 51 scripts are in that location. If you think your code is too big to fit in ano-
al@419 52 ther script you can eventually create a new CGI page and update all links, but
al@419 53 please to talk to the AUTHORS beforehand.
pankso@19 54
al@419 55 * index.cgi Main TazPanel CGI script
al@419 56 * boot.cgi All what happens before login
al@419 57 * network.cgi All related stuff to networking (Ethernet, Wi-Fi, services)
al@419 58 * pkgs.cgi TazPkg packages CGI interface
al@419 59 * settings.cgi System settings and services such as time, users accounts,
al@419 60 locales or daemons management
al@419 61 * live.cgi All tools related to Live systems (CD, USB, Frugal)
al@419 62 * hardware.cgi Devices drivers, firmware, printing
al@419 63 * help.cgi Cat the html doc and this README file
pankso@44 64
al@419 65 For common functions have a look at lib/libtazpanel, where you may find functi-
al@419 66 ons you need already coded such as a xhtml_header to get the style header.html
al@419 67 in your CGI script. For the loading message you can use loading_msg. When cat is
al@419 68 used:
al@419 69
al@419 70 $(gettext "Text to translate")
pankso@46 71
pankso@19 72
pankso@0 73 Web server
pankso@0 74 ----------
al@419 75 Tazpanel can run with the Busybox httpd applet or LightTPD and probably Apache.
al@419 76 Start the webserver with a custom config to listen only on a local port for
paul@52 77 security reasons since we run as root to perform system actions, example:
pankso@0 78
al@419 79 # httpd -p 82 u root -c /etc/slitaz/httpd.conf
pankso@0 80
paul@204 81 Or use a tazpanel cmdline:
pankso@17 82
al@419 83 # ./tazpanel start
pankso@49 84
pankso@49 85
pankso@49 86 ================================================================================