Translations

49 views
Skip to first unread message

Yakov

unread,
Aug 24, 2023, 3:32:33 AM8/24/23
to TiddlyWikiClassic
Hello everyone,

during august, I've been tinkering around core translations, and here are some preliminary results:
  • I've added an Extension Explorer collection of core translations, which is already available in the central collection. I.e., once you've installed EEP, you can, from backstage, install ExtensionsCollection (the central one; direct link just in case), then install TranslationsCollection and then pick a translation and install from there.

    • This is a first extensive test of "packing existing non-maintained extensions into a collection", which I'd like to do for various extensions sets, like plugins by Tobias; "indexing" collections like TiddlyTools (in-TW) is a separate task.

    • If you have any comments (corrections) for localized descriptions inside the collection, please let me know. I haven't finished my considerations regarding using national flags for quick identification of languages (polytical/ethical aspects, the fact that on Windows they are not always displayed as flags: 🇱🇻).

    • If you have comments regarding using EEP for this, please also share! I've prepared some bits to implement the "show" button for collection (i.e., show extensions from collection, but don't install it permamently: one hardly needs to see other translations once one is installed).

  • I've been updating existing translations so that their metadata and codestyle are more consistent and accurate;

  • I've started updating the infrastructure for easier contributing: made first updates to the readme in the translations repo (will elaborate instructions more), added the changelog for Lingo (will add more versions, started adding missing tags; not sure if this will be needed, will see while updating ru translation).

    • I'll be testing this on merging the old PRs and updating ru translation; presumably I'll change the plugin template for easier contribution.

    • If you wanted to create an up-to-date translation for your language, now is the best time to give it a try. I suggest starting from adding/updating a single line and creating a PR – that's the minimal update lifecycle and I'll help you on any step and will quickly review the PR. If you have suggestions on how to simplify the process/clarify the instructions, please also let me know.
It will be also helpful if you let us know if you:
  • are using a translation already;
  • want to use a translation, but don't know how/the current one is not good enough;
  • have a friend, who would like to use TW if it were translated;
  • want to contribute, but don't know how yet.
Best regards,
Yakov.

Reto

unread,
Aug 24, 2023, 5:28:55 AM8/24/23
to TiddlyWikiClassic
The installation worked nicely as described. I disabled my currently used German translation and switched to the provided one - which is a copy of what I used before as I got the translation from github.

The only issue so far - not related to the translations: the list of "explore extensions" gets more and more confusing as there are a lot of entries now.

Reto

unread,
Aug 24, 2023, 5:34:55 AM8/24/23
to TiddlyWikiClassic
And I noticed something else: " explore extensions▾ " in the backstage menu is not translated. The question is, where this should be done ... and who will maintain this. We discussed this before ...

Yakov

unread,
Aug 24, 2023, 5:43:23 AM8/24/23
to TiddlyWikiClassic
Yeah, I totally agree about the extensions list, requires some redesign. I'll probably separate the installed and the available ones into tabs, and also I should probably add some kind of search, just not sure where to start yet.

As for plugin translations, I've got an idea, we can elaborate it: as we have the translations repo and it already has the "locales/core" folder, we may create the "locales/extensions" folder where one can propose a translation of any extension to any language. Listing and installing those will be not that simple, though, but we can start from a single translation of a single plugin and see how it goes.

четверг, 24 августа 2023 г. в 12:34:55 UTC+3, Reto:

Reto

unread,
Aug 24, 2023, 7:13:30 AM8/24/23
to TiddlyWikiClassic
I would be happy to help prototyping for this case. I would translate "explore extensions" to German if there was the file as suggested.

Yakov

unread,
Aug 25, 2023, 9:50:17 AM8/25/23
to TiddlyWikiClassic
Great, here's how we can proceed:
  1. fork the translations repo;
  2. clone it locally (git clone https://github.com/yourName/yourRepo.git);
  3. create a branch, like eep-de-translation (it's just a convention, you can use any name) – git checkout -b eep-de-translation;
  4. create a file (and corresponding folders, I wrote them in italics): locales/extensions/ExtensionsManagerPlugin/locale.de.js
  5. fill it with content like:
    /***
    |Name         |
    ExtensionsExplorerPluginGermanTranslation|
    |Description  |German translation for [[ExtensionsExplorerPlugin|https://github.com/YakovL/TiddlyWiki_ExtensionsExplorerPlugin]]|
    |PluginVersion|0.6.4|
    |Version      |1.0.0 <well, you may want to start from a different version, just remember to update it when you want changes to be findable by EEP>|
    |Requires     |ExtensionsExplorerPlugin|
    ***/
    //{{{
    merge(config.macros.extensionsExplorer.lingo, {
        // TODO: fill with translated strings and functions from lingo;

        //
    if some strings are not translatable yet (
    })
    //}}}
  6. add (git add locales/extensions/ExtensionsManagerPlugin/locale.de.js), commit (git commit -m "feature: add German (de) translation to ExtensionsExplorerPlugin"), push the branch to your repo (git push origin eep-de-translation);
  7. create a pull request (Github will propose that on your repo page), currently to the master branch.
After that, we can discuss details in the PR.

Note: as you've mentioned that you'd like to translate the backstage command, I've checked and found that those strings were, in fact, not in lingo. I've updated this in 0.6.4, but if you notice more strings that are not translatable yet, let me know.
четверг, 24 августа 2023 г. в 14:13:30 UTC+3, Reto:

Yakov

unread,
Aug 26, 2023, 2:02:10 PM8/26/23
to TiddlyWikiClassic
By the way, for those who's interested in updating a core translation: you can take a look on how I've updated ru translation from version 2.6.2 to 2.9.1 (not 2.9.4 yet) here. Commit by commit, I've followed the changes history that I've prepared here. Later, I'm going update the main readme as well to reflect the process.

Note: I was not particularly consistent with commit messages' prefixes, but I've squash-merged them to a single commit, so that wasn't big deal anyway.

пятница, 25 августа 2023 г. в 16:50:17 UTC+3, Yakov:

Reto

unread,
Aug 31, 2023, 8:38:37 AM8/31/23
to TiddlyWikiClassic
Thanks, Yakov, for the detailed instructions. I am sorry to say, but I am struggling with motivation. I guess I could follow the steps, but I fear I will not use this often enough to get really competent in doing it ... and each time I would have to fight to get through the process ...

I understand that it would be ideal if I was able to understand and apply this process, but right now the hurddle is too high. Sorry.

Is there an easier way on GitHub only?

Yakov

unread,
Sep 1, 2023, 6:24:13 AM9/1/23
to TiddlyWikiClassic
Hi Reto, the easiest way would be to post your translation here, and I'll add it to the repo. Likewise, I'm designing a very simple way to contribute to the core translations, presumably it will be a template google sheet with two columns: original string in English and a place for translation. I've updated ru translation and en template from 2.6.0 to 2.9.1 quite quickly (will do to 2.9.4), and updating those in other languages will be a matter of, like, 10 strings or so, so such google sheets should be a very simple way to contribute to updating.

Also, recently I've found the github.dev functionality which I'd like to explore and probably explain to others as it also simplifies the contribution flow. The main bonus is – it allows to contribute solely in browser, without even git installed (but this still requires a Github account). I've already contributed to a couple of repos this way, it's very convenient, but I know VS Code and GitHub well – for others, some instructions are probably needed. If you want to play around with it, try this:
  1. navigate to a file you'd like to contribute to, like https://github.com/TiddlyWiki/translations/blob/master/locales/core/de/locale.de.js
  2. substitute github.com with github.dev in url, i.e. https://github.dev/TiddlyWiki/translations/blob/master/locales/core/de/locale.de.js
  3. edit the file, for instance apply changes for 2.6.3 from here (I've added links to example updates)
  4. open the version control on the left sidebar (can be done by pressing Ctrl + Shift + G)
  5. press "+" for the changed file to stage it (you can also review the change by clicking the file in there)
  6. enter the commit message into the input above, like "feature: update German (de) translation to 2.6.4" (since 2.6.4 has no changes in lingo, it's an update to both 2.6.3 and 2.6.4) and press the button ("Commit & Push" in English)
  7. TODO: I should retest this, but at this point, you'll be probably asked to create a fork if you don't have an access to the repo, agree with this; after the change is applied, you'll have to create a pull request by opening your fork repo (will probably have url like github.com/yourName/translations) and pressing the button in the suggestion to create a PR dialog on the top of the repo.
And yes, you can use this method to add files, too, just open any file first, and add files/folders in the Explorer (Ctrl + Shirt + E) via context menu or the New file/New folder buttons and dragging it to the desired location if you create it in a wrong one.

I'm attaching a quick screencast to illustrate steps 1-6. (TODO: create a screencast for 7, upload to YouTube)
четверг, 31 августа 2023 г. в 15:38:37 UTC+3, Reto:
using github.dev.mp4

Yakov

unread,
Sep 1, 2023, 6:31:22 AM9/1/23
to TiddlyWikiClassic
PS for your convenience, here's one of the ways to create the necessary folders and file (I've misclicked when creating the folder, so I've drag-and-dropped it where I wanted after creating). Thanks for sharing your experience, this is all about creating an easy to use infrastructure

пятница, 1 сентября 2023 г. в 13:24:13 UTC+3, Yakov:
creating a folder and a file.mp4

Yakov

unread,
Sep 2, 2023, 8:10:02 AM9/2/23
to TiddlyWikiClassic
By the way, I've finished updating the en template and core lingo history to 2.9.4, so it's easier to update a translation now (I've also updated ru translation and may be will try to update es or another one). I haven't finished updating the docs though, so if anyone is willing to update a translation, please ask if the process is not clear yet.

пятница, 1 сентября 2023 г. в 13:31:22 UTC+3, Yakov:

Okido

unread,
Sep 3, 2023, 4:45:32 AM9/3/23
to TiddlyWikiClassic
Hello Reto,

To make your work with GitHub a little easier consider using GitHub Desktop.
GitHub Desktop provides a practical graphical environment that spots changes you make on you local files and you can push with 2 or three button clicks the changes to GitHub just as you would do on the command line.

Have a nice day, Okido
 
Op zaterdag 2 september 2023 om 14:10:02 UTC+2 schreef Yakov:

Reto

unread,
Sep 8, 2023, 5:00:43 AM9/8/23
to TiddlyWikiClassic
Hi Yakov, I followed the steps and it worked so far. Now there is this fork of mine ... what happens to it? Do I need to maintain it somehow? I created a PR as it was suggested to me, but I have no clue where I can track it ... oh, ok, found it in the original translations repository.

Reto

unread,
Sep 8, 2023, 5:15:28 AM9/8/23
to TiddlyWikiClassic
I added the file and created a second PR ... only half way knowing what I am doing ...

Yakov

unread,
Sep 9, 2023, 6:22:03 AM9/9/23
to TiddlyWikiClassic
Hi Reto, congratulations and many thanks! I've added comments and answers in both PRs (de core translation update and de EEP translation). Once we finish and merge at least one of them, I'll try to create a more consistent guide and both update docs in the translation repo and add docs in the dev docs (yeah, they are a mess, but at least I've started updating the default tiddler :D and the docs should be stored somewhere anyway).

пятница, 8 сентября 2023 г. в 12:15:28 UTC+3, Reto:
Reply all
Reply to author
Forward
0 new messages