WIP: Webhelp revisions #668
Open
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
|
I merged and modified (again) the css styles. Also, "Additional screenshot" and "Tidying up orphaned webUI files" were pushed to master. I'll work on makefile changes to sync the webui html pages automatically and intl support (redirections). |
|
I moved docs/html/ files to docs/html/en subtree and imported the initial version generated from markdown manually. Just for testing.. |
perexg
force-pushed
the
master
branch
18 times, most recently
from
c193390
to
9ca5166
Compare
Stanej1
approved these changes
Jun 10, 2020
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.
Right, so people can see it - while it's mergeable, it will need more updating and would benefit from some discussion (and probably correction, I don't pretend to be a CSS expert).
So... "caveat patcher".
This PR basically:
Replaces the bundled html webUI help files with auto-generated versions of the User Guide chapters
These will constantly change until we have stable documentation - you can see the gaps in the examples below
The use of pandoc as a translator is also under review, but the sense of 'write once, use many' is valid
Adds a chunk of CSS to style the webUI help (I did just find some 6-year-old styling, but I think it's getting ignored - I did this from scratch anyway)
I'm fairly happy with this, but I may have committed some terrible crime against W3C
Tidies up a few dead files that don't appear to be used any more.
Examples of styled help screens: