alanorth/csv-metadata-quality-web
1
0
Fork 0
mirror of https://github.com/ilri/csv-metadata-quality-web.git synced 2024-11-01 04:43:00 +01:00
Code Issues Projects Releases Wiki Activity
070d19af82
csv-metadata-quality-web/csv_metadata_quality_web/templates/index.html

53 lines
4.1 KiB
HTML
Raw Normal View History

Add simple HTML template with file upload Code taken from the following blog posts: - https://pythonbasics.org/flask-upload-file - https://blog.miguelgrinberg.com/post/handling-file-uploads-with-flask
2021-03-11 14:55:58 +01:00
<!doctype html>
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/
2021-03-11 19:28:42 +01:00
<html lang="en" class="h-100">
Split index.html template into header, index, and footer
2021-03-11 21:41:22 +01:00
{% include 'head.html' %}
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/
2021-03-11 19:28:42 +01:00
<body class="d-flex flex-column h-100">
Major refactor Refactor the templates to include a header, use csv-metadata-quality in a subshell instead of trying to import and pass args to it (which I actually managed to do, but then trying to capture the output was an issue), and use ansi2html to prepare the CLI output as the HTML.
2021-03-12 18:14:49 +01:00
{% include 'header.html' %}
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/
2021-03-11 19:28:42 +01:00
<main class="flex-shrink-0">
Major refactor Refactor the templates to include a header, use csv-metadata-quality in a subshell instead of trying to import and pass args to it (which I actually managed to do, but then trying to capture the output was an issue), and use ansi2html to prepare the CLI output as the HTML.
2021-03-12 18:14:49 +01:00
<div class="container py-3">
Major refactor Re-work upload and file processing so they are in the same Python function. Now I will start exposing other command line options in the form, like unsafe fixes, excluding fields, etc. Now I see tha t it is easier to save the POSTed file and process it in the same function so I don't have to pass around the other POSTed form val ues as URL query parameters. Now, as a result of changing the flow above, I also had to make a change to the way I show the results page. Instead of processing the file and returning the rendered results to the user directly, I process the file, save the rendered results to /tmp, and return a redirect to the user to the results page.
2021-03-13 21:11:26 +01:00
<p class="lead">The DSpace CSV Metadata Quality Checker is a collection of sanity checks and automated fixes for a number of common issues in metadata files.</p>
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/
2021-03-11 19:28:42 +01:00
<form method="POST" action="" enctype="multipart/form-data">
templates/index.html: Use Bootstrap form components
2021-03-13 12:50:46 +01:00
<div class="mb-3">
templates/index.html: Add link to test.csv Offer the user to test with this file.
2021-03-14 10:34:55 +01:00
<label for="formFile" class="form-label">Select a CSV file to process (or try <a href="https://raw.githubusercontent.com/ilri/csv-metadata-quality/master/data/test.csv">test.csv</a>)</label>
templates/index.html: Use Bootstrap form components
2021-03-13 12:50:46 +01:00
<input class="form-control" type="file" id="formFile" name="file" accept=".csv">
</div>
Add support for skipping fields ("-x")
2021-03-13 22:34:11 +01:00
<div class="input-group mb-3">
<div class="input-group-text">
Skip fields(s)&nbsp;
<input class="form-check-input" type="checkbox" id="excludeFieldsCheckbox" name="excludeCheckbox" aria-label="Checkbox for following text input">
</div>
<input type="text" class="form-control" placeholder="dcterms.subject" id="excludeFieldsText" name="excludeText" aria-label="Text input with checkbox">
<div id="excludeHelp" class="form-text">Optionally indicate fields to skip during analysis. Separate multiple fields with a comma, for example: <code>dcterms.issued,dcterms.subject</code>.</div>
</div>
Add AGROVOC lookup support This works locally, but I don't think it will work on App Engine because csv-metadata-quality uses requests-cache and creates the agrovoc-response-cache.sqlite file in the current working directory.
2021-03-13 22:49:24 +01:00
<div class="input-group mb-3">
<div class="input-group-text">
Validate field(s) against AGROVOC&nbsp;
templates/index.html: Change default selections Enable AGROVOC lookup on dcterms.subject as well as the "unsafe" fixes. For the AGROVOC lookup I just think that it might not be obvious to non-technical users that you have to check the box AND enter a field name, despite the placeholder value. In any case, it doesn't hurt to enable AGROVOC lookup by default because it won't fail if the default dcterms.subject field is not present in the user's CSV.
2021-03-14 19:51:02 +01:00
<input class="form-check-input" type="checkbox" checked="true" id="agrovocFieldsCheckbox" name="agrovocCheckbox" aria-label="Checkbox for following text input">
Add AGROVOC lookup support This works locally, but I don't think it will work on App Engine because csv-metadata-quality uses requests-cache and creates the agrovoc-response-cache.sqlite file in the current working directory.
2021-03-13 22:49:24 +01:00
</div>
templates/index.html: Change default selections Enable AGROVOC lookup on dcterms.subject as well as the "unsafe" fixes. For the AGROVOC lookup I just think that it might not be obvious to non-technical users that you have to check the box AND enter a field name, despite the placeholder value. In any case, it doesn't hurt to enable AGROVOC lookup by default because it won't fail if the default dcterms.subject field is not present in the user's CSV.
2021-03-14 19:51:02 +01:00
<input type="text" class="form-control" value="dcterms.subject" id="agrovocFieldsText" name="agrovocText" aria-label="Text input with checkbox">
Add AGROVOC lookup support This works locally, but I don't think it will work on App Engine because csv-metadata-quality uses requests-cache and creates the agrovoc-response-cache.sqlite file in the current working directory.
2021-03-13 22:49:24 +01:00
<div id="agrovocHelp" class="form-text">Optionally indicate fields to validate against <a href="https://agrovoc.uniroma2.it/agrovoc/agrovoc/en/" title="AGROVOC Multilingual Thesaurus">AGROVOC</a>. Separate multiple fields with a comma, for example: <code>dcterms.subject,cg.coverage.country</code>. Note: this can take an extra minute or more depending on your data. If you have a problem please try again and it will generally be faster the second time.</div>
</div>
Major refactor Re-work upload and file processing so they are in the same Python function. Now I will start exposing other command line options in the form, like unsafe fixes, excluding fields, etc. Now I see tha t it is easier to save the POSTed file and process it in the same function so I don't have to pass around the other POSTed form val ues as URL query parameters. Now, as a result of changing the flow above, I also had to make a change to the way I show the results page. Instead of processing the file and returning the rendered results to the user directly, I process the file, save the rendered results to /tmp, and return a redirect to the user to the results page.
2021-03-13 21:11:26 +01:00
<div class="mb-3 form-check form-switch">
templates/index.html: Change default selections Enable AGROVOC lookup on dcterms.subject as well as the "unsafe" fixes. For the AGROVOC lookup I just think that it might not be obvious to non-technical users that you have to check the box AND enter a field name, despite the placeholder value. In any case, it doesn't hurt to enable AGROVOC lookup by default because it won't fail if the default dcterms.subject field is not present in the user's CSV.
2021-03-14 19:51:02 +01:00
<input class="form-check-input" type="checkbox" checked="true" id="unsafeCheckbox" name="unsafe">
Use "unsafe" in quotes on frontpage This was more me being cautious when I was writing the original tool than a warning about it being actually unsafe. Now that this web fro ntend will be used by less-technical users I should tone down the la nguage.
2021-03-16 12:04:33 +01:00
<label class="form-check-label" for="unsafeCheckbox" aria-describedby="unsafeHelp">Enable "unsafe" fixes</label>
Update csv-metadata-quality version for Mojibake support
2021-03-19 10:59:21 +01:00
<div id="unsafeHelp" class="form-text">This will remove newlines, perform <a href="https://withblue.ink/2019/03/11/why-you-need-to-normalize-unicode-strings.html" title='When "Zoë" !== "Zoë". Or why you need to normalize Unicode strings'>normalization of Unicode characters</a>, and attempt to fix <a href="https://en.wikipedia.org/wiki/Mojibake">mojibake</a> character encoding issues. Read more about these <a href="https://github.com/ilri/csv-metadata-quality#unsafe-fixes">unsafe fixes</a>.</div>
Major refactor Re-work upload and file processing so they are in the same Python function. Now I will start exposing other command line options in the form, like unsafe fixes, excluding fields, etc. Now I see tha t it is easier to save the POSTed file and process it in the same function so I don't have to pass around the other POSTed form val ues as URL query parameters. Now, as a result of changing the flow above, I also had to make a change to the way I show the results page. Instead of processing the file and returning the rendered results to the user directly, I process the file, save the rendered results to /tmp, and return a redirect to the user to the results page.
2021-03-13 21:11:26 +01:00
</div>
Add support for experimental checks ("-e")
2021-03-13 22:01:11 +01:00
<div class="mb-3 form-check form-switch">
<input class="form-check-input" type="checkbox" id="experimentalCheckbox" name="experimental">
<label class="form-check-label" for="experimentalCheckbox" aria-describedby="experimentalHelp">Enable experimental checks</label>
<div id="experimentalHelp" class="form-text">Attempt to validate whether the value of an item's <code>dc.language.iso</code> or <code>dcterms.language</code> field matches the <em>actual</em> language of text used in its title, abstract, and citation. Read more about these <a href="https://github.com/ilri/csv-metadata-quality#experimental-checks">experimental checks</a>.</div>
</div>
templates/index.html: Use Bootstrap form components
2021-03-13 12:50:46 +01:00
<button type="submit" class="btn btn-primary">Submit</button>
templates/index.html: Improve layout Based on the Bootstrap v5.0-beta2 sticky footer example. See: https://getbootstrap.com/docs/5.0/examples/sticky-footer/
2021-03-11 19:28:42 +01:00
</form>
</div>
</main>
Split index.html template into header, index, and footer
2021-03-11 21:41:22 +01:00
{% include 'footer.html' %}
Add simple HTML template with file upload Code taken from the following blog posts: - https://pythonbasics.org/flask-upload-file - https://blog.miguelgrinberg.com/post/handling-file-uploads-with-flask
2021-03-11 14:55:58 +01:00
</body>
</html>
Reference in New Issue Copy Permalink