Mercurial > libervia-backend
annotate README4TRANSLATORS @ 2144:1d3f73e065e1
core, jp: component handling + client handling refactoring:
- SàT can now handle components
- plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only.
- components are really similar to clients, but with some changes in behaviour:
* component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected
* trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow
* for clients, only triggers of plugins handling client mode are launched
* for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode.
* component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history
* for convenience, "client" is still used in method even if it can now be a component
* a new "component" boolean attribute tells if we have a component or a client
* components have to add themselve Message protocol
* roster and presence protocols are not added for components
* component default port is 5347 (which is Prosody's default port)
- asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge
- createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point
- jp: added --component argument to profile/create
- disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished
- new PI_* constants for PLUGIN_INFO values (not used everywhere yet)
- client/component connection workflow has been moved to their classes instead of being a host methods
- host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData.
- identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge)
- profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 12 Feb 2017 17:55:43 +0100 |
parents | 0db0013c59dd |
children | 5e72efd2f95d |
rev | line source |
---|---|
69 | 1 First of all, thank you for helping translating SàT :) |
2 | |
223 | 3 NOTE: *.po files are in i18n directory |
4 | |
69 | 5 To translate a file, you can use a dedicated tool as the excellent gtranslator: |
771 | 6 |
862
ca7a2bf4fb40
i18n: updated the translation files
souliane <souliane@mailoo.org>
parents:
845
diff
changeset
|
7 - use the template .po file (e.g. sat.po) and name it to your translated language (e.g. fr.po for french); you can preferably generate a new template directly from the source with the following command (eventually adapted, the following command use zsh's globbing syntax), launched from root sat dir after having emptied the build directory: |
1291
0db0013c59dd
remove remaining references to Wix
souliane <souliane@mailoo.org>
parents:
862
diff
changeset
|
8 > xgettext -L python -d sat --keyword=D_ -p i18n **/*(.py|.tac|primitivus)(.) **/jp(.) |
771 | 9 |
10 - then to start a new translation, copy i18n/sat.po to your language file, e.g. cd i18n; cp sat.po fr.po | |
69 | 11 |
12 - use the choosed tool (a simple text editor can be sufficient) to edit the file: e.g. gtranslator fr.po | |
13 | |
14 - once you translation is finished (or partly finished: the english sentences are used if there is no translation), you can test them by generating a binary and moving it to the right place with the following commands: | |
862
ca7a2bf4fb40
i18n: updated the translation files
souliane <souliane@mailoo.org>
parents:
845
diff
changeset
|
15 > msgfmt -o sat.mo fr.po |
69 | 16 > mv sat.mo i18n/fr/LC_MESSAGES/sat.mo |
17 | |
18 - if you have already a translation, and want to update it (new translations to do, some sentences have changed), you can use the following commands: | |
19 > msgmerge fr.po sat.po > fr2.po | |
20 and if everything is allright | |
21 > mv fr2.po fr.po | |
22 | |
771 | 23 Don't forget that you can (and should !) use the version-control system (mercurial, the "hg" command) to keep history of you translations. |
69 | 24 |
25 You can check the fr.po file to see how it's done and to know what to put while you set up you translation tool. | |
26 | |
862
ca7a2bf4fb40
i18n: updated the translation files
souliane <souliane@mailoo.org>
parents:
845
diff
changeset
|
27 Thank you again for you help, don't forget to give me your name and contact email so I can credit you, and don't hesitate to contact me if you need help (goffi@goffi.org, or the sat XMPP room at sat@chat.jabberfr.org). |
69 | 28 |