Curly braces not properly escaped on pages (e.g. docker, playerctl, fakedata)

[mrnossiom]

👋🏻 Hi

Problem

On some pages, we actually need to show parenthesis {{ ... }} like the ones of docker inspect and playerctl for templating.

Docker example

where it should be in fact

tldr/pages/common/docker-inspect.md

Line 16 in e9995a8

`docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' {{container}}`

Research

I tried to find a way to escape these, but after some research, I only found someone that tried to escape for fakedata

tldr/pages/common/fakedata.md

Line 24 in e9995a8

`echo "{{\{\{Generator\}\}}}" | fakedata`

but it does not actually work

I asked on the Matrix chat, but one told me to open an issue here...

Solution

I'll create a PR as soon as I know how to escape the parentheses to fix most of the pages. I think I can find more example of this issue.

PS: I use tldr every day, and it is a great piece of information. Thanks

[mrnossiom]

Wait, I actually forgot I already opened an issue for this : #10040

[principis]

I think backslash for escaping would be easy to implement in clients.

[mrnossiom]

@kbdharun Does that mean that the cases mentioned here were fixed in the process ?

[kbdharun]

@kbdharun Does that mean that the cases mentioned here were fixed in the process ?

Yes, Once a new client specification release is made. Clients will be able to update their code and fix escaping (by referring to the examples, in client spec).

[mrnossiom]

Yeah, I know, but does the docker tldr page has been fixed ?
I don't remember which other one, but I know there was another case that didn't match the spec as it is now.

[kbdharun]

Yeah, I know, but does the docker tldr page has been fixed ? I don't remember which other one, but I know there was another case that didn't match the spec as it is now.

The docker tldr page indeed hasn't been fixed yet (I will open a PR to update it now), I believe the other case would be playerctl which we updated recently at #11616. Feel free to let us know if any other page needs to be fixed. Btw, tlrc has implemented the change in the recent release and it is live to use.

An escaped page now will look something like this:

[mrnossiom]

Great news! Thanks

I didn't encounter any other glitched page during my investigation.