search

daniel-lerch / vocup

Vocabulary trainer.
https://www.microsoft.com/store/apps/9N6W2H3QJQMM
GNU Affero General Public License v3.0
9 stars 3 forks source link

The help file is in a difficult format to maintain and in German only #55

Open jdelange22 opened 8 months ago

jdelange22 commented 8 months ago

As the title says, the help file is in a .chm format, which is a kindof old format and not very easy to maintain. In fact the help file contents is HTML which itself is much easier to maintain and keep up-to-date. Would like to hear your thoughts about this. Perheps an online HTML version is an option?

daniel-lerch commented 8 months ago

I do not have time to update any help resources for Vocup so I just left the legacy .chm file to have at least something.

Feel free to bring up ideas for a new help if you would like to contribute to it. In terms of online help I also have a domain and server ready for Vocup to host anything that can run in a Docker container.

jdelange22 commented 8 months ago

I understand this completely. I think that using an online help page is more according to today's standards and much easier to maintain. In fact you can even put a dedicated repository up for a website (idea) and documentation/help. I'm willing to assist in translation if this is needed.

daniel-lerch commented 7 months ago

An online help would definitely be desirable but my focus for Vocup is working on features if I ever get work on it. So I might be able to translate a website and online help into German and can discuss different technologies and take care of hosting. For creating a website and online help I do not have time.

jdelange22 commented 7 months ago

Fair enough, I understand you want to focus on development on the program and not on maintaining a website. Might be useful to create a seperate issue regarding feature requests concerning a possible website, not cluttering the issue tracker of the main program. Perhaps in a seperate repo. Just a questing regarding the help-file in its current format. Do you happen to have the original help source or a ".hpp" file as this is needed for editing a .chm file as I read on the internet? If so, it is possible to make different files for each language.

daniel-lerch commented 7 months ago

Unfortunately, I do not have any of the original sources that Florian Amstutz used to compile the .chm file anymore.