README.rst

   1 *******
   2 CurlyTx
   3 *******
   4 Enigma2 (Dreambox) plugin that lets you view the contents of remote
   5 *plain text* files, e.g. HTTP URLs.
   6
   7 Multiple URLs can be configured and navigated.
   8
   9 .. contents::
  10    :depth: 2
  11
  12
  13 ========
  14 Features
  15 ========
  16 - Load any remote plain text files, e.g. via HTTP
  17 - Unlimited number of remote URLs/pages
  18 - Reload pages
  19 - Non-blocking URL loading
  20 - Show HTTP headers
  21 - Configurable page titles
  22 - Configurable text size
  23 - Configurable default page
  24 - Import complete page list from Atom feed
  25 - Visible in the main menu or the extension menu (configurable)
  26 - Configurable menu title
  27 - Help screen for main window and settings window
  28
  29
  30 =====
  31 Usage
  32 =====
  33
  34 First run
  35 =========
  36 After installing CurlyTx and restarting Enigma2, open the main menu.
  37 The first entry will be "CurlyTx" - activate it.
  38
  39 You will see the main window with the message
  40 "Go and add a page in the settings".
  41 Do just that end press the red button to access the settings window.
  42
  43 Now we'll add the first URL:
  44
  45 - Press the yellow button ("New"); the "page edit" window will show up
  46 - Enter the page URL, e.g. http://ip.cweiske.de
  47 - If you wish, enter a page title, e.g. "My IP"
  48 - Set the text size if you want. 20 is a good default value.
  49 - Press the green button ("OK"), and you are back on the settings window.
  50 - The page you have just created is in the configuration list now.
  51
  52
  53 If you made a mistake and want to change it, select the page with the
  54 up/down buttons and press "OK" - the page edit window will open.
  55
  56 Press the green button and the settings will be saved.
  57 You're back on the main window now and the URL you just configured will be loaded.
  58
  59
  60 Adding many pages
  61 =================
  62 You can use the settings window to add new pages, but this gets tedious if you
  63 want to add many pages.
  64
  65 It's better to use the Atom feed import in this case.
  66 All you need is a text editor and a web server you can serve the feed page with.
  67
  68 Here is an example feed::
  69
  70   <?xml version="1.0" encoding="utf-8"?>
  71   <feed xmlns="http://www.w3.org/2005/Atom">
  72    <title>URL list for CurlyTx</title>
  73    <author>
  74     <name>Christian Weiske</name>
  75     <email>cweiske@cweiske.de</email>
  76    </author>
  77    <link rel="self" href="http://home.cweiske.de/pagefeed.atom"/>
  78    <entry>
  79     <id>ip</id>
  80     <title>My IP</title>
  81     <link rel="alternate" type="text/html" href="http://ip.cweiske.de/" />
  82    </entry>
  83    <entry>
  84     <id>temp</id>
  85     <title>House temperatures</title>
  86     <link rel="alternate" type="text/html" href="http://home/temperatures.txt" />
  87    </entry>
  88   </feed>
  89
  90 Start CurlyTx, go to the settings and write the feed URL in the
  91 "Page feed URL" field.
  92 Then press "OK" and the feed's pages will be loaded into the settings window.
  93
  94
  95 =================
  96 Modifying CurlyTx
  97 =================
  98
  99
 100 Translation
 101 ===========
 102 Beginning a new translation
 103 ---------------------------
 104 Replace ``$lang_code`` with your two-letter language code::
 105
 106     $ cd po
 107     $ cp messages.po $lang_code.po
 108     ... edit $lang_code.po now
 109     $ ./compile.sh
 110
 111
 112 Editing an existing translation
 113 -------------------------------
 114 Simply run ::
 115
 116     $ cd po
 117     $ ./update.sh
 118
 119 This will update the translation template ``messages.pot`` from the source code
 120 and will merge the changes into the single translation files.
 121
 122
 123 Testing a translation
 124 ---------------------
 125 Link your compiled translation file into ::
 126
 127     src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
 128
 129 Enigma2 will pick it up automatically.
 130
 131
 132 Building
 133 ========
 134 First upgrade the version number in ``CONTROL/control``.
 135
 136 Then simply run ::
 137
 138     ./build.sh
 139
 140 Directory ``releases/`` will contain the freshly baked ``.ipk`` file that can
 141 then be transferred to your dreambox, e.g. via ``scp``::
 142
 143     $ scp releases/enigma2-plugin-extensions-curlytx_2.3_mipsel.ipk dreambox:
 144     $ ssh dreambox
 145     $ ipkg install enigma2-plugin-extensions-curlytx_2.3_mipsel.ipk
 146
 147 You will need the ``ipkg-build`` script from
 148  http://reichholf.net/files/dreambox/tools/ipkg-build
 149
 150 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
 151
 152
 153 Open issues / ideas
 154 ===================
 155 - move mode to re-order pages
 156 - how to show clock in lcd?
 157
 158
 159 =====
 160 About
 161 =====
 162 Homepage
 163 ========
 164 https://open-dreambox.org/trac/dreambox/wiki/CurlyTx
 165
 166 Author
 167 ======
 168 Christian Weiske, cweiske@cweiske.de
 169
 170 License
 171 =======
 172 The plugin is subject to the GPLv3_ or later.
 173
 174 .. _GPLv3: http://www.gnu.org/licenses/agpl.html