vrtmrz / obsidian-livesync

MIT License
4.69k stars 151 forks source link

English translation and explanation of settings #416

Open MichaelBrunn3r opened 5 months ago

MichaelBrunn3r commented 5 months ago

First of all, huge fan of this plugin. It gave me the final push to switch to Obsidian. Thanks for the awesome work.

While configuring this plugin, I noticed that there are many small grammatical errors in the english translation. There is also the issue of unclear settings. Some descriptions are hard to read:

https://github.com/vrtmrz/obsidian-livesync/blob/2ae018b2bdbffb4f45d9347c3cc22b7365758fab/src/ui/ObsidianLiveSyncSettingTab.ts#L1837

For other settings it is unclear what exactly they do:

https://github.com/vrtmrz/obsidian-livesync/blob/2ae018b2bdbffb4f45d9347c3cc22b7365758fab/src/ui/ObsidianLiveSyncSettingTab.ts#L1571 https://github.com/vrtmrz/obsidian-livesync/blob/2ae018b2bdbffb4f45d9347c3cc22b7365758fab/src/ui/ObsidianLiveSyncSettingTab.ts#L1017

(What are mega chars)

I would love to help improving the english translation, but the quantity is too much for me to just create a Pull request. The grammar issues are easy to fix, but some sentences need restructuring (in my opinion) without loosing their meaning. Some settings are also in need of more explanations. Like what are chunks, batches? Difference between local database, remote database, vault, storage, etc.

Is there any work going on to resolve these issues? Can I help?

vrtmrz commented 4 months ago

I am so happy to hear the honourable! And so grateful to giving us your contribution!

Actually, and espetially in the begenning of this plug-in. I was so poor at English. (It is still not good, but getting better -- I hope). So your offer is very helpful. So happy to merge your pull request!

Some settings are also in need of more explanations. Like what are chunks, batches? Difference between local database, remote database, vault, storage, etc.

These words has been descrived in quite different issues or discussions. However as you mentioned, we are lacking an unified terms document.

Therefore, I made the stub of that. Please feel free to write any terms that should be mentioned. And please make pull request. I would love to fill the rest!