Make evidence captions configurable (required vs. optional) #893
Replies: 1 comment
-
|
Hey @KevinRBriggs, I missed this discussion topic. I would consider this idea for a future update. PRs are always welcome, too. Captions are required because we require captions for all images in our reports. Ghostwriter generally follows what I/we think is best first and then I try to make things configurable for flexibility. The reason we feel they are required is even self-explanatory screenshots or text snippets can benefit from a short explanation. Captions also aid accessibility by providing more information for people who need screen readers. If you'd like to submit your implementation, I'd be happy to take a look at it with you. Otherwise, it's something I'll add to the requested features for the road map. |
Beta Was this translation helpful? Give feedback.
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