SciPost Code Repository

Skip to content
Snippets Groups Projects
Commit 6657c8cd authored by Jean-Sébastien Caux's avatar Jean-Sébastien Caux
Browse files

Update report form (toggle between required only, or all fields)

parent 84a8160d
No related branches found
No related tags found
No related merge requests found
......@@ -2,8 +2,11 @@ $(document).ready(function(){
$('#showSimpleReportButton').show();
$('#showFullReportButton').hide();
$('#reportSelectorButton').on('click', function () {
$('#showSimpleReportText').toggle();
$('#showSimpleReportButton').toggle();
$('#showFullReportText').toggle();
$('#showFullReportButton').toggle();
$('#id_qualification').parent('div').parent('div').toggle();
$('#id_strengths').parent('div').parent('div').toggle();
$('#id_weaknesses').parent('div').parent('div').toggle();
$('#id_requested_changes').parent('div').parent('div').toggle();
......
......@@ -1038,7 +1038,7 @@ class ReportForm(forms.ModelForm):
model = Report
fields = ['qualification', 'strengths', 'weaknesses', 'report', 'requested_changes',
'validity', 'significance', 'originality', 'clarity', 'formatting', 'grammar',
'recommendation', 'remarks_for_editors', 'anonymous', 'file_attachment']
'recommendation', 'remarks_for_editors', 'file_attachment', 'anonymous']
def __init__(self, *args, **kwargs):
if kwargs.get('instance'):
......@@ -1074,16 +1074,19 @@ class ReportForm(forms.ModelForm):
'cols': 100
})
self.fields['file_attachment'].label = 'File attachment (for a figure or similar)'
# Required fields on submission; optional on save as draft
if 'save_submit' in self.data:
required_fields = ['report', 'recommendation', 'qualification']
required_fields = ['report', 'recommendation']
else:
required_fields = []
required_fields_label = ['report', 'recommendation', 'qualification']
required_fields_label = ['report', 'recommendation']
# If the Report is not a followup: Explicitly assign more fields as being required!
if not self.instance.is_followup_report and self.submission.submitted_to.name != SCIPOST_JOURNAL_PHYSICS_PROC:
required_fields_label += [
# 'qualification',
# 'strengths',
# 'weaknesses',
# 'requested_changes',
......@@ -1095,6 +1098,7 @@ class ReportForm(forms.ModelForm):
# 'grammar'
]
required_fields += [
# 'qualification',
# 'strengths',
# 'weaknesses',
# 'requested_changes',
......
<h3 class="mb-4">Preview of your report as it will publicly be shown</h3>
<h3 class="mb-4">Preview of your report as it will be publicly seen</h3>
<div class="report report-preview">
<div class="reportid">
......
......@@ -33,12 +33,42 @@
<div class="card-body">
<h2>Your {% if form.instance.is_followup_report %}followup {% endif %}report:</h2>
<p>A preview of text areas will appear below as you type (you can use $\LaTeX$ \$...\$ for in-text equations or \ [ ... \ ] for on-line equations).</p>
<p class="mb-0">Any fields with an asterisk (*) are required.</p>
<button class="btn btn-primary" id="reportSelectorButton">
<span id="showSimpleReportButton">Show simplified Report form</span>
<span id="showFullReportButton">Show full Report form</span>
</button>
{% if form.instance.is_followup_report %}
<p>Before you get started, please make sure you are familiar with our <a href="https://scipost.org{% url 'submissions:referee_guidelines' %}" target="_blank">referee guidelines</a>, <a href="https://scipost.org{% url 'submissions:sub_and_ref_procedure' %}" target="_blank">refereeing procedure</a> and <a href="{% url 'journals:journals_terms_and_conditions' %}#referee_code_of_conduct" target="_blank">referee code of conduct</a>.</p>
<div class="mb-0">
<table class="table">
<tr>
<th>Required fields</th>
<td>
<ul>
<li>text field for <em>report</em></li>
<li><em>recommendation</em> (publish? revise? reject?)</li>
<li><em class="text-muted">optional remarks for the editors only</em></li>
<li><em>anonymity</em> specifier</li>
</ul>
</td>
</tr>
<tr>
<th>Optional fields</th>
<td>
<ul>
<li><em>qualification</em> specifier</li>
<li>text fields for <em>strengths, weaknesses, report, requested changes</em></li>
<li>and specifiers for <em>validity, significance, originality, clarity, formatting</em> and <em>grammar</em></li>
</ul>
</td>
</tr>
</table>
<button class="btn btn-primary px-2 py-1" id="reportSelectorButton">
<span id="showSimpleReportButton">
Show required fields only
</span>
<span id="showFullReportButton">
Show all fields
</span>
</button>
</div>
{% if form.instance.is_followup_report %}
<p class="mb-0">
Because you have already submitted a Report for this Submission series, not all fields are required.
</p>
......@@ -90,6 +120,6 @@
{% block footer_script %}
<script src="{% static 'scipost/toggle-report-fields.js' %}">
<script src="{% static 'scipost/toggle-report-fields.js' %}"></script>
<script src="{% static 'scipost/report-preview.js' %}"></script>
{% endblock %}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment