Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
jdelange22 opened this issue Mar 27, 2024 · 5 comments
Open

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

jdelange22 opened this issue Mar 27, 2024 · 5 comments
Labels
help wanted Extra attention is needed

Comments

@jdelange22
Copy link
Contributor

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
Copy link
Owner

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
Copy link
Contributor Author

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
Copy link
Owner

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.

@daniel-lerch daniel-lerch added the help wanted Extra attention is needed label Mar 29, 2024
@jdelange22
Copy link
Contributor Author

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
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@daniel-lerch @jdelange22