Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

blocks/Icons: no record of how icons are made (see MVTB#121 for a no-LaTeX script)

Aperta Adatta ai principianti
  • Qualcosa non va?
#709 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
latex, matplotlib, python
Ambito
documentation, tooling

Direzione di ricerca

Inizia da src/roboticstoolbox/blocks/Icons/ e blocks/README.md, quindi confronta la convenzione delle icone e le note sulla generazione contenute nei lavori MVTB e bdsim referenziati. Documenta come sono state create le icone esistenti, le loro fonti o il percorso di rigenerazione, se noto, nonché le dipendenze o limitazioni rilevanti; il lavoro è completo quando un nuovo contributore può comprendere la convenzione e riprodurre o mantenere le icone.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Note for later, prompted by a cleanup in the Machine Vision Toolbox (MVTB).

What I found in RTB

src/roboticstoolbox/blocks/Icons/ has 27 PNGs plus 250x250/ and 50x50/ subfolders, but no script and no README explaining how the icons are made, and blocks/README.md doesn't mention icons. I found no reference to bdtex2icon or an icons.sh anywhere in the repo. Several names (coriolis.png, fdyn.png, fdynx.png, ...) match icons in bdsim, which are made with bdtex2icon from LaTeX, so these were probably made the same way, but I haven't verified that.

What MVTB did

MVTB had the same gap: its icons came from an untracked icons.sh that needs bdsim, a LaTeX installation and the unpublished rvc-notation macros. The open PR petercorke/machinevision-toolbox-python#121 adds, in MVTB's blocks/Icons/:

  • make_icons.py: renders TeX math to a 250x250 black-on-transparent RGBA PNG using matplotlib mathtext (Computer Modern), so no LaTeX and no extra dependency;
  • a short README.md describing the icon convention (shared with bdsim's Icons folder);
  • a test for the script.

Findings from the prototype, including how many of bdsim's own icon expressions render and one gotcha (math_to_image output has an opaque white background), are in petercorke/bdsim#109.

Possible follow-up for RTB

  1. Add a blocks/Icons/README.md recording the convention and how each icon was made (even if just "bdtex2icon, see bdsim").
  2. If the LaTeX sources for the icons are still known, record them (an icons.sh, or a table like MVTB's ICONS) so they can be regenerated.
  3. Note for whoever tries it: in bdsim's list, the expressions that did not render under mathtext used the custom macros \dvec, \ddvec and \sbullet and array matrices; icons like coriolis and fdyn use \dvec/\ddvec, so those would need the macro definitions from rvc-notation. I haven't tried RTB's actual expressions.

Not urgent.

Lingua principale
C++
Stelle
3.5k
Fork
630
Merge medio
2g 7h
PR unite (30g)
29

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di petercorke/robotics-toolbox-python

Tutte le issue di petercorke/robotics-toolbox-python

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.