Support older dreamboxes (e.g. 7025+) that don't have a recent elementtree library.
[enigma2-curlytx.git] / README.rst
index b7befa3..1af6c2d 100644 (file)
@@ -16,6 +16,7 @@ Features
 - Load any remote plain text files, e.g. via HTTP
 - Unlimited number of remote URLs/pages
 - Reload pages
+- Non-blocking URL loading
 - Show HTTP headers
 - Configurable page titles
 - Configurable text size
@@ -55,12 +56,88 @@ up/down buttons and press "OK" - the page edit window will open.
 Press the green button and the settings will be saved.
 You're back on the main window now and the URL you just configured will be loaded.
 
+Note that with version 1.1, CurlyTx supports opening local files.
+Prepend them with ``file://``, e.g. ``file:///tmp/test.txt``.
+
 
 Adding many pages
 =================
 You can use the settings window to add new pages, but this gets tedious if you
 want to add many pages.
+
 It's better to use the Atom feed import in this case.
+All you need is a text editor and a web server you can serve the feed page with.
+
+Here is an example feed::
+
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom">
+   <title>URL list for CurlyTx</title>
+   <author>
+    <name>Christian Weiske</name>
+    <email>cweiske@cweiske.de</email>
+   </author>
+   <link rel="self" href="http://home.cweiske.de/pagefeed.atom"/>
+   <entry>
+    <id>ip</id>
+    <title>My IP</title>
+    <link rel="alternate" type="text/html" href="http://ip.cweiske.de/" />
+   </entry>
+   <entry>
+    <id>temp</id>
+    <title>House temperatures</title>
+    <link rel="alternate" type="text/html" href="http://home/temperatures.txt" />
+   </entry>
+  </feed>
+
+Start CurlyTx, go to the settings and write the feed URL in the
+"Page feed URL" field.
+Then press "OK" and the feed's pages will be loaded into the settings window.
+
+
+Local configuration file
+========================
+CurlyTx looks for a local page feed file on the harddisk on every run,
+at ``/etc/enigma2/curlytx-pagefeed.xml``.
+If this file exists, it gets loaded unconditionally and overwrites
+the current page configuration.
+
+
+Disable settings
+================
+The page feed file may contain a tag that disables the settings button.
+By using it, you can prevent people from modifying the CurlyTx settings.
+
+First, register the namespace::
+
+    <feed xmlns="http://www.w3.org/2005/Atom" xmlns:c="http://ns.cweiske.de/curlytx">
+
+Then, add the setting after the author or self link::
+
+    <c:enableSettings>0</c:enableSettings>
+
+Here is the example feed with disabled settings::
+
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom" xmlns:c="http://ns.cweiske.de/curlytx">
+   <title>URL list for CurlyTx</title>
+   <author>
+    <name>Christian Weiske</name>
+    <email>cweiske@cweiske.de</email>
+   </author>
+   <link rel="self" href="http://home.cweiske.de/pagefeed.atom"/>
+   <c:enableSettings>0</c:enableSettings>
+   <entry>
+    <id>ip</id>
+    <title>My IP</title>
+    <link rel="alternate" type="text/html" href="http://ip.cweiske.de/" />
+   </entry>
+   <entry>
+    <id>temp</id>
+    <title>House temperatures</title>
+    <link rel="alternate" type="text/html" href="http://home/temperatures.txt" />
+   </entry>
+  </feed>
 
 
 =================
@@ -108,19 +185,44 @@ Then simply run ::
 
     ./build.sh
 
+Directory ``releases/`` will contain the freshly baked ``.ipk`` file that can
+then be transferred to your dreambox, e.g. via ``scp``::
+
+    $ scp releases/enigma2-plugin-extensions-curlytx_2.3_mipsel.ipk dreambox:
+    $ ssh dreambox
+    $ ipkg install enigma2-plugin-extensions-curlytx_2.3_mipsel.ipk
+
 You will need the ``ipkg-build`` script from
  http://reichholf.net/files/dreambox/tools/ipkg-build
 
 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
 
 
-Open issues
-===========
+Open issues / ideas
+===================
 - move mode to re-order pages
 - how to show clock in lcd?
 
 
-=======
+=====
+About
+=====
+Homepage
+========
+https://open-dreambox.org/trac/dreambox/wiki/CurlyTx
+
+Author
+======
+Christian Weiske, `cweiske@cweiske.de`__
+
+.. __: mailto:cweiske@cweiske.de
+
 License
 =======
-The plugin is subject to the GPLv3 or later.
+The plugin is subject to the GPLv3_ or later.
+
+Additional exception:
+  This plugin may be distributed and executed on hardware which is licensed by
+  Dream Multimedia GmbH.
+
+.. _GPLv3: http://www.gnu.org/licenses/agpl.html