chirun-ncl / chirun

A Python package providing the command line interface for building flexible and accessible content with Chirun.
https://chirun.org.uk/
Other
29 stars 4 forks source link

rename \iframe to \iFrame or \embed_iframe #230

Open christianp opened 6 months ago

christianp commented 6 months ago

At the moment, Chirun has to redefine plasTeX.TeX.processIfContent to cope with an \iframe command inside an \if block.

The default processIfContent looks through its contents, and increases the nesting level for any command whose name starts with if. iframe starts with if, but isn't followed by a \fi command, so it breaks.

I think that we shouldn't fight plasTeX here, and should rename the command to produce an iframe. I think that \iFrame will work, capitalising the F, or \embed_iframe would be a bit more verbose and completely avoid starting with if.

The \iframe command is used heavily at Newcastle to embed ReCap videos, so we'd have to go through and change all the occurrences - this would be a breaking change.