diff --git a/airlock/forms.py b/airlock/forms.py index 93f00fc1..5eb99183 100644 --- a/airlock/forms.py +++ b/airlock/forms.py @@ -1,5 +1,6 @@ from django import forms from django.forms.formsets import BaseFormSet, formset_factory +from django.utils.safestring import mark_safe from airlock.enums import RequestFileType, Visibility from airlock.models import FileGroup @@ -124,8 +125,45 @@ def clean(self): class GroupEditForm(forms.Form): - context = forms.CharField(required=False) - controls = forms.CharField(required=False) + context = forms.CharField( + required=False, + help_text=mark_safe( + """ +
+ Please describe the contents of these outputs to help reviewers. This includes: + +
+ """ + ), + ) + controls = forms.CharField( + required=False, + help_text=mark_safe( + """ +
+ Please describe the statistical disclosure controls you have applied to these outputs. This includes: + +
+ """ + ), + ) + + def __init__(self, *args, **kwargs): + inline = kwargs.pop("inline", False) + super().__init__(*args, **kwargs) + if inline: + # Hide the help text if the form is inlined (i.e. it's) + # being opened as readonly from a file view + for field in ["context", "controls"]: + self.fields[field].help_text = "" @classmethod def from_filegroup(cls, filegroup: FileGroup, *args, **kwargs): diff --git a/airlock/templates/file_browser/request/filegroup.html b/airlock/templates/file_browser/request/filegroup.html index b1fdbabd..ea50d8d6 100644 --- a/airlock/templates/file_browser/request/filegroup.html +++ b/airlock/templates/file_browser/request/filegroup.html @@ -6,6 +6,12 @@ .comments .comment_blinded { background-color: darkgrey; } + + .c2-help { + line-height: 1.6; + font-size: small; + } + {% #card title=group.title container=True class="group_modal" %}
@@ -13,10 +19,11 @@ {% csrf_token %}
- {% form_textarea field=group.c2_edit_form.context show_placeholder=True resize=True placeholder="Describe the data to be released in this group of files" class="w-full max-w-lg mx-auto" rows=6 disabled=group.c2_readonly readonly=group.c2_readonly %} + + {% form_textarea field=group.c2_edit_form.context resize=True hint_below=True show_placeholder=True placeholder="Describe the data to be released in this group of files" class="w-full max-w-lg mx-auto" rows=6 disabled=group.c2_readonly readonly=group.c2_readonly %}
- {% form_textarea field=group.c2_edit_form.controls resize=True show_placeholder=True placeholder="Describe the disclosure controls that have been applied to these files" class="w-full max-w-lg mx-auto" rows=6 disabled=group.c2_readonly readonly=group.c2_readonly %} + {% form_textarea field=group.c2_edit_form.controls resize=True hint_below=True show_placeholder=True placeholder="Describe the disclosure controls that have been applied to these files" class="w-full max-w-lg mx-auto" rows=6 disabled=group.c2_readonly readonly=group.c2_readonly %}
{% if not group.c2_readonly %} diff --git a/airlock/views/request.py b/airlock/views/request.py index 6eafbb71..10ee0b75 100644 --- a/airlock/views/request.py +++ b/airlock/views/request.py @@ -386,7 +386,7 @@ def group_presenter(release_request, relpath, request): "inline": inline, # context/controls editing "c2_readonly": c2_readonly, - "c2_edit_form": GroupEditForm.from_filegroup(filegroup), + "c2_edit_form": GroupEditForm.from_filegroup(filegroup, inline=inline), "c2_edit_url": reverse( "group_edit", kwargs={"request_id": release_request.id, "group": group}, diff --git a/docs/screenshots/add_file_button.png b/docs/screenshots/add_file_button.png index 2765c561..e97e5757 100644 Binary files a/docs/screenshots/add_file_button.png and b/docs/screenshots/add_file_button.png differ diff --git a/docs/screenshots/add_file_modal.png b/docs/screenshots/add_file_modal.png index 15c37be8..88f5cf53 100644 Binary files a/docs/screenshots/add_file_modal.png and b/docs/screenshots/add_file_modal.png differ diff --git a/docs/screenshots/changed_tree_file.png b/docs/screenshots/changed_tree_file.png index 4912e920..69cc699c 100644 Binary files a/docs/screenshots/changed_tree_file.png and b/docs/screenshots/changed_tree_file.png differ diff --git a/docs/screenshots/context_and_controls.png b/docs/screenshots/context_and_controls.png index aa170f88..4f1104c0 100644 Binary files a/docs/screenshots/context_and_controls.png and b/docs/screenshots/context_and_controls.png differ diff --git a/docs/screenshots/context_modal.png b/docs/screenshots/context_modal.png index 4c17f630..6dbf2036 100644 Binary files a/docs/screenshots/context_modal.png and b/docs/screenshots/context_modal.png differ diff --git a/docs/screenshots/file_approved.png b/docs/screenshots/file_approved.png index efbb6543..335d9030 100644 Binary files a/docs/screenshots/file_approved.png and b/docs/screenshots/file_approved.png differ diff --git a/docs/screenshots/file_group.png b/docs/screenshots/file_group.png index cbefe459..89815326 100644 Binary files a/docs/screenshots/file_group.png and b/docs/screenshots/file_group.png differ diff --git a/docs/screenshots/file_review.png b/docs/screenshots/file_review.png index 2d00edf1..29155e02 100644 Binary files a/docs/screenshots/file_review.png and b/docs/screenshots/file_review.png differ diff --git a/docs/screenshots/file_update.png b/docs/screenshots/file_update.png index 707648f5..291221cf 100644 Binary files a/docs/screenshots/file_update.png and b/docs/screenshots/file_update.png differ diff --git a/docs/screenshots/file_update_modal copy.png b/docs/screenshots/file_update_modal copy.png deleted file mode 100644 index f000ab64..00000000 Binary files a/docs/screenshots/file_update_modal copy.png and /dev/null differ diff --git a/docs/screenshots/file_update_modal.png b/docs/screenshots/file_update_modal.png index e5e1840a..dcb5f7f4 100644 Binary files a/docs/screenshots/file_update_modal.png and b/docs/screenshots/file_update_modal.png differ diff --git a/docs/screenshots/files_released.png b/docs/screenshots/files_released.png index 6139feb7..49a8b40c 100644 Binary files a/docs/screenshots/files_released.png and b/docs/screenshots/files_released.png differ diff --git a/docs/screenshots/more_dropdown.png b/docs/screenshots/more_dropdown.png index e034a9f6..0f099780 100644 Binary files a/docs/screenshots/more_dropdown.png and b/docs/screenshots/more_dropdown.png differ diff --git a/docs/screenshots/more_dropdown_el.png b/docs/screenshots/more_dropdown_el.png index e055fe86..917aeab5 100644 Binary files a/docs/screenshots/more_dropdown_el.png and b/docs/screenshots/more_dropdown_el.png differ diff --git a/docs/screenshots/more_dropdown_el_request_file.png b/docs/screenshots/more_dropdown_el_request_file.png index bee5a73d..41a2e91b 100644 Binary files a/docs/screenshots/more_dropdown_el_request_file.png and b/docs/screenshots/more_dropdown_el_request_file.png differ diff --git a/docs/screenshots/multiselect_update.png b/docs/screenshots/multiselect_update.png index faaddfa4..6661d59f 100644 Binary files a/docs/screenshots/multiselect_update.png and b/docs/screenshots/multiselect_update.png differ diff --git a/docs/screenshots/ready_to_release.png b/docs/screenshots/ready_to_release.png index cf8b0094..c3b262eb 100644 Binary files a/docs/screenshots/ready_to_release.png and b/docs/screenshots/ready_to_release.png differ diff --git a/docs/screenshots/request_independent_review_file_icons.png b/docs/screenshots/request_independent_review_file_icons.png index a9db3e28..c4d6e3d7 100644 Binary files a/docs/screenshots/request_independent_review_file_icons.png and b/docs/screenshots/request_independent_review_file_icons.png differ diff --git a/docs/screenshots/request_independent_review_researcher_file_icons.png b/docs/screenshots/request_independent_review_researcher_file_icons.png index 550ab40d..9dd77cc8 100644 Binary files a/docs/screenshots/request_independent_review_researcher_file_icons.png and b/docs/screenshots/request_independent_review_researcher_file_icons.png differ diff --git a/docs/screenshots/request_overview.png b/docs/screenshots/request_overview.png index a60f1816..4ebaeebc 100644 Binary files a/docs/screenshots/request_overview.png and b/docs/screenshots/request_overview.png differ diff --git a/docs/screenshots/request_reviewed_file_icons.png b/docs/screenshots/request_reviewed_file_icons.png index 76880c53..cdf62654 100644 Binary files a/docs/screenshots/request_reviewed_file_icons.png and b/docs/screenshots/request_reviewed_file_icons.png differ diff --git a/docs/screenshots/request_tree.png b/docs/screenshots/request_tree.png index 1663b0d0..748adf39 100644 Binary files a/docs/screenshots/request_tree.png and b/docs/screenshots/request_tree.png differ diff --git a/docs/screenshots/request_tree_post_voting.png b/docs/screenshots/request_tree_post_voting.png index fcea5c9c..73bf82b7 100644 Binary files a/docs/screenshots/request_tree_post_voting.png and b/docs/screenshots/request_tree_post_voting.png differ diff --git a/docs/screenshots/requests_index.png b/docs/screenshots/requests_index.png index 879e3d0b..b72f72b2 100644 Binary files a/docs/screenshots/requests_index.png and b/docs/screenshots/requests_index.png differ diff --git a/docs/screenshots/returned_request_comments.png b/docs/screenshots/returned_request_comments.png index 1be4128f..79ce9dbd 100644 Binary files a/docs/screenshots/returned_request_comments.png and b/docs/screenshots/returned_request_comments.png differ diff --git a/docs/screenshots/returned_tree.png b/docs/screenshots/returned_tree.png index 86b247ca..42fd3b94 100644 Binary files a/docs/screenshots/returned_tree.png and b/docs/screenshots/returned_tree.png differ diff --git a/docs/screenshots/reviewed_request_comment_in_progress.png b/docs/screenshots/reviewed_request_comment_in_progress.png index 77b731d2..ecf54811 100644 Binary files a/docs/screenshots/reviewed_request_comment_in_progress.png and b/docs/screenshots/reviewed_request_comment_in_progress.png differ diff --git a/docs/screenshots/reviewed_request_comments.png b/docs/screenshots/reviewed_request_comments.png index 0f5372e4..b1486f0d 100644 Binary files a/docs/screenshots/reviewed_request_comments.png and b/docs/screenshots/reviewed_request_comments.png differ diff --git a/docs/screenshots/submit_request.png b/docs/screenshots/submit_request.png index 1a616222..a77e7bb9 100644 Binary files a/docs/screenshots/submit_request.png and b/docs/screenshots/submit_request.png differ diff --git a/docs/screenshots/submit_review.png b/docs/screenshots/submit_review.png index 17ca63d4..3916a082 100644 Binary files a/docs/screenshots/submit_review.png and b/docs/screenshots/submit_review.png differ diff --git a/docs/screenshots/submitted_request.png b/docs/screenshots/submitted_request.png index 7214ba80..e6b21725 100644 Binary files a/docs/screenshots/submitted_request.png and b/docs/screenshots/submitted_request.png differ diff --git a/docs/screenshots/submitted_review.png b/docs/screenshots/submitted_review.png index a8b14177..b2df3376 100644 Binary files a/docs/screenshots/submitted_review.png and b/docs/screenshots/submitted_review.png differ diff --git a/docs/screenshots/withdraw_request.png b/docs/screenshots/withdraw_request.png index 41a0a830..ee234d58 100644 Binary files a/docs/screenshots/withdraw_request.png and b/docs/screenshots/withdraw_request.png differ diff --git a/docs/screenshots/withdraw_request_modal.png b/docs/screenshots/withdraw_request_modal.png index d10655e8..fe9a5252 100644 Binary files a/docs/screenshots/withdraw_request_modal.png and b/docs/screenshots/withdraw_request_modal.png differ diff --git a/docs/screenshots/withdrawn_file.png b/docs/screenshots/withdrawn_file.png index da5d67a7..5ab38cc9 100644 Binary files a/docs/screenshots/withdrawn_file.png and b/docs/screenshots/withdrawn_file.png differ diff --git a/docs/screenshots/workspace_directory_content.png b/docs/screenshots/workspace_directory_content.png index 765f2a08..18613896 100644 Binary files a/docs/screenshots/workspace_directory_content.png and b/docs/screenshots/workspace_directory_content.png differ diff --git a/docs/screenshots/workspace_directory_view.png b/docs/screenshots/workspace_directory_view.png index d3b5d1ef..db40636f 100644 Binary files a/docs/screenshots/workspace_directory_view.png and b/docs/screenshots/workspace_directory_view.png differ diff --git a/docs/screenshots/workspace_file_icons.png b/docs/screenshots/workspace_file_icons.png index 122a5241..dd427752 100644 Binary files a/docs/screenshots/workspace_file_icons.png and b/docs/screenshots/workspace_file_icons.png differ diff --git a/docs/screenshots/workspace_file_view.png b/docs/screenshots/workspace_file_view.png index 2e837284..fc3a17f3 100644 Binary files a/docs/screenshots/workspace_file_view.png and b/docs/screenshots/workspace_file_view.png differ diff --git a/docs/screenshots/workspace_view.png b/docs/screenshots/workspace_view.png index 65e0e756..12f6f0c2 100644 Binary files a/docs/screenshots/workspace_view.png and b/docs/screenshots/workspace_view.png differ diff --git a/docs/screenshots/workspaces_index.png b/docs/screenshots/workspaces_index.png index 6aa78fc1..23508216 100644 Binary files a/docs/screenshots/workspaces_index.png and b/docs/screenshots/workspaces_index.png differ diff --git a/tests/functional/test_e2e.py b/tests/functional/test_e2e.py index 3ef982f5..8974d4f7 100644 --- a/tests/functional/test_e2e.py +++ b/tests/functional/test_e2e.py @@ -282,6 +282,9 @@ def test_e2e_release_files( filegroup_link = page.get_by_role("link").locator(".filegroup:scope") find_and_click(filegroup_link) + # context and controls instruction help text is shown + expect(page.get_by_test_id("c3")).to_contain_text("Please describe") + context_input = page.locator("#id_context") find_and_click(context_input) context_input.fill("some context") diff --git a/tests/functional/test_request_pages.py b/tests/functional/test_request_pages.py index d3178a45..48f90caa 100644 --- a/tests/functional/test_request_pages.py +++ b/tests/functional/test_request_pages.py @@ -81,6 +81,9 @@ def test_request_file_group_context_modal(live_server, context, page): expect(dialog).to_contain_text("This is some testing context") expect(dialog).to_contain_text("I got rid of all the small numbers") + # context and controls instruction help text is not shown in the modal + expect(page.get_by_test_id("c3")).not_to_contain_text("Please describe") + dialog.locator("button[type=cancel]").click() expect(dialog).not_to_be_visible()