Add English synonyms in the manual to increase googlability

petdance commented 4 years ago

I was searching for info about the [%~ in TT and was googling for things like "template toolkit tilde" but was coming up empty.

This page had the info was looking for, but I couldn't find it via searching.

If instead of

To remove all whitespace including any number of newlines, use the '~' character instead.

it had said, for example,

To remove all whitespace including any number of newlines, use the tilde '~' character instead.

then I bet it would have come up in my search results.

Other examples:

To collapse all whitespace to a single space, use the '=' character.

Say "equals"

you can use '+' to disable any chomping options

Say "plus sign"

splitting paths only on ':' characters that aren't followed by a '/'.

Say "colon" and "slash".

To be clear, I'm saying that both the sign and the English word for the sign should be included.

atoomic commented 4 years ago

sounds a good idea @petdance would you like to submit a patch for these changes?

petdance commented 4 years ago

Let me take a look and see what I can do.

Where's the repo for the website?

atoomic commented 4 years ago

I think the website is generated from the pods from this repo the sentence you were pointing at for example is here: https://github.com/abw/Template2/blob/master/lib/Template/Manual/Config.pod#L202

We would then have to refresh the website, but this is something else lol

dboehmer commented 1 year ago

I think this was solved by the PR and this issue can be closed. The change is also live on http://template-toolkit.org/docs/manual/Config.html

abw / Template2