Missed one file
[pierogi] / doc / documentation.html
index df4fd34..29e7cf7 100644 (file)
@@ -28,10 +28,7 @@ Pierogi also follows the classic concept of a universal remote, by having
 a common set of buttons that are reused for each device.  So, for example,
 the "power" button has the same name and is located in the same position,
 no matter what keyset is currently in use -- even if that keyset has a
-different name for "power", or has no "power" command at all.  (Check out
-the <a href="http://en.wikipedia.org/wiki/Universal_remote">Universal
-Remote wiki</a> for a description of universal remote controls, which
-includes a special mention of the N900!)
+different name for "power", or has no "power" command at all.
 </p>
 
 <p>
@@ -43,37 +40,39 @@ the features of Pierogi is provided below.
 <h2>Using Pierogi</h2>
 
 <p>
-The current Pierogi design is built around a tabbed window, each tab containing
-a group of related buttons.  Depending on the keyset that has been selected,
-some of these buttons will be active, others inactive.  Active buttons are ones
-which have been associated with a command in the current keyset.  Pressing an
+The current Pierogi design is built around a series of control panels, with
+each panel containing a group of related buttons.  Depending on the keyset
+chosen, some of these buttons will be active, others inactive.  Pressing an
 active button will begin repeating the associated command; letting up on the
 button will stop the command.
 </p>
 
 <p>
-Keysets can be chosen using the "Select Keyset" option in the drop-down menu.
-If you have a particular keyset you use often, it can be stored in the
-"favorites" tab for quick access.
+Keysets can be chosen using either the "Select Keyset by Name" or "Select
+Keyset by Device" options in the drop-down menu.  If you have a particular
+keyset you use often, it can be stored in the "favorites" panel for quick
+access.
 </p>
 
-<h3>Main Tab</h3>
+<h3>Main Window</h3>
 
-<p>The Main tab contains just the power, volume, and channel buttons.  It is
-intended to be a quick way to get to the most important, commonly used
-controls.  The name of the current keyset is also provided in this tab.</p>
+<h4>Main Panel</h4>
 
-<h3>Utility Tab</h3>
+<p>The Main panel contains just the power, volume, mute, and channel buttons.
+It is intended to be a quick way to get to the most important, commonly used
+controls.  The name of the current keyset is also provided in this panel.</p>
 
-<p>The Utility tab contains a selection of commonly useful controls, such as
-"Mute", "Sleep", "Input", "Closed Captions / Subtitles", and the color buttons.
-This tab is intended to be a quick way to reach the most frequently used
+<h4>Utility Panel</h4>
+
+<p>The Utility panel contains a selection of commonly useful controls, such as
+"Sleep", "Input", "Closed Captions / Subtitles", and the color buttons.
+This panel is intended to be a quick way to reach the most frequently used
 buttons; as such, the selection may be updated in future versions of Pierogi.
 </p>
 
-<h3>Keypad Tab</h3>
+<h4>Keypad Panel</h4>
 
-<p>This tab provides a numeric keypad and a handful of associated commands,
+<p>This panel provides a numeric keypad and a handful of associated commands,
 intended mainly for use with televisions.  The "Prev Channel" button should
 take you to the previously selected channel, if any.  The "Dash" button
 should allow you to specify a digital subchannel, as in "16-4".  The "+100"
@@ -83,55 +82,115 @@ Double Digit" button is used on very old televisions that normally expect
 channels to be represented by just a single digit; pressing this should
 allow you to enter a second digit.</p>
 
-<h3>Menu Tab</h3>
+<h4>Menu Panel</h4>
 
-<p>This tab contains buttons used to enter and exit a menu, navigate within
+<p>This panel contains buttons used to enter and exit a menu, navigate within
 a menu, and select menu entries.  The "Menu" button is meant to enter the
 main system menu of a given device; "Guide" is a content-related menu available
 on many modern devices; and "Disc Menu" is used to access the menu interface
 provided with DVD and Blu-Ray media.</p>
 
-<h3>Media Tab</h3>
+<h4>Media Panel</h4>
 
-<p>Many of the most important playback commands are represented on this tab.
+<p>Many of the most important playback commands are represented on this panel.
 "Play", "Pause", and "Stop" are the most common ones, along with "Reverse"
 (often called rewind) and "Fast Forward".  A variety of other less common
 navigation controls are included, along with the "Eject" command.</p>
 
-<h3>Media2 Tab</h3>
+<h4>Media2 Panel</h4>
 
-<p>This is another page of media buttons, containing a mix of commands useful
+<p>This is another panel of media buttons, containing a mix of commands useful
 for DVD players, VCRs, audio devices, and possibly other devices.  The content
 of this page may change in the future.</p>
 
-<h3>TV Tab</h3>
+<h4>TV Panel</h4>
 
-<p>This page contains several more TV-oriented buttons, including controls for
+<p>This panel contains several more TV-oriented buttons, including controls for
 picture-in-picture, teletext, and some graphics and audio controls.  The
 content of this page is subject to change.</p>
 
-<h3>Favorite Tab</h3>
+<h4>Input Panel</h4>
+
+<p>
+Many devices have multiple sources for their data, whether it be television
+signals piped in over the air or through a cable, or audio from a variety of
+stereo components.  It is unlikely that Pierogi will ever be able to list all
+of the various possible input buttons, but this panel contains a few of them.
+</p>
+
+<h4>Adjust Panel</h4>
+
+<p>
+A handful of the various audio and video adjustment buttons are placed in
+this panel.
+</p>
+
+<h4>Air Conditioner Panel</h4>
 
-<p>As there are numerous keysets available in Pierogi, a "Favorite" tab has
-been implemented.  To add a favorite keyset to the tab, first select that
-keyset from the "Select Keyset" window.  Then, navigate to the Favorite tab
-and press "Add Current Keyset".</p>
+<p>
+This panel includes several controls commonly found on remotes used for
+air conditioners.
+</p>
+
+<h4>Favorites Panel</h4>
+
+<p>
+As there are numerous keysets available in Pierogi, a "Favorites" panel has
+been implemented.  To add a favorite keyset to the panel, first select that
+keyset from either the "Select Keyset by Name" or "Select Keyset by Device"
+windows.  Then, navigate to the Favorites panel and press "Add Current Keyset".
+</p>
+
+<p>
+Once you have added some keysets to the favorites list, you can tell
+Pierogi to use one by simply selecting that keyset from the list.  You can
+also switch between keysets on the favorites list by pressing either of the
+volume control keys on the top left side of the N900; this allows you to
+change the keyset regardless of which panel is currently visible.
+</p>
 
-<p>Once you have added some keysets to the favorites list, you can tell
-Pierogi to use one by simply selecting that keyset from the list.</p>
+<p>
+A keyset can be removed from the list by selecting it and pressing
+"Remove Selected Keyset".
+</p>
 
-<p>A keyset can be removed from the list by selecting it and pressing
-"Remove Selected Keyset".</p>
 
-<h3>Select Keyset Window</h3>
+<h3>Select Keyset by Name Window</h3>
 
-<p>The Select Keyset window presents a list of all the keysets currently
-available in Pierogi.  As this list is fairly long, buttons have been added
-at the top of the window that allows you to choose the make and/or type of
+<p>
+The Select Keyset by Name window presents a list of all the keysets currently
+available in Pierogi.  As this list is fairly long, a button has been added
+at the top of the window that allows you to filter the list by the make of the
 device you are trying to control; all keysets not associated with the chosen
-make or type will be hidden.  To use a keyset, simply select it from the list,
+make will be hidden.  To use a keyset, simply select it from the list,
 and then close the window (by pressing the return arrow at the top right of
-the screen).</p>
+the screen).
+</p>
+
+
+<h3>Select Keyset by Device Window</h3>
+
+<p>
+Similar to the Select by Name window, this window provides a list of the
+devices known to work with Pierogi.  This list can be filtered either by
+the make or the type of device.  Choosing an entry from this list will
+activate the keyset associated with the chosen device.
+</p>
+
+<p>
+Please note that this is nowhere near an exhaustive list of the devices
+Pierogi can control!
+</p>
+
+
+<h3>Manage Panels Window</h3>
+
+<p>
+Each of the panels available in Pierogi can be switched on or off using this
+window.  Simply set a check in the panel's checkbox to make it available in
+the main window, and un-check it to make the panel go away.
+</p>
+
 
 <h2>Design Rationale</h2>