common_texification() should be made private. This is intended for internal use only.
I'm not sure if it's actually doing the right thing. It is used in RendererPgf.draw_text() and in RendererPgf.get_text_width_height_descent() to preprocess the passed text string. See Document and test common_texification() #16900 for a description.

Some random thoughts:
- I think the wrapping of math expressions is right.
- Should there be any escaping in text-mode?
  - This may cause unwanted escapes when you want to have TeX expressions in the text.
  - Currently escaped special characters:
    - _ and ^ are only valid in math mode. At least there's no conflict of semantics if we escape them in texts.
    - % is the comment sign. I wouldn't expect comments in passed strings, so it may be ok to escape it.
    - $ should not appear unescaped in text mode because it's the split marker for math-mode. There's no need to escape it (but no harm either).
  - Currently not escaped special characters:
    - {} may well be used in a tex command within the text mode. Should not be escaped.
    - # and &: not sure if there are tex comands which could make use of them.
  - I didn't check further, but common_texification misses & (ampersand) #15493 (comment) indicates, that some of the chars wouldn't even make it down to the renderer call.
  - Overall, we may escape some characters; but we cannot escape all characters. Is it convenient to auto-escape if possible or is it rather confusing that some chars are escaped, others are not?

Uh oh!

common_texification misses & (ampersand) #15493

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions