I've used l10n_client a couple of times and I noticed that installation & configuration is not so easy.
You need to know a couple of things that, afaik, are not documented. E.g. you need to find the configuration for sharing the translations and find the place to enter the key
The link to the readme file on http://drupal.org/project/l10n_client isnt very useful
The actual readme itself is more useful but could be improved
Is there any documentation elsewhere?
Is there need for documentation, such as a handbook page?
(I could provide it, as I'm preparing a presentation about l10n_client)
| Comment | File | Size | Author |
|---|---|---|---|
| #11 | D7-README.patch | 7.04 KB | gábor hojtsy |
| #11 | D6-README.patch | 1.78 KB | gábor hojtsy |
| #5 | README-2.patch | 6.82 KB | batigolix |
| #5 | README-boris.txt | 4.62 KB | batigolix |
| #3 | README-1.patch | 6.66 KB | batigolix |
Comments
Comment #1
gábor hojtsyAn update for the README would be useful as a first step. A d.o documentation page might exist, but I never checked :) I think a more *guiding* user interface would be useful. Eg. when you enable the module, we can throw a message linking to a built-in short checklist: (a) give permissions (b) enable a foreign language (c) use that foreign language for basic functionality. Then (A) enable localization sharing (B) specify per-user keys for sharing.
Also, the localization sharing page could explain that per-user keys are required and the remote submission can provide feedback to the user on success. I think only this last item has an existing issue in the l10n_client queue.
All-in-all, I think the module could be more communicative and helpful for the user, right.
Comment #2
batigolixthen i'll create an instruction that could serve both for the readme file as drupal handbook page (which does not seem to exist).
Comment #3
batigolixhere's a patch for the complete rewrite of the readme
this readme can be used for a handbook page as well (if there is need for that)
i used all the info i could find in:
- the original readme
- the proj page
- the module's user interface
- my imagination
it should be checked carefully
i did find a number of UI inconsistencies that might need some attention as well besides your suggestions about a more *guiding* user interface . shall i file a separate issue?
Comment #4
gábor hojtsyLooks good. For the sharing part, I'd explain that per-user keys are required, and that form field has a link to obtain your key from the set localization server.
Comment #5
batigolixi adapted with your suggestions
i included my readme version for easy reading
Comment #6
batigolixComment #7
gábor hojtsyLooks good, will clean up a little and commit later (hopefully soon). Thanks!
Comment #8
gábor hojtsyThanks, finally, actually committed.
Comment #9
gábor hojtsyNeeds to be modified / ported to D7 as well.
Comment #10
j0nathan commentedHi,
I am happy to find this documentation because I searched a lot on the web to try to find out how to configure the connection between l10n_client and l10n_server (API key stuff). The link to the CVS for the documentation from the project page didn't help me because I didn't know where to click to get the full README file into the CVS web interface.
I have little comments about the documentation I read from the package 6.x-1.x-dev (2010-Apr-29):
- line 60 (ON-PAGE TRANSLATION #1): I would change from "Switch the website's language to one that is not English." to "Switch the website's language to one that is not the website's default language." Because it is how the on-page translation appears.
- line 62 (ON-PAGE TRANSLATION #3): In "strings are marked green. yet untranslated strings" I'm not sure if it's a coma (,) or it has to be capitalized Y after the period.
- Maybe we can talk about and put a link to the module l10n_update in the section "RE-IMPORTING TRANSLATION PACKAGES"
Thank you for the modules
Comment #11
gábor hojtsyPorted readme to D7.
@J0nathan: it should appear anytime your language is not English; if that's now how it works, we need to fix it as a bug. Fixed the other two suggestions in both D6 and D7.
Comment #12
j0nathan commentedThank you for the documentation.
Just a note about the appearance of the bar, it appears in any language on a site, even English. I will update to the latest version, which I'm looking forward to trying, test on a couple of sites and open a new issue if I am faced to a real bug.