always load the local configuration file
[enigma2-curlytx.git] / 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 Note that with version 1.1, CurlyTx supports opening local files.
60 Prepend them with ``file://``, e.g. ``file:///tmp/test.txt``.
61
62
63 Adding many pages
64 =================
65 You can use the settings window to add new pages, but this gets tedious if you
66 want to add many pages.
67
68 It's better to use the Atom feed import in this case.
69 All you need is a text editor and a web server you can serve the feed page with.
70
71 Here is an example feed::
72
73   <?xml version="1.0" encoding="utf-8"?>
74   <feed xmlns="http://www.w3.org/2005/Atom">
75    <title>URL list for CurlyTx</title>
76    <author>
77     <name>Christian Weiske</name>
78     <email>cweiske@cweiske.de</email>
79    </author>
80    <link rel="self" href="http://home.cweiske.de/pagefeed.atom"/>
81    <entry>
82     <id>ip</id>
83     <title>My IP</title>
84     <link rel="alternate" type="text/html" href="http://ip.cweiske.de/" />
85    </entry>
86    <entry>
87     <id>temp</id>
88     <title>House temperatures</title>
89     <link rel="alternate" type="text/html" href="http://home/temperatures.txt" />
90    </entry>
91   </feed>
92
93 Start CurlyTx, go to the settings and write the feed URL in the
94 "Page feed URL" field.
95 Then press "OK" and the feed's pages will be loaded into the settings window.
96
97
98 Local configuration file
99 ========================
100 CurlyTx looks for a local page feed file on the harddisk on every run,
101 at ``/etc/enigma2/curlytx-pagefeed.xml``.
102 If this file exists, it gets loaded unconditionally and overwrites
103 the current page configuration.
104
105
106 =================
107 Modifying CurlyTx
108 =================
109
110
111 Translation
112 ===========
113 Beginning a new translation
114 ---------------------------
115 Replace ``$lang_code`` with your two-letter language code::
116
117     $ cd po
118     $ cp messages.po $lang_code.po
119     ... edit $lang_code.po now
120     $ ./compile.sh
121
122
123 Editing an existing translation
124 -------------------------------
125 Simply run ::
126
127     $ cd po
128     $ ./update.sh
129
130 This will update the translation template ``messages.pot`` from the source code
131 and will merge the changes into the single translation files.
132
133
134 Testing a translation
135 ---------------------
136 Link your compiled translation file into ::
137
138     src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
139
140 Enigma2 will pick it up automatically.
141
142
143 Building
144 ========
145 First upgrade the version number in ``CONTROL/control``.
146
147 Then simply run ::
148
149     ./build.sh
150
151 Directory ``releases/`` will contain the freshly baked ``.ipk`` file that can
152 then be transferred to your dreambox, e.g. via ``scp``::
153
154     $ scp releases/enigma2-plugin-extensions-curlytx_2.3_mipsel.ipk dreambox:
155     $ ssh dreambox
156     $ ipkg install enigma2-plugin-extensions-curlytx_2.3_mipsel.ipk
157
158 You will need the ``ipkg-build`` script from
159  http://reichholf.net/files/dreambox/tools/ipkg-build
160
161 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
162
163
164 Open issues / ideas
165 ===================
166 - move mode to re-order pages
167 - how to show clock in lcd?
168
169
170 =====
171 About
172 =====
173 Homepage
174 ========
175 https://open-dreambox.org/trac/dreambox/wiki/CurlyTx
176
177 Author
178 ======
179 Christian Weiske, `cweiske@cweiske.de`__
180
181 .. __: mailto:cweiske@cweiske.de
182
183 License
184 =======
185 The plugin is subject to the GPLv3_ or later.
186
187 Additional exception:
188   This plugin may be distributed and executed on hardware which is licensed by
189   Dream Multimedia GmbH.
190
191 .. _GPLv3: http://www.gnu.org/licenses/agpl.html