Skip to content

Extract HTML report layout into Templates fragments #196

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

Open
ewels wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Extract HTML report layout into Templates fragments #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3935f2f
Extract HTML report layout into Templates fragments
cursoragent May 20, 2026
518614d
Format HTML report template fragments with 2-space indent
cursoragent May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ zcat *fastq.gz | fastqc stdin:my_results
If you want to run FastQC as part of a sequencing pipeline you may wish to change the
formatting of the report to add in your own branding or to include extra information.

In the Templates directory you will find a file called `header_template.html` which
In the Templates directory you will find a file called `fastqc.css` which
you can edit to change the look of the report. This file contains all of the header for
the report file, including the CSS section and you can alter this however you see fit.

Expand Down
0 Templates/header_template.html → Templates/fastqc.css
View file
Open in desktop
File renamed without changes.
6 changes: 6 additions & 0 deletions Templates/module_wrapper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div class="module">
<h2 id="M{{MODULE_INDEX}}">
<img src="{{ICON}}" alt="{{ALT}}"/>{{MODULE_NAME}}
</h2>
{{MODULE_CONTENT}}
</div>
31 changes: 31 additions & 0 deletions Templates/report_template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!DOCTYPE html>
<html>
<head>
<title>{{TITLE}} FastQC Report</title>
<style type="text/css">
{{CSS_CONTENT}}
</style>
</head>
<body>
<div class="header">
<div id="header_title">
<img src="{{FASTQC_ICON}}" alt="FastQC"/>FastQC Report
</div>
<div id="header_filename">
{{DATE}}<br/>{{FILENAME}}
</div>
</div>
<div class="summary">
<h2>Summary</h2>
<ul>
{{SUMMARY_ITEMS}}
</ul>
</div>
<div class="main">
{{MODULE_CONTENT}}
</div>
<div class="footer">
Produced by <a href="http://www.bioinformatics.babraham.ac.uk/projects/fastqc/">FastQC</a> (version {{VERSION}})
</div>
</body>
</html>
4 changes: 4 additions & 0 deletions Templates/sidebar_item.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<li>
<img src="{{ICON}}" alt="{{ALT}}"/>
<a href="#M{{MODULE_INDEX}}">{{MODULE_NAME}}</a>
</li>
Loading