How to escape a string for use in XML/HTML document in Scala?

Question

Specifically, what's the easiest and most idiomatic way to replace special XML characters in a string. E.g., what's the easiest and most idiomatic way to convert <Jack & Jill> to <Jack & Jill>.

Chris W. · Accepted Answer · 2013-10-10T05:58:09.167

28

Turns out there is an easy way to do this (despite a quick web-search not revealing an obvious solution): just use method xml.Utility.escape.

edited Oct 10 '13 at 05:58

answered Jun 25 '13 at 15:59

Chris W.

1,680
16
35

xml.Utility.escape does not escape e.g. « « see my answer proposal – Hartmut Pfarr Mar 24 '21 at 19:02

score 2 · Answer 2 · edited May 23 '17 at 11:46

2

If you are looking to escape the @ sign in a scala.html file, for instance, using Scala/Play, do @@.

And give the person who provided this answer here How to print @ symbol in HTML with play framework (scala) an upvote.

I came across this page while looking for the above answer, so I just wanted to duplicate it here since other people may end up here as well.

edited May 23 '17 at 11:46

Community

1
1

answered Apr 27 '17 at 06:40

DowntownDev

842
10
15

score 1 · Answer 3 · answered Mar 24 '21 at 18:59

1

I propose using the function org.apache.commons.text.StringEscapeUtils.escapeHtml4, added into build.sbt by libraryDependencies += "org.apache.commons" % "commons-text" % "1.9"

( xml.Utility.escape does not escape e.g. « « )

answered Mar 24 '21 at 18:59

Hartmut Pfarr

5,534
5
36
42

1

This is helpful; I've noticed `xml.Utility.escape` does not support anything beyond the default XML entities. – Chris W. Jul 11 '22 at 15:47

How to escape a string for use in XML/HTML document in Scala?

3 Answers3