Difference between revisions of "Plugin"

From TV-Browser Wiki
Jump to: navigation, search
(Installation of Plugins)
 
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
Plugins are program modules which extend the basic functionality of TV-Browser.<p>
 
Plugins are program modules which extend the basic functionality of TV-Browser.<p>
 
A concept behind TV-Browser is that its program kernel remains small and slim. The kernel is just responsible for maintaining and displaying tv-data, as well as maintaining plugins and user settings. This ensures that the kernel program remains stable. Using plugins, the user can activate exactly the desired functions. Moreover plugins allow users to add new functionality.
 
A concept behind TV-Browser is that its program kernel remains small and slim. The kernel is just responsible for maintaining and displaying tv-data, as well as maintaining plugins and user settings. This ensures that the kernel program remains stable. Using plugins, the user can activate exactly the desired functions. Moreover plugins allow users to add new functionality.
 +
 +
 +
There are two kinds of plugins:
 +
* "normal" plugin
 +
* TV-Data Services
 +
 +
The [[For Developers|developers area]] explains how to create your own plugins.
  
 
<h1>"Normal" Plugins</h1>
 
<h1>"Normal" Plugins</h1>
 
A so-called "normal" plugin extends TV-Browser by functionality which is related to tv-data. This might for instance be a service reminding the user if a certain show starts.
 
A so-called "normal" plugin extends TV-Browser by functionality which is related to tv-data. This might for instance be a service reminding the user if a certain show starts.
  
<h1>TV-Data Services/h1>
+
<h1>TV-Data Services</h1>
TV-data services supply TV-Browser with data.  
+
TV-data services supply TV-Browser with data. Every [[Update TV listings |update of the TV listings]] makes the TV-Data services download  the new data.
...
+
 
 +
TV-Browsers own TV-Data service can get listings of any number of servers that provide them in our format. How you can provide such a service yourself is explained in the [http://www.tvbrowser.org/index.php?page=providetvlistings TV-Data tutorial].
 +
 
 +
This mechanism can in fact be used to provide all sorts of data from any source and in any format.
 +
 
 +
==Installation of Plugins==
 +
 
 +
To install plugins you can use the button ''Plugins->Manage Plugins->Update/Install plugins''.
 +
 
 +
Plugins downloaded from other sources (e.g., from the [http://www.tvbrowser.org/plugins.php plugin page]) as a *.jar file can simply be dropped with the mouse into the TV-Browser window, or can alternatively be copied into the ''plugins'' directory. In Mac OS this is the ''/Library/Application Support/TV-Browser/plugins'' directory.
 +
 
 +
Finally,you have to restart TV-Browser, [[Settings:Plugins| activate]] and possibly configure the plugin.
 +
 
 +
Data plugins can be found in [[Settings:TVDataServices| Settings - TVDataServices]].
 +
 
 +
* Note for Mac OS X Users: the ''plugins'' directory is in ''Volume/Library/Application Support/TV-Browser/plugins''.
 +
 
 +
<!-- This section needs tidying -->
 +
 
 +
= Features and Plugins =
 +
 
 +
Most features of TV-Browser are realized as a [[Plugin]].
 +
 
 +
# [[Blog this!]] - Simply do a Blog entry by one mouse click.
 +
# [[Capture Plugin]] - Enables TV-Browser to control external applications or devices e.g. for recording.
 +
# [[Send e-mail]] - Send program info via e-mail.
 +
# [[Reminder]] - To remind on a program, you want to see.
 +
# [[Growl]] - Growl-Plugin
 +
# [[View List]] - Displays the available program data in a list.
 +
# [[Favorite programs]] - Manages your favorite programs.
 +
# [[Calendar Export]] - Exports programs to a scheduler such as "Outlook".
 +
# [[News]] - TV-Browser news.
 +
# [[Print program]] - Prints the TV program.
 +
# [[Program information]] - Shows detailed information about one program.
 +
# [[Search]] - Search for programs.
 +
# [[Showview number calculator]] - To generate the "Showview" numbers.
 +
# [[TV Rater]] - To rate broadcasts and to see reviews from other users.
 +
# [[WebPlugin]] - Hand over broadcastings to web pages (e.g. for searching by [http://www.google.com "Google"])
 +
# [[Clipboard]] - To collect broadcasts and forwards cluster to plugins.
 +
 
 +
 
 +
Descriptions of further functions and Plugins you will find [[Functions|in this overview]].
 +
 
 +
[[de:Plugin]]
 +
 
 +
[[category:Plugin]]

Latest revision as of 22:40, 25 October 2012

Plugins are program modules which extend the basic functionality of TV-Browser.

A concept behind TV-Browser is that its program kernel remains small and slim. The kernel is just responsible for maintaining and displaying tv-data, as well as maintaining plugins and user settings. This ensures that the kernel program remains stable. Using plugins, the user can activate exactly the desired functions. Moreover plugins allow users to add new functionality. There are two kinds of plugins:

  • "normal" plugin
  • TV-Data Services
The developers area explains how to create your own plugins.

"Normal" Plugins

A so-called "normal" plugin extends TV-Browser by functionality which is related to tv-data. This might for instance be a service reminding the user if a certain show starts.

TV-Data Services

TV-data services supply TV-Browser with data. Every update of the TV listings makes the TV-Data services download the new data.

TV-Browsers own TV-Data service can get listings of any number of servers that provide them in our format. How you can provide such a service yourself is explained in the TV-Data tutorial.

This mechanism can in fact be used to provide all sorts of data from any source and in any format.

Installation of Plugins

To install plugins you can use the button Plugins->Manage Plugins->Update/Install plugins.

Plugins downloaded from other sources (e.g., from the plugin page) as a *.jar file can simply be dropped with the mouse into the TV-Browser window, or can alternatively be copied into the plugins directory. In Mac OS this is the /Library/Application Support/TV-Browser/plugins directory.

Finally,you have to restart TV-Browser, activate and possibly configure the plugin.

Data plugins can be found in Settings - TVDataServices.

  • Note for Mac OS X Users: the plugins directory is in Volume/Library/Application Support/TV-Browser/plugins.


Features and Plugins

Most features of TV-Browser are realized as a Plugin.

  1. Blog this! - Simply do a Blog entry by one mouse click.
  2. Capture Plugin - Enables TV-Browser to control external applications or devices e.g. for recording.
  3. Send e-mail - Send program info via e-mail.
  4. Reminder - To remind on a program, you want to see.
  5. Growl - Growl-Plugin
  6. View List - Displays the available program data in a list.
  7. Favorite programs - Manages your favorite programs.
  8. Calendar Export - Exports programs to a scheduler such as "Outlook".
  9. News - TV-Browser news.
  10. Print program - Prints the TV program.
  11. Program information - Shows detailed information about one program.
  12. Search - Search for programs.
  13. Showview number calculator - To generate the "Showview" numbers.
  14. TV Rater - To rate broadcasts and to see reviews from other users.
  15. WebPlugin - Hand over broadcastings to web pages (e.g. for searching by "Google")
  16. Clipboard - To collect broadcasts and forwards cluster to plugins.


Descriptions of further functions and Plugins you will find in this overview.