How do I know what elements compose a function for styling purposes?

[Andrew]

@davystrong

I’ll aim to open a documentation issue

I’m looking forward to it.

@davystrong

I don’t like the idea of this having to be done manually every time an element is added or changed. However, for most elements automatically generating a code example is likely impractical

The way elements created internally in Rust isn’t something that changes regularly (you can try git blame and see when those line have been changed the last time). So recreating them manually once per element basically will be a one-time investment. Moreover, making this somehow automated isn’t a trivial task, so I think it is safe to say that this is out of the question for near future (or in general, IDK, I’m not the creator). Also, since normally the function/element related code is documented right above the Rust struct in the doc string, it would be pretty easy to update the show rule code example (for a specific element that had its internal representation changed).

@davystrong

Actually, when I said “documented” I was really thinking of something more like VS Code hover function. If I could define a quote in my document, then hover over it to see the equivalent typst code for that particular configuration of the function. Bonus points for a code action to generate the “identity” show function for the element.

@davystrong

I realise the LSP isn’t provided by typst but I imagine the functionality required to do this would need to be added to the typst-ide crate.

I answered a similar/same question in How can I document my own user defined functions/variables?. You should look into tinymist for such feature (for now). Also a small note that quote is already a defined element. See How can I access shadowed functions? - #3 by Eric.

@davystrong

Does that sound interesting? Does it sound feasible?

Yes. IMO, no.