Extract HTML report layout into Templates fragments#196
Open
ewels wants to merge 2 commits into
Open
Conversation
Move stylesheet to Templates/fastqc.css and split the static HTML scaffold into report_template.html, sidebar_item.html, and module_wrapper.html. HTMLReportArchive assembles these with placeholder replacement; module bodies are still generated via XMLStreamWriter. Output verified byte-identical against master for test/data/minimal.fastq. Co-authored-by: Phil Ewels <phil.ewels@seqera.io>
Makes report_template.html, sidebar_item.html, and module_wrapper.html easier to read and edit. Generated HTML reports are no longer minified. Co-authored-by: Phil Ewels <phil.ewels@seqera.io>
Contributor
Author
|
Ack I couldn't do it sorry, I couldn't resist pushing a second commit that added whitespace to the HTML template files. It'll add additional whitespace to the HTML reports so no longer byte-identical, feel free to revert if you like. It is just a lot easier to read when it's indented. |
Draft
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Another small change split off from #161
This one refactors how the HTML reports are generated a bit - instead of using the Java HTML constructor walker (which makes me want to stab forks in my leg) I've introduced some HTML fragment templates. The Java code pulls these in and then swaps out some
{{THING}}placeholders with the dynamic bits.There was also a CSS file that had a HTML file ending, which I renamed to be
.csswithout any content changing so that stuff like syntax highlighting etc. works.Outputs are byte-identical against master for
test/data/minimal.fastq, so this is really a dev-only refactoring that should have zero impact on outputs.