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

make a cheat-sheet for editors on escaping quotes / special characters #1646

Closed
mdlincoln opened this issue Jan 29, 2020 · 3 comments
Closed
Assignees

Comments

@mdlincoln
Copy link
Contributor

We need to put strings in to a lot of places:

  • YAML
  • markdown
  • html inside markdown
  • code blocks
  • arguments added to includes like with {% include figure.html caption="..." %} (which are a special case too b/c they actually get processed as markdown...)

It's not always intuitive how ' and " will interact in which domain, and there are often mutiple ways to do it which can be confusing for newcomers to try and sort it all out. We need a cheat sheet so editors can look this up when working on tricky things like #1644

i'm tired. but I'll start work on it at some point - if anyone @programminghistorian/technical-team finds some good pre-existing resources that we could link to, that would also be lovely.

@mdlincoln mdlincoln self-assigned this Jan 29, 2020
@walshbr
Copy link
Contributor

walshbr commented Jan 29, 2020

Oof I'm not certain I'm really good on all the distinctions either, and I couldn't find any readymade resources for this when googling around - just a thousand stack overflow threads. I could help write this up, but is the following correct? Something like…

YAML - use double quotation marks, with a caveat for escaping the double quotes as necessary
Markdown - should not matter which you use if it's just content
HTML inside markdown - should be double quotation marks with internal quotes escaped as necessary?
code blocks - should not matter for the site since the code blocks aren't being parsed - it would just depend on the language for the code block
arguments - should be double quotation marks with internal quotes escaped as necessary?

@jenniferisasi
Copy link
Contributor

I can't find anything that is a one-place guide either, sorry (checked in English and Spanish). Are you suggesting this info to be on the Wiki?

I am most familiar with html and I would say what you said @walshbr for it is correct.

@mdlincoln
Copy link
Contributor Author

amended the common travis errors section of the wiki to cover this case

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

No branches or pull requests

4 participants