update ui doc, add API doc

diff --git a/README.rst b/README.rst
index 9d9ef33be6c6552a10fb5db166f7fde80e90991f..c7c7d1ae4438e283afdec7bca24dc428fd7dffe6 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -160,6 +160,11 @@ get the results::
  >>> print 'Level:', analyzer.results
 
 
+API / Documentation
+====================
+
+http://files.parisson.com/timeside/doc/
+
 Install
 =======
 
@@ -205,19 +210,29 @@ MacOS X and Windows versions will soon be explorated.
 The player should work on any modern HTML5 enabled browser.
 Flash is needed for MP3 if the browser doesn't support it.
 
-Extensible HTML5 User Interface
-================================
+HTML5 User Interface
+====================
 
-TimeSide comes with a smart HTML5 audio player which can drive the process engine through a web server.
+TimeSide comes with a smart and pure HTML5 audio player.
 
-Some examples of application:
+Features:
+    * embed it in any audio web application
+    * stream, playback and download various audio formats on the fly
+    * synchronize sound with text, bitmap and vectorial events
+    * seek through various semantic, analytic and time synced data
+    * fully skinnable with CSS style
 
- * http://parisson.telemeta.org/archives/items/PRS_07_01_03/
- * http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/ (player embedded in a Telemeta session)
+Examples of the player embeded in the Telemeta open web audio CMS:
+    * http://parisson.telemeta.org/archives/items/PRS_07_01_03/
+    * http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/
 
-The detailed documentation to extend the player:
+Development documentation:
+    * https://github.com/yomguy/TimeSide/wiki/Ui-Guide
 
- * https://github.com/yomguy/TimeSide/wiki/Ui-Guide
+TODO list:
+    * embed a light http server to get commands through something like JSON RPC
+    * zoom
+    * layers
 
 Development
 ===========

diff --git a/doc/source/doc.rst b/doc/source/doc.rst
new file mode 100644 (file)
index 0000000..994fea7
--- /dev/null
+++ b/doc/source/doc.rst
@@ -0,0 +1,5 @@
+API / Documentation
+====================
+
+http://files.parisson.com/timeside/doc/
+

diff --git a/doc/source/ui.rst b/doc/source/ui.rst
index a33e3c6c52aa05f4a692add0f70325c72fcd5d89..759799eac128a0a86fdfd12fe3db477d066b7012 100644 (file)
--- a/doc/source/ui.rst
+++ b/doc/source/ui.rst
@@ -1,14 +1,24 @@
-Extensible HTML5 User Interface
-================================
+HTML5 User Interface
+====================
 
-TimeSide comes with a smart HTML5 audio player which can drive the process engine through a web server.
+TimeSide comes with a smart and pure HTML5 audio player.
 
-Some examples of application:
+Features:
+    * embed it in any audio web application
+    * stream, playback and download various audio formats on the fly
+    * synchronize sound with text, bitmap and vectorial events
+    * seek through various semantic, analytic and time synced data
+    * fully skinnable with CSS style
 
- * http://parisson.telemeta.org/archives/items/PRS_07_01_03/
- * http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/ (player embedded in a Telemeta session)
+Examples of the player embeded in the Telemeta open web audio CMS:
+    * http://parisson.telemeta.org/archives/items/PRS_07_01_03/
+    * http://archives.crem-cnrs.fr/items/CNRSMH_I_1956_002_001_01/
 
-The detailed documentation to extend the player:
+Development documentation:
+    * https://github.com/yomguy/TimeSide/wiki/Ui-Guide
 
- * https://github.com/yomguy/TimeSide/wiki/Ui-Guide
+TODO list:
+    * embed a light http server to get commands through something like JSON RPC
+    * zoom
+    * layers