Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add support for captions of images #138

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Conversation

micha91
Copy link
Collaborator

@micha91 micha91 commented Dec 6, 2024

This PR introduces captions for images. By default no captions are created, the new behaviour needs to be enabled via the newly introduced generate-figure-captions flag. The following captions will be generated:

  • Diagrams: Diagram [name of diagram]
  • Context Diagrams: Context Diagram of [name of element]
  • Tree View Diagrams: Tree View of [name of element]
  • Attachments in descriptions:
    • Alt text of the image if filled
    • If not provided: Image "[Filename of image]" of [name of element]

@micha91 micha91 marked this pull request as ready for review December 9, 2024 07:44
@micha91 micha91 requested a review from ewuerger December 9, 2024 07:44
Copy link
Member

@ewuerger ewuerger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@micha91 micha91 merged commit 91afc12 into main Dec 9, 2024
9 checks passed
@micha91 micha91 deleted the figure-caption-support branch December 9, 2024 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants