slitaz-dev-tools: 6f82a9600893 tazyad/README

slitaz-dev-tools view tazyad/README @ rev 265

Tiny edits

line source

1 Yad on SliTaz

2 ================================================================================

5 Yad is the new preferred way to create GUI boxes for the SliTaz desktop. We use

6 Yad GTK boxes for all user and administrator interfaces that can't be handled

7 by TazPanel (admin panel) or TazDE (desktop environment). Both are powered

8 by CGI scripts and use xHTML 5 and CSS 3 for the UI. Yad is a powerful tool

9 which supports the latest GTK actions and goodies. With our original GTKdialog

10 scripts some nice features were missing like for example --notification or

11 ENTER for event (with gtkdialog one must press a button).

13 If you're motivated to code, please have a look at the TODO file and continue

14 reading :-)

17 Coding guidelines

18 ----------------

19 Use a function and a function_main for main= variable to keep data,

20 that way we can have yad boxes commands separated from shell scripts.

21 Here is a structure example:

23 # function_main

24 # function_other

25 # function

27 Use gettext to have a translated application and forget echo. Use 'case'

28 as much as possible, it is the faster way to handle or parse commands

29 and options. Use fgrep when possible.

31 To start you will find a template script called tazyad, copy it and start

32 coding from that :-). Tazyad is commented to help you get started.

33 You can also have a look to tazpkg-notify which was the first official Yad

34 script for SliTaz.

37 Missing stuff

38 -------------

39 I'm a member of Yad Google group and will mail them about SliTaz using Yad

40 and these missing features. Yad is a small project but the maintainer seems

41 a very nice guy who listens to his users :-)

43 * It would be nice to have an --exit or --kill option for notification

44 * No way to have a custom icon for custom button

47 ================================================================================