AlgebraicJulia/Catlab.jl

Allow specification of MIME type of labels in wiring diagrams

Open

#565 opened on Nov 10, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (706 stars) (68 forks)batch import
enhancementgood first issuegraphicswiring diagrams

Description

Catlab escapes the HTML sequences in strings before substituting into the Graphviz "HTML-like" label. However, in order to have a Box whose label contains line breaks render properly, users should be able to specify a MIME type so that they can better control escaping.

Contributor guide

Tech stack
None
Domain
developer experience
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JuliaGraphvizCatlab.jl basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue suggests allowing users to specify a MIME type for labels in wiring diagrams to control HTML escaping. To implement, one should locate how Catlab.jl escapes strings before Graphviz substitution, likely in files such as `src/wiring diagrams.jl` or similar. A new parameter could be added to the label function or Box constructor to accept a MIME type, and the escaping logic can be bypassed or adjusted based on that MIME type. It would be helpful to review existing tests for label functionality and consider adding new ones.