SliTaz Repositories

     1.1 --- a/README	Sun Jul 01 08:46:05 2012 +0100
     1.2 +++ b/README	Mon Oct 09 17:15:22 2017 +0100
     1.3 @@ -2,84 +2,85 @@
     1.4  ================================================================================
     1.5  
     1.6  
     1.7 -Tazpanel is the SliTaz Control Panel, a web interface which lets you manage the
     1.8 -full system in a radically simple way. The output xHTML code is valid xHTML 5
     1.9 -and all theming is done with standard CSS 3. TazPanel is published under a
    1.10 -BSD License.
    1.11 +Tazpanel is the SliTaz Control Panel, a web interface  which lets you manage the
    1.12 +full system  in a radically simple way. The output  xHTML code is valid  xHTML 5
    1.13 +and  all  theming  is done  with standard  CSS 3.  TazPanel  is  published under
    1.14 +a BSD License.
    1.15  
    1.16  
    1.17  Use it!
    1.18 -------
    1.19 -You can clone the tazpanel repo into /var/www/tazpanel and work on this
    1.20 -copy or clone it somewhere else and 'make install'. After, add tazpanel to
    1.21 -your /etc/hosts, type './tazpanel start' to start the server and go to the
    1.22 -URL: http://tazpanel:82. Panel user and password are defined in the 
    1.23 -httpd.conf and default is root:root
    1.24 +-------
    1.25 +You can clone the tazpanel repo into  /var/www/tazpanel and work on this copy or
    1.26 +clone  it  somewhere  else  and  'make install'.  After,  add  tazpanel  to your
    1.27 +/etc/hosts,  type './tazpanel start'  to start  the server  and  go to  the URL:
    1.28 +http://tazpanel:82.  Panel user  and password are defined  in the httpd.conf and
    1.29 +default is root:root
    1.30  
    1.31  
    1.32  i18n
    1.33  ----
    1.34 -TazPanel has been coded from the beginning with gettext support. Please
    1.35 -forget 'echo' and use gettext, but remember that gettext "" is equivalent
    1.36 -to echo -n. All scripts use the same TEXTDOMAIN and the same pot files, and 
    1.37 -all translations go in the po/ folder. To start a new translation please
    1.38 -use msginit from the pot file directory. Example for French/France
    1.39 -locale (fr_FR):
    1.40 +TazPanel has been coded  from the beginning  with gettext support. Please forget
    1.41 +'echo' and use gettext, but remember that  gettext "" is equivalent  to echo -n.
    1.42 +All scripts use the same TEXTDOMAIN and the same pot files, and all translations
    1.43 +go in the po/ folder. To start a new translation please use msginit from the pot
    1.44 +file directory. Example for French/France locale (fr_FR):
    1.45  
    1.46 -	$ msginit -l fr_FR -o fr.po -i tazpanel.pot
    1.47 +    $ msginit -l fr_FR -o fr.po -i tazpanel.pot
    1.48  
    1.49  To update all translations from a newly updated pot file:
    1.50  
    1.51 -	$ make msgmerge
    1.52 +    $ make msgmerge
    1.53  
    1.54  
    1.55  User interface
    1.56  --------------
    1.57 -If you develop an official SliTaz GUI for TazPanel, please follow the default 
    1.58 -style. If you need more CSS markup and you are not a coder, please ask an 
    1.59 -official developer for the best way to implement your idea. TazPanel is fully 
    1.60 -themable and more than one theme can be installed, this will allow us to make 
    1.61 -packages in a TazPanel style! All the GUI is done with xHTML 5 and CSS 3; some
    1.62 -javascript can be used, but with precautions... one more time, it's better
    1.63 -to check with a main contributor before adding too much stuff; the goal is,
    1.64 -as for all the SliTaz projects: KISS
    1.65 +If you develop  an official SliTaz GUI  for TazPanel, please follow  the default
    1.66 +style. If you need  more CSS markup and you are not a coder, please ask an offi-
    1.67 +cial developer for the best way to implement your idea. TazPanel is fully thema-
    1.68 +ble and more than one  theme can be installed, this will allow us to make packa-
    1.69 +ges in a TazPanel style!  All the GUI is done with xHTML 5 and CSS 3; some java-
    1.70 +script can be used, but with precautions...  one more time, it's better to check
    1.71 +with a  main contributor before adding  too much stuff;  the goal is, as for all
    1.72 +the SliTaz projects: KISS
    1.73  
    1.74  
    1.75  CGI template and files
    1.76  ----------------------
    1.77 -To start or test a new function with TazPanel you will find a file in
    1.78 -utils/template.cgi that needs to be in the $PANEL root to work, all TazPanel
    1.79 -CGI scripts are in that location. If you think your code is too big to fit
    1.80 -in another script you can eventually create a new CGI page and update all
    1.81 -links, but please to talk to the AUTHORS beforehand.
    1.82 +To  start  or  test  a new  function  with  TazPanel  you will  find  a file  in
    1.83 +utils/template.cgi that needs to be in the $PANEL root to work, all TazPanel CGI
    1.84 +scripts are in that location.  If you think your code is too big  to fit in ano-
    1.85 +ther script you can  eventually create a new CGI page  and update all links, but
    1.86 +please to talk to the AUTHORS beforehand.
    1.87  
    1.88 -	* index.cgi     Main Tazpanel CGI script
    1.89 -	* boot.cgi      All what happens before login
    1.90 -	* network.cgi   All related stuff to networking (eth, wifi, services)
    1.91 -	* pkgs.cgi      Tazpkg packages CGI interface
    1.92 -	* settings.cgi  System settings and services such as time, users
    1.93 -	                accounts, locales or daemons management
    1.94 -	* live.cgi      All tools related to Live systems (CD, USB, Frugal)
    1.95 -	* hardware.cgi  Devices drivers, firmware, printing
    1.96 -	* help.cgi      Cat the html doc and this README file
    1.97 +    * index.cgi     Main TazPanel CGI script
    1.98 +    * boot.cgi      All what happens before login
    1.99 +    * network.cgi   All related stuff to networking (Ethernet, Wi-Fi, services)
   1.100 +    * pkgs.cgi      TazPkg packages CGI interface
   1.101 +    * settings.cgi  System settings and services such as time, users accounts,
   1.102 +                    locales or daemons management
   1.103 +    * live.cgi      All tools related to Live systems (CD, USB, Frugal)
   1.104 +    * hardware.cgi  Devices drivers, firmware, printing
   1.105 +    * help.cgi      Cat the html doc and this README file
   1.106  
   1.107 -For common functions have a look at lib/libtazpanel, where you may find functions
   1.108 -you need already coded such as a xhtml_header to get the style header.html
   1.109 -in your CGI script. For the loading message you can use loading_msg. When
   1.110 -cat is used: `gettext "Text to translate"`
   1.111 +For common functions have a look at  lib/libtazpanel, where you may find functi-
   1.112 +ons you need already coded  such as a xhtml_header  to get the style header.html
   1.113 +in your CGI script. For the loading message you can use loading_msg. When cat is
   1.114 +used:
   1.115 +
   1.116 +    $(gettext "Text to translate")
   1.117  
   1.118  
   1.119  Web server
   1.120  ----------
   1.121 -Tazpanel can run with the Busybox httpd applet or LightTPD and probably Apache.
   1.122 -Start the webserver with a custom config to listen only on a local port for
   1.123 +Tazpanel can run  with the Busybox httpd applet or LightTPD and probably Apache.
   1.124 +Start the webserver  with a custom  config  to listen only  on a local  port for
   1.125  security reasons since we run as root to perform system actions, example:
   1.126  
   1.127 -# httpd -p 82 u root -c /etc/slitaz/httpd.conf
   1.128 +    # httpd -p 82 u root -c /etc/slitaz/httpd.conf
   1.129  
   1.130  Or use a tazpanel cmdline:
   1.131  
   1.132 -# ./tazpanel start
   1.133 +    # ./tazpanel start
   1.134  
   1.135  
   1.136  ================================================================================