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 - Show HTTP headers
  20 - Configurable page titles
  21 - Configurable text size
  22 - Configurable default page
  23 - Import complete page list from Atom feed
  24 - Visible in the main menu or the extension menu (configurable)
  25 - Configurable menu title
  26 - Help screen for main window and settings window
  27
  28
  29 =====
  30 Usage
  31 =====
  32
  33 First run
  34 =========
  35 After installing CurlyTx and restarting Enigma2, open the main menu.
  36 The first entry will be "CurlyTx" - activate it.
  37
  38 You will see the main window with the message
  39 "Go and add a page in the settings".
  40 Do just that end press the red button to access the settings window.
  41
  42 Now we'll add the first URL:
  43
  44 - Press the yellow button ("New"); the "page edit" window will show up
  45 - Enter the page URL, e.g. http://ip.cweiske.de
  46 - If you wish, enter a page title, e.g. "My IP"
  47 - Set the text size if you want. 20 is a good default value.
  48 - Press the green button ("OK"), and you are back on the settings window.
  49 - The page you have just created is in the configuration list now.
  50
  51
  52 If you made a mistake and want to change it, select the page with the
  53 up/down buttons and press "OK" - the page edit window will open.
  54
  55 Press the green button and the settings will be saved.
  56 You're back on the main window now and the URL you just configured will be loaded.
  57
  58
  59 Adding many pages
  60 =================
  61 You can use the settings window to add new pages, but this gets tedious if you
  62 want to add many pages.
  63
  64 It's better to use the Atom feed import in this case.
  65 All you need is a text editor and a web server you can serve the feed page with.
  66
  67 Here is an example feed::
  68
  69   <?xml version="1.0" encoding="utf-8"?>
  70   <feed xmlns="http://www.w3.org/2005/Atom">
  71    <title>URL list for CurlyTx</title>
  72    <author>
  73     <name>Christian Weiske</name>
  74     <email>cweiske@cweiske.de</email>
  75    </author>
  76    <link rel="self" href="http://cweiske.de/tagebuch/feed/"/>
  77    <entry>
  78     <id>http://ip.cweiske.de/</id>
  79     <title>My IP</title>
  80    </entry>
  81    <entry>
  82     <id>http://home/temperatures.txt</id>
  83     <title>House temperatures</title>
  84    </entry>
  85   </feed>
  86
  87 Start CurlyTx, go to the settings and write the feed URL in the
  88 "Page feed URL" field.
  89 Then press "OK" and the feed's pages will be loaded into the settings window.
  90
  91
  92 =================
  93 Modifying CurlyTx
  94 =================
  95
  96
  97 Translation
  98 ===========
  99 Beginning a new translation
 100 ---------------------------
 101 Replace ``$lang_code`` with your two-letter language code::
 102
 103     $ cd po
 104     $ cp messages.po $lang_code.po
 105     ... edit $lang_code.po now
 106     $ ./compile.sh
 107
 108
 109 Editing an existing translation
 110 -------------------------------
 111 Simply run ::
 112
 113     $ cd po
 114     $ ./update.sh
 115
 116 This will update the translation template ``messages.pot`` from the source code
 117 and will merge the changes into the single translation files.
 118
 119
 120 Testing a translation
 121 ---------------------
 122 Link your compiled translation file into ::
 123
 124     src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
 125
 126 Enigma2 will pick it up automatically.
 127
 128
 129 Building
 130 ========
 131 First upgrade the version number in ``CONTROL/control``.
 132
 133 Then simply run ::
 134
 135     ./build.sh
 136
 137 You will need the ``ipkg-build`` script from
 138  http://reichholf.net/files/dreambox/tools/ipkg-build
 139
 140 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
 141
 142
 143 Open issues
 144 ===========
 145 - move mode to re-order pages
 146 - how to show clock in lcd?
 147
 148
 149 =======
 150 License
 151 =======
 152 The plugin is subject to the GPLv3 or later.