Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
projects:panel-plugins:xfce4-genmon-plugin [2011/03/22 13:57] – frivoalprojects:panel-plugins:xfce4-genmon-plugin [2017/10/29 19:49] (current) – Added new release info toz
Line 7: Line 7:
  
 ===== Usage ===== ===== Usage =====
-If you want the plugin to display only text (original version), enter the command in the //Command// field of the //Property// section of the plugin.+If you want the plugin to display only text (original version), enter the command in the //Command// field of the //Properties// section of the plugin.
  
-If you want the plugin to display personalized ''Image'' or ''Tooltip'' or ''Bar'' or ''Button'' (new version), you should develop (or get) a script returning a XML string, and enter the path of this script in the //Command// field of the //Property// section of the plugin.+**XML Tags** 
 + 
 +If you want the plugin to display a personalized ''Image'' or ''Tooltip'' or ''Bar'' or ''Button'', you should develop (or get) a script returning a XML string, and enter the path of this script in the //Command// field of the //Property// section of the plugin.
  
 The XML tags which can be used: The XML tags which can be used:
Line 17: Line 19:
   * ''<bar>Pourcentage to display in the bar</bar>''   * ''<bar>Pourcentage to display in the bar</bar>''
   * ''<click>The command to be executed when clicking on the image</click>''   * ''<click>The command to be executed when clicking on the image</click>''
 +  * ''<txtclick>The command to be executed when clicking on the text</txtclick>''
  
 If None of the tags are detected in the result of the command, the plugin returns to its original behaviour (displaying the result of the command). If None of the tags are detected in the result of the command, the plugin returns to its original behaviour (displaying the result of the command).
 +
 +**Example Script**
  
 Here's a simple example of a plugin displaying the Temp of the CPU in the panel Here's a simple example of a plugin displaying the Temp of the CPU in the panel
Line 37: Line 42:
  
 PS: Depending on your configuration, you should change the image path. PS: Depending on your configuration, you should change the image path.
 +
 +More scripts are available at: [[http://git.xfce.org/panel-plugins/xfce4-genmon-plugin/tree/scripts]].
 +
 +**Pango Markups in the <txt> tag**
 +
 +Both the <txt> and <tool> tags support Pango Markups. See: [[https://developer.gnome.org/pango/stable/PangoMarkupFormat.html]]. With Pango markups, you can change text attributes like font colour, weight, size, etc, in your output string. To do so, use the <span></span> tag within the <txt></txt> or <tool></tool> tags. For example, to display the output in bold red, you could use something like:
 +
 +  echo "<txt><span weight='Bold' fgcolor='Red'>Test</span></txt>"
 +
 +Refer to the previous link for information on all of the properties that can be set.
 +
 +**Refreshing the plugin**
 +
 +The xfce4-genmon-plugin now supports xfce4-panel plugin-event functionality. Currently it only supports the "refresh" action which resets the timer and causes the associated command to execute again. You can use this command remotely or at the end of a script to force the panel plugin to refresh.
 +
 +To refresh the plugin, issue the command:
 +
 +  xfce4-panel --plugin-event=genmon-X:refresh:bool:true    
 +where "genmon-X" is the widget name of the particular genmon instance. To get this name, go to the panel properties screen and on the Items tab, hover your mouse over the genmon plugin to get it's internal name.
 +
 +
 +**Enhanced Gtk3 CSS Styling Capabilities**
 +
 +CSS styling capabilities have been enhanced by providing style classes for all elements of the plugin that can be styled via themes or individual overrides (~/.config/gtk-3.0/gtk.css). For more information, see: [[https://git.xfce.org/panel-plugins/xfce4-genmon-plugin/tree/CSS%20Styling.txt]].
 +
 +//**(*dev-only)**// functionality is currently only available in the git tree and has not yet been officially released
 +
 +
  
 ===== Screenshots ===== ===== Screenshots =====
Line 48: Line 81:
   - display the state of the 2 batteries of my laptop   - display the state of the 2 batteries of my laptop
   - display the WIFI quality   - display the WIFI quality
 +
 +
 +
 +{{:projects:panel-plugins:gmail.png|:projects:panel-plugins:gmail.png}}
 +
 +In this example, we see the gmail checker script in action:
 +  - plugin display shows icon indicating state of new emails available
 +  - tooltip shows number of new messages, sender/subject of new messages, and timestamp of last check
 +  - clicking on the icon launches your email program
 +
 +
 +
 +{{:projects:panel-plugins:sysstat.png|:projects:panel-plugins:sysstat.png}}
 +
 +In this example, we see the sysstat script in action:
 +  - plugin display shows optional icon and 3 readings (cpu, memory, hard drive usage)
 +  - tooltip shows top 5 cpu and memory uses and hard drive space usage
 +  - clicking on the text output launches xfce4-taskmanager (//ver. 3.99 or greater//)
 +
 +
 +
 +{{:projects:panel-plugins:googcal.png|:projects:panel-plugins:googcal.png}}
 +
 +In this example, we see the google calendar checker script in action:
 +  - plugin display shows icon indicating state of new upcoming appointments
 +  - tooltip shows a listing of upcoming appointments
 +  - clicking on the icon opens google calendar in your browser
 +
 +
 +
 +{{:projects:panel-plugins:twit0.png|:projects:panel-plugins:twit0.png}}
 +{{:projects:panel-plugins:twit1.png|:projects:panel-plugins:twit1.png}}
 +
 +In this example, we see the twit (Twitter Timeline Notifier) script in action:
 +  - plugin display shows icon indicating state of new tweets in your timeline
 +  - libnotify notifications will be sent with new tweets
 +  - tool tip will show new and optionally recent tweets
 +  - clicking on the plugin icon can either execute a program, display a yad dialog with all recent tweets (above image), or compose and send a tweet.
  
 Most of the scripts are available in the plugin archive. Most of the scripts are available in the plugin archive.
  
 ===== Recent Releases ===== ===== Recent Releases =====
-==== 3.3 (2011-03-21) ==== +==== 4.0.1 (2017/10/29) ==== 
-  * Support for xfce 4.8 +  * Allow pango markup in tooltip as well 
-  * Translated to 29 languages +  * Added some extra sample scripts (twit, google calendar, sysstat) 
-  * Introduces new markup for colored and styled text +  * Enhanced CSS styling capabilites (see 'CSS Styling.txt' doc) 
-  * Various small bug fixes +  * Fix progressbar wrong direction 
-  * Build and package fixes+ 
 +==== 4.0.0 (2017/02/25) ==== 
 +  * Fix PangoFontDescription not being able to display initial default string 
 + 
 +==== 3.99 (2016/11/02) ==== 
 +  * Port to Gtk3 
 +  * Fix font styling to work with Gtk 3.22 
 +  * Add support for "genmon" in 'xfce4-panel --plugin-event' (Bug #10734) 
 +  * Fix default tooltip does not work (bug #11284) 
 +  * Add <txtclick> functionality (Bug #3437) 
 + 
 +==== 3.4 (2012/05/12) ==== 
 +  * Port from libxfcegui4 to libxfce4ui 
 +  * Install as a shared library rather than an executable 
 +  * No longer uses troublesome fixed-length text buffers 
 +  * Bug fixes