X-Git-Url: https://git.cweiske.de/enigma2-curlytx.git/blobdiff_plain/8148307ec321bf0417a95db82eba2d20134f7e6d..14252bfaadaacc1d9afc1c1971eae0f1a1b30eed:/README.rst diff --git a/README.rst b/README.rst index 7469881..1af6c2d 100644 --- a/README.rst +++ b/README.rst @@ -1,32 +1,148 @@ -======= +******* CurlyTx -======= +******* Enigma2 (Dreambox) plugin that lets you view the contents of remote -plain text files, e.g. HTTP. +*plain text* files, e.g. HTTP URLs. Multiple URLs can be configured and navigated. +.. contents:: + :depth: 2 -Open issues -=========== -- hide default page selection when no page defined -- menu title setting has hard coded length? -- help screens -- page import via atom feed/opml -- move mode to re-order pages -- show current page when multiple ones are defined: "2/6" -- configurable text size per page -- show in plugin/extension menu (blue button) -- is position 1 correct? -- include ``.py`` files? -- include ``.po`` files? +======== +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 +- Configurable default page +- Import complete page list from Atom feed +- Visible in the main menu or the extension menu (configurable) +- Configurable menu title +- Help screen for main window and settings window -License -======= -The plugin is subject to the GPLv3 or later. +===== +Usage +===== + +First run +========= +After installing CurlyTx and restarting Enigma2, open the main menu. +The first entry will be "CurlyTx" - activate it. + +You will see the main window with the message +"Go and add a page in the settings". +Do just that end press the red button to access the settings window. + +Now we'll add the first URL: + +- Press the yellow button ("New"); the "page edit" window will show up +- Enter the page URL, e.g. http://ip.cweiske.de +- If you wish, enter a page title, e.g. "My IP" +- Set the text size if you want. 20 is a good default value. +- Press the green button ("OK"), and you are back on the settings window. +- The page you have just created is in the configuration list now. + + +If you made a mistake and want to change it, select the page with the +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:: + + + + URL list for CurlyTx + + Christian Weiske + cweiske@cweiske.de + + + + ip + My IP + + + + temp + House temperatures + + + + +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:: + + + +Then, add the setting after the author or self link:: + + 0 +Here is the example feed with disabled settings:: + + + + URL list for CurlyTx + + Christian Weiske + cweiske@cweiske.de + + + 0 + + ip + My IP + + + + temp + House temperatures + + + + + +================= +Modifying CurlyTx +================= Translation @@ -41,9 +157,72 @@ Replace ``$lang_code`` with your two-letter language code:: $ ./compile.sh +Editing an existing translation +------------------------------- +Simply run :: + + $ cd po + $ ./update.sh + +This will update the translation template ``messages.pot`` from the source code +and will merge the changes into the single translation files. + + +Testing a translation +--------------------- +Link your compiled translation file into :: + + src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo + +Enigma2 will pick it up automatically. + + Building ======== -ipkg-build: +First upgrade the version number in ``CONTROL/control``. + +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 -http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen +Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen + + +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. + +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