GhostManager/Ghostwriter

Select Caption Type for Evidence

Open

#478 opened on Jul 11, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (982 stars) (154 forks)batch import
enhancementhelp wanted

Description

Currently when attaching evidence the caption used is always the "Figure" caption even when the evidence used is a table and not an image. Would it be possible to have an option to choose a "Table" Caption and have it use the 'Label Used for Tables' that is set within the Global Report Configuration menu?

Screenshot from 2024-07-10 16-42-51

Contributor guide

Tech stack
pythondjango
Domain
full stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of DjangoFamiliarity with Ghostwriter's report models
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by examining the Evidence model in Ghostwriter's codebase to understand how captions are currently assigned. Look for the 'Figure' caption logic and the global report configuration for 'Label Used for Tables'. Then, identify the relevant views and templates that handle evidence attachment and caption display. Propose adding a caption type field (e.g., figure or table) to the evidence form and update the rendering logic to use the chosen label. Check existing tests and documentation for guidance on adding similar features.