TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-16 09:34:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add SafeJS template function

Browse Source 
This commit adds a SafeJS template function.  Tests and documentation are
included.

Fixes #1579
This commit is contained in:
Cameron Moore 2015-11-15 14:30:57 -06:00 committed by Bjørn Erik Pedersen
parent 4d2d881d0d
commit 9a20243226
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
content/templates/functions.md
View File

@ -456,6 +456,21 @@ Example: Given `style = "color: red;"` defined in the front matter of your `.md`
Note: "ZgotmplZ" is a special value that indicates that unsafe content reached a Note: "ZgotmplZ" is a special value that indicates that unsafe content reached a
CSS or URL context. CSS or URL context.
### safeJS
Declares the provided string as a known "safe" Javascript string so Go
html/templates will not escape it. "Safe" means the string encapsulates a known
safe EcmaScript5 Expression, for example, `(x + y * z())`. Template authors
are responsible for ensuring that typed expressions do not break the intended
precedence and that there is no statement/expression ambiguity as when passing
an expression like `{ foo:bar() }\n['foo']()`, which is both a valid Expression
and a valid Program with a very different meaning.
Example: Given `hash = "619c16f"` defined in the front matter of your `.md` file:
* `<script>var form_{{ .Params.hash | safeJS }};…</script>` ⇒ `<script>var form_619c16f;…</script>` (Good!)
* `<script>var form_{{ .Params.hash }};…</script>` ⇒ `<script>var form_"619c16f";…</script>` (Bad!)
### singularize ### singularize
Singularize the given word with a set of common English singularization rules. Singularize the given word with a set of common English singularization rules.