doc: finished documenting the current interface.

diff --git a/docs/index.rst b/docs/index.rst
index bb8f043..8c8d9c1 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,20 +1,25 @@
-.. Simple XBMC Remote documentation master file, created by
-   sphinx-quickstart on Sun Mar 20 09:50:41 2011.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to Simple XBMC Remote's documentation!
-==============================================
+Welcome to |SXR|
+================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
+   
+   mainwindow
+   setupdialog
+
+|SXR| is a simple `Qt4 <http://qt.nokia.com/>`__ application
+for controlling your `XBMC <http://xbmc.org/>`__ from your phone. It was tested
+and developed using a `N900 phone <http://maemo.nokia.com/n900/>`__ and test on
+Maemo5. Some of it may work on other platforms, but some of the functionality
+is implemented only on Maemo 5.
 
-Indices and tables
-==================
+.. figure:: simplexbmcremote-0.8.2.png
+   :height: 400
+   :align: center
+   :target: _images/simplexbmcremote-0.8.2.png
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   |SXR| (release 0.8.2)
 
+.. |SXR| replace:: *Simple XBMC Remote*

diff --git a/docs/mainwindow.rst b/docs/mainwindow.rst
new file mode 100644 (file)
index 0000000..449045d
--- /dev/null
+++ b/docs/mainwindow.rst
@@ -0,0 +1,65 @@
+Main Window
+===========
+
+This is the main window of |SXR|. Please refer to :doc:`setupdialog` for how to
+configure |SXR|.
+
+.. image:: simplexbmcremote-0.8.2.png
+   :height: 400
+   :align: center
+   :target: _images/simplexbmcremote-0.8.2.png
+
+Buttons
+-------
+
++-------------------------------------------------+------------------------------------+
+| Button                                          | Action                             |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_next_subtitle.png  | select next subtitle               |
+|    :height: 32                                  | (if available)                     |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_next_language.png  | select next language               |
+|    :height: 32                                  | (if available)                     |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_gui.png            | show/hide the gui (like            |
+|    :height: 32                                  | pressing the **TAB** key)          |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_context_menu.png   | show the context menu (like        |
+|    :height: 32                                  | pressing the **C** key)            |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_esc.png            | send **ESC** key (use it to get    |
+|    :height: 32                                  | to the main menu, for example)     |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_volume_up.png      | increase the volume                |
+|    :height: 32                                  |                                    |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_volume_down.png    | reduce the volume                  |
+|    :height: 32                                  |                                    |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_mute.png           | mute audio                         |
+|    :height: 32                                  |                                    |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_up.png             | * move up                          |
+|    :height: 32                                  | * skip more forward                |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_down.png           | * move down                        |
+|    :height: 32                                  | * skip more backward               |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_left.png           | * move left                        |
+|    :height: 32                                  | * skip backward                    |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_right.png          | * move right                       |
+|    :height: 32                                  | * skip forward                     |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_play_pause.png     | play/pause the current item        |
+|    :height: 32                                  |                                    |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_stop.png           | stop playing                       |
+|    :height: 32                                  |                                    |
++-------------------------------------------------+------------------------------------+
+| .. image:: ../src/images/btn_enter.png          | select the current item (use to    |
+|    :height: 32                                  | change directories, start a movie, |
+|                                                 | etc.)                              |
++-------------------------------------------------+------------------------------------+
+
+.. |SXR| replace:: *Simple XBMC Remote*

diff --git a/docs/setupdialog.rst b/docs/setupdialog.rst
new file mode 100644 (file)
index 0000000..b71687a
--- /dev/null
+++ b/docs/setupdialog.rst
@@ -0,0 +1,73 @@
+Setup Dialog
+============
+
+The **Setup** dialog can be activated from application's menu. The changes are
+saved only if you press the **Done** button. Clicking outside the dialog is
+interpretted as canceling the current changes.
+
+XBMC
+----
+
+On the phone
+````````````
+
+Use these settings to configure the network connection between XBMC and |SXR|.
+If the XBMC requires an *username* and *password*, check the **Requires
+authentication** and complete those fields, too.
+
+* **Server**: the IP or name of the XBMC server
+* **Port**: port where XBMC listens for HTTP connections
+* **Username**: username configured in XBMC
+* **Password**: password configured in XBMC 
+
+.. warning:: if set, the *username* and *password* are stored in clear on the
+   phone.
+
+.. image:: simplexbmcremote-0.8.3--setup--xbmc.png
+   :scale: 50
+   :target: _images/simplexbmcremote-0.8.3--setup--xbmc.png
+
+On the server
+`````````````
+
+The network configuration for XBMC is accessible via **System > Network >
+Settings > Services**.
+
+1. As a bare minimum, you will have to **Allow control of XBMC via HTTP** and
+   configure a port. The **Port** value must be the same with that used in |SXR|.
+
+2. If you configure a **Username** and **Password**, you will have to check the
+   **Requires authentication** and set |SXR| accordingly.
+
+3. You will also have to activate in XBMC the **Allow programs from other
+   systems to control XBMC** (or you could check only **Allow programs on this
+   system to control XBMC**, use SSSH to do some portforwarding to your phone,
+   then set the *Server* in |SXR| to point to **localhost**).
+
+.. image:: xbmc--system--network--services.png
+
+Screen
+------
+
+You can disable the screen saver by checking the **Disable screensaver**.
+
+.. warning:: Currently, dimming is not working, so you will only be able to disable the screensaver.
+
+.. image:: simplexbmcremote-0.8.3--setup--screen.png
+   :scale: 50
+   :target: _images/simplexbmcremote-0.8.3--setup--screen.png
+
+Notifications
+-------------
+
+In case of some error, |SXR| will display a notification. The time these
+notifications are displayed is controlled by the slider under **Notifications**.
+If you want to completely dissable these notifications, move the slider
+completely to the left.
+
+.. image:: simplexbmcremote-0.8.3--setup--notifications.png
+   :scale: 50
+   :target: _images/simplexbmcremote-0.8.3--setup--notifications.png
+
+
+.. |SXR| replace:: *Simple XBMC Remote*

diff --git a/docs/simplexbmcremote-0.8.3--setup--notifications.png b/docs/simplexbmcremote-0.8.3--setup--notifications.png
new file mode 100644 (file)
index 0000000..31a5f45
Binary files /dev/null and b/docs/simplexbmcremote-0.8.3--setup--notifications.png differ

diff --git a/docs/simplexbmcremote-0.8.3--setup--screen.png b/docs/simplexbmcremote-0.8.3--setup--screen.png
new file mode 100644 (file)
index 0000000..0f6f92e
Binary files /dev/null and b/docs/simplexbmcremote-0.8.3--setup--screen.png differ

diff --git a/docs/simplexbmcremote-0.8.3--setup--xbmc.png b/docs/simplexbmcremote-0.8.3--setup--xbmc.png
new file mode 100644 (file)
index 0000000..495aeeb
Binary files /dev/null and b/docs/simplexbmcremote-0.8.3--setup--xbmc.png differ

diff --git a/docs/xbmc--system--network--services.png b/docs/xbmc--system--network--services.png
new file mode 100644 (file)
index 0000000..bf057a7
Binary files /dev/null and b/docs/xbmc--system--network--services.png differ