[[PageOutline]]
= Shepherd =

Shepherd provides reliable, high-quality Australian TV guide data by employing a flock of independent data sources.

=== Background ===
Australians have traditionally had two options for acquiring TV guide data:
 1. Downloading pre-compiled data from a service like [http://www.icetv.com.au IceTV] or [http://www.oztivo.net/twiki/bin/view/TVGuide/WebHome OzTivo]
 1. Using a tv_grab_au script to read data from a web site like ninemsn.com.au

Each method has drawbacks. The quality of pre-compiled data varies, while tv_grab_au scripts tend to frequently break.
Shepherd aims to solve the traditional problems of tv_grab_au scripts:
 1. It employs multiple TV guide grabbers and data sources, switching between them as necessary when one fails
 1. It auto-updates, eliminating the need for users to manually address problems

=== Description / Features ===
Shepherd knows enough about the capabilities of each grabber in order to make intelligent judgments about which is most appropriate for any given situation, maximizing data quality while minimizing bandwidth usage. It analyses the XML output from each grabber to determine whether any further grabbers are required to obtain a full dataset of the required channels. It then employs postprocessor components to further refine the data: the [wiki:imdb_augment_data] postprocessor adds movie information from [http://www.imdb.com IMDb.com], tvdb_augment_data adds series/episode details from [http://thetvdb.com TheTVDB.com], [wiki:flag_aus_hdtv] marks shows that are available in High Definition, and more.

When switching between data sources, Shepherd's reconciler keeps show names consistent. For example, if you're used to recording a programme called ''"House"'' but a different data source names it ''"House, M.D."'', Shepherd remembers the original name and automatically substitutes it.

If you're a MythTV user, during installation Shepherd will help you choose appropriate guide data for each of your MythTV channels, and can even install MythTV [wiki:channel_icons channel icons] for you.

Shepherd is designed to be ''future proof'', never requiring manual intervention once installed and configured. It will automatically update itself with fixes, enhancements, and additional grabbers and postprocessors as they become available.

=== Download & Installation ===
See the [wiki:Installation] page.

=== Status ===
Shepherd is a reliable source of free-to-air guide data. Pay TV data is also available, but less well supported.

=== How does it work? ===
 * The [wiki:FAQ] wiki page contains some questions and answers.
 * The [wiki:shepherd_logic] wiki page describes how shepherd works. The default policies used by shepherd are documented on the [wiki:Policies] wiki page.
 * The [wiki:Security] page discusses security issues associated with Shepherd.

=== Mailing List ===
For help or further discussion, please join our mailing list at [http://groups.google.com/group/shepherd-list?hl=en&pli=1]

=== Bug Reports ===
Please check to see if there is an existing [report:1 open bug ticket] on the problem you have.[[BR]]

Please help us by reporting problems/issues/bugs/stuffups by lodging a "New Ticket" via the above menu.