MEGA65 / mega65-user-guide

MEGA65 User Guide
73 stars 49 forks source link

Rename "screenoutput" to "screencode" for LaTeX Workshop compatibility #556

Closed dansanderson closed 8 months ago

dansanderson commented 10 months ago

VSCode LaTeX Workshop (which we recommend that people use) has a limitation where it does not recognize a custom listing environment unless its name ends with code. We currently have to use un-escaped dollar signs inside screenoutput environment, which messes up syntax coloring when LaTeX Workshop doesn't know to ignore them.

https://github.com/James-Yu/LaTeX-Workshop/wiki/FAQ#can-i-define-my-own-listing-environment

We should rename screenoutput to screencode (or maybe screenoutputcode). It's not perfect but it fixes this issue, and makes common errors with unescaped LaTeX special characters easier to find.

(I'll take care of this soon, just creating the issue for tracking.)