summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDieter Hametner <dh (plus) vdr (at) gekrumbel (dot) de>2007-05-29 23:01:14 +0000
committerDieter Hametner <dh (plus) vdr (at) gekrumbel (dot) de>2007-05-29 23:01:14 +0000
commit1d19e08a8a9087b6eda95bb68d2f9daf2344812d (patch)
treeecf13f73ccd2413295e20fea97325a1fae6e438d /doc
parent49b3ac4bc953543c21139d514ad5563284486fec (diff)
downloadvdr-plugin-live-1d19e08a8a9087b6eda95bb68d2f9daf2344812d.tar.gz
vdr-plugin-live-1d19e08a8a9087b6eda95bb68d2f9daf2344812d.tar.bz2
- Added doc sub directory.
- Added doc/TODO.txt with some 'non-bugtracking' development ideas. - Added doc/dev-conventions.txt to collect and promote some coding styles and developing guidelines. - Added pointer to these files in README
Diffstat (limited to 'doc')
-rw-r--r--doc/TODO.txt23
-rw-r--r--doc/dev-conventions.txt25
2 files changed, 48 insertions, 0 deletions
diff --git a/doc/TODO.txt b/doc/TODO.txt
new file mode 100644
index 0000000..074c52b
--- /dev/null
+++ b/doc/TODO.txt
@@ -0,0 +1,23 @@
+This is a list of ideas and TODO-Items for live plugin.
+
+- Add better support for the numerous CSS bugs in IE. Maybe by
+ splitting style files in a similar way like it is done for YAML
+ (http://www.yaml.de)
+
+- Create a CSS-themeing friendly url scheme. I.E. something like
+ img/<theme>/button.png. Where default as theme is always taken if
+ <theme> is not found.
+- Give users the chance to override the selected style with some
+ user-override settings.
+- Deliver truely static content, like images, styles, ECMAscript
+ with tntnets sendfile functionality after resolving user selected
+ themes paths. Take care to support browser cache optimization.
+
+- Deliver epg box infos through AJAX. This would make a ECMAScript
+ capable browser mandatory.
+- Provide a way to get the infos on extra 'static' pages.
+
+
+For Features regarding functionality and user suggestions please take
+a look to the bugtracker: http://www.vdr-developer.org/mantisbt/
+
diff --git a/doc/dev-conventions.txt b/doc/dev-conventions.txt
new file mode 100644
index 0000000..c3472fd
--- /dev/null
+++ b/doc/dev-conventions.txt
@@ -0,0 +1,25 @@
+This file contains some guidlines for developers about what to obey
+when adding new functionality to live plugin.
+
+First of all please look at the existing code and how it was done
+there. We are still open for improvement suggestions though.
+
+We want to support a broad range of browsers. On one side are hand held
+devices like WEB-enabled PDAs or mobile phones. They often lack full
+grown support for ECMAScript and have small screen sizes. The other
+extreme are the desktop browsers like FireFox, Konqueror, Opera and
+perhabs IE (if the 'powers that be' make him more CSS compliant).
+Here WEB 2.0 featuers can improve the users experience.
+
+In the future some themeing in live might help to cover this broad
+range. Meanwhile we suggest the following rule to activate
+functionality with and without ECMAScript support:
+
+Use anchors analog to this example
+
+ <a href="show_content.html?ref=additional_content_ref"
+ onclick="makefalse(requestbox('additional_content_ref'));">link</a>
+
+to retrieve and display extra information either in a WEB 2.0 fashion
+in an popup box or on a separte page in a html fashion.
+