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 It's better to use the Atom feed import in this case.
  64
  65
  66 =================
  67 Modifying CurlyTx
  68 =================
  69
  70
  71 Translation
  72 ===========
  73 Beginning a new translation
  74 ---------------------------
  75 Replace ``$lang_code`` with your two-letter language code::
  76
  77     $ cd po
  78     $ cp messages.po $lang_code.po
  79     ... edit $lang_code.po now
  80     $ ./compile.sh
  81
  82
  83 Editing an existing translation
  84 -------------------------------
  85 Simply run ::
  86
  87     $ cd po
  88     $ ./update.sh
  89
  90 This will update the translation template ``messages.pot`` from the source code
  91 and will merge the changes into the single translation files.
  92
  93
  94 Testing a translation
  95 ---------------------
  96 Link your compiled translation file into ::
  97
  98     src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
  99
 100 Enigma2 will pick it up automatically.
 101
 102
 103 Building
 104 ========
 105 First upgrade the version number in ``CONTROL/control``.
 106
 107 Then simply run ::
 108
 109     ./build.sh
 110
 111 You will need the ``ipkg-build`` script from
 112  http://reichholf.net/files/dreambox/tools/ipkg-build
 113
 114 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
 115
 116
 117 Open issues
 118 ===========
 119 - move mode to re-order pages
 120 - how to show clock in lcd?
 121
 122
 123 =======
 124 License
 125 =======
 126 The plugin is subject to the GPLv3 or later.