Ftr/471 enhance update help page #497
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this commit updates the metadata, eg add orcid IDs, update link, delete outdated addresses Refs #471
this commit updated the <front> text with some simplifications of sentences. Preparation chapter is deleted, because of two reasons. first, it is totally outdated and describes how to install the software from a DVD. Second, how to setup an Edirom locally is described in the docs-directory of the software-repository, the USER help is not an appropriate place for this. refs #471
this commits does a lot of clean up: delete deprecated content (eg installation from DVD), sum up text, delete duplicate text, re-structure, shorten and simplify sentences, move comments to appropriate issues refs #471
this commit corrects some typos and structure refs #471
this commits completely updated the help using the german help-file as a template. refs #471
|
It seems like language keys are not resolved in figure texts. And @krHERO Do you see the images?
|
|
hi @daniel-jettka and thanks for taking care about this PR. yes i can see the images. @roewenstrunk found out, that exist seems to "forget" the images locally. so after adding them again to the images folder via exide: file - manage - navigate to images folder and "upload-cloud". after this, you can see the images locally. with loading images also the language keys are resolved. 
|
daniel-jettka
approved these changes
Dec 11, 2024
There was a problem hiding this comment.
I generally approve.
There is just an issue with nested language keys (extra whitespace), but I will create another issue for this... #499
This was referenced Dec 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description, Context and related Issue
the help files were more than 10 years un-touched, so some deprecated information had to be deleted, eg installation advices for DVD. the file had a lot of comments, that were resolved. the file had some duplicate texts (even repeating one image), so a lot clean up had to be made. also a lot restructuring needed to be done, since text, a topic was started and linked to the explanation several (sub)chapters away, so all parts that belong together were put together now.
some too long (and too detailed) explanations needed to be simplified/shortened.
refs #471 #28
How Has This Been Tested?
proof-red the german and english help file with sample edition and klarinettenquintett.
Types of changes
Overview