search

morning4coffe-dev / storylines

Storylines is a modern text editor for writing stories divided into chapters.
https://www.microsoft.com/store/apps/9PN77P9WJ3CX
MIT License
79 stars 4 forks source link

Creating contributing guidelines #8

Closed ghost closed 2 years ago

ghost commented 2 years ago

It would be a good idea to create CONTRIBUTING.md in repository for the convenience of contributors. I'd like to help with internationalization and localization, but I expect a detailed description of this process in the context of this app.

As an example of such a file in the UWP app repository, I can refer to DevToys.

morning4coffe-dev commented 2 years ago

Thank you for your great suggestion! I hope to have some free time tomorrow, so I will look into it.

morning4coffe-dev commented 2 years ago

I created the CONTRIBUTING to Storylines document with some guidelines on how to run and build Storylines and what to make sure and what to avoid during the Internationalization and localization process. Expect an update with more description on how to add a new translation into the project soon, but the process should be similar to the DevToys.

ghost commented 2 years ago

Expect an update with more description on how to add a new translation into the project soon, but the process should be similar to the DevToys.

Definitely need clarification, because now it's not quite clear where to add information about the presence of the new language and whether something needs to be added to MultilingualResources. For example, DevToys uses LanguageManager.tt, but Storylines does it differently.

morning4coffe-dev commented 2 years ago

You are right. I haven't really looked into how it works in DevToys, but Storylines uses the Multilingual app toolkit and after you install the extension and the editor it is pretty straightforward.

I want it for the contributors to be as easy as possible, so do you think I can explain it like this?:

Download the MAT (Multilingual app toolkit) extension into your Visual studio -> right click on the project in Solution explorer -> MAT -> Add translation languages -> choose the language you want to translate to -> find the newly added .xlf file for the chosen language in the Solution explorer -> open the file in the MAT editor and you are ready to go

ghost commented 2 years ago

This is certainly good, but the best explanation is one that doesn't involve working with Visual Studio to translate at all. Is it possible to translate Storylines just by editing the files manually? If so, that's better.

morning4coffe-dev commented 2 years ago

To be honest I am not quite sure. There is a way to not use the MAT editor and just open the .xlf file in some text editor and edit the code, but I don't know about a way to generate those files without the VS extension. And if there is a way, then you would still need it to build the app with the new translation for testing. But could be interesting to try.

morning4coffe-dev commented 2 years ago

Thank you again for this great suggestion. Yesterday, I updated the CONTRIBUTING to Storylines document with the 0.6.8 code update I have been working on. It now contains all the important things to Build and Run Storylines from the source and to add/update translations even without the MAT editor. Unfortunately, I did not find a way to avoid using MAT extension, but that said I am currently starting to work on a #14 and I am currently experimenting with some other possibilities.