blob: ad42e7116886f99bca4c29efc09735c7692fb87c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
# Making Plugins
Plugins may render new preference panes or embed themselves into several
existing one, store data using simple key -\> value data or directly in
the database, modify how articles are rendered, alter feed data, and
much more.
You can use sample plugins bundled with tt-rss and [other
plugins](Plugins) as a starting point. Ask on the forums if you need help
with anything specific.
Some useful information may be found here:
- https://github.com/supahgreg/tt-rss/blob/main/classes/PluginHost.php
- https://github.com/supahgreg/tt-rss/blob/main/classes/Plugin.php
Frontend (JS) uses different hooks, which are defined in [PluginHost.js](https://github.com/supahgreg/tt-rss/blob/main/js/PluginHost.js)
## Localization support
See ``time_to_read`` plugin for a complete example [here](https://github.com/supahgreg/tt-rss-plugin-time-to-read)
### Implementation
- Plugin translations are placed in a separate Gettext domain (name equals lowercase plugin class).
- Translation (.po) file in ``(plugin dir)/locale/(LANG)/LC_MESSAGES/`` name should correspond to Gettext domain name.
### Using gettext
- On the PHP side, either use helper methods defined in ``classes/plugin.php``
(base class for all plugins) or call ``_dgettext`` group of functions
directly.
- On the Javascript side, all translations are merged so you can use the usual
``__()`` shortcut function.
|