Make evidence captions configurable (required vs. optional) #893
KevinRBriggs
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Is your feature request related to a problem? Please describe.
When uploading evidence, the caption field is always required. In some workflows — particularly when embedding screenshots that are self-explanatory within the finding's narrative — a caption adds no value but is still mandatory. When a caption is left blank (e.g., by directly editing the database or a future change), the DOCX report writer still renders a dangling "Figure N –" line with no caption text after it, which looks like a formatting error in the delivered report.
Describe the solution you'd like
A "Require Evidence Captions" toggle to the Admin Panel under
Commandcenter > Global Report Configuration > Captions, defaulting to enabled so existing behavior is preserved.When an admin disables it:
This keeps the feature opt-in and gives teams the flexibility to decide whether captions are part of their reporting workflow.
Describe alternatives you've considered
Additional context
I have a working implementation and would be happy to submit a PR. The change touches the ReportConfiguration model (new BooleanField + migration), the admin fieldset, EvidenceForm, and the DOCX report writer's figure caption rendering. Tests are included covering both configuration states.
Beta Was this translation helpful? Give feedback.
All reactions