From 1d19e08a8a9087b6eda95bb68d2f9daf2344812d Mon Sep 17 00:00:00 2001 From: Dieter Hametner Date: Tue, 29 May 2007 23:01:14 +0000 Subject: - 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 --- README | 5 +++++ doc/TODO.txt | 23 +++++++++++++++++++++++ doc/dev-conventions.txt | 25 +++++++++++++++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 doc/TODO.txt create mode 100644 doc/dev-conventions.txt diff --git a/README b/README index ba1e5ee..85b8afc 100644 --- a/README +++ b/README @@ -87,3 +87,8 @@ Live's "pages" are written in "ecpp", a language integrating C++ and HTML in one file, very much like e.g. PHP or ASP weave functionality and "static" content information together. + +Contribute! +=========== +If you would like to contribute, please read doc/dev-contribute.txt +and doc/TODO.txt. 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//button.png. Where default as theme is always taken if + 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 + + link + +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. + -- cgit v1.2.3