Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add English synonyms in the manual to increase googlability #254

Open
petdance opened this issue Jan 20, 2020 · 4 comments
Open

Add English synonyms in the manual to increase googlability #254

petdance opened this issue Jan 20, 2020 · 4 comments

Comments

@petdance
Copy link
Contributor

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
Copy link
Collaborator

atoomic commented Jan 27, 2020

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

@petdance
Copy link
Contributor Author

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

Where's the repo for the website?

@atoomic
Copy link
Collaborator

atoomic commented Jan 27, 2020

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
Copy link

dboehmer commented Sep 4, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants