Latest revision as of 17:36, 6 October 2024

Page Updated:   2024-10-06

Main Page: Macro Guide

HTML Entities (a.k.a. HTML Escape Characters) can be useful to escape HTML characters so they aren't processed prematurely. This is useful in creating macros, Building Character Sheets, and wiki editing.

When creating some complicated macros, usually involving nesting, you will need to use HTML entities in parts of the code to trick the Roll20 system to make it behave like you want, or some advanced tricks won't work.

Here are some HTML Entities/Escape Characters that are commonly useful to escape when creating advanced Roll20 macros. See HTML Entities or special character for more:

|, }, and , are the most common character that need to be replaced in nested macros.

Character	Replacement
| (pipe)	|, (|)
,	,, (,)
{	{, ({)
}	}, (})
&	&, (&)
space	 , ( )
=	=, (=)
_	_, (_)
(	(, (()
)	), ())
[	[, ([)
]	], (])
<	&#60;, (&lt;)
>	&#62;, (&gt;)
`(backtick, grave accent)	&#96;, (&grave;)
*(asterisk)	&#42;, (&ast;)
!	&#33;, (&excl;)
"(doublequote)	&#34;, (&quot;)
#	&#35;, (&num;)
-(hyphen)	&#45;, (&dash;)
@	&#64;, (&commat;)
%	&#37;, (&percnt;)

[edit] Examples

Main Page: Roll Queries & Nesting

By using HTML entities to replace all } inside "Choose a Roll", it will now correctly process where the query ends. This is essentially to prevent the Roll Query from closing at the first } it encounters.

?{Choose a Roll|
  STR,/roll 1d20 + 3 + (?{Modifier}) |
  DEX,/roll 1d20 + 2 + (?{Modifier}) |
  CON,/roll 1d20 + 1 + (?{Modifier}) }

If your query options contains |, you need to replace them to prevent the query thinking it's a delimiter between options.

?{Pick a pair|Alice|Bob|Bob|Charlie}

[edit] Nested Query Improvement

Now on Dev Server: Roll Query Improvements! July 20th, 2021

Some, if not all, character substitutions might become redundant, when roll20 improves nested Roll Query handling in macros.

Now on the Dev Server(

Pro

^info-users) for testing, improved roll query parsing!

Recently, an update to our character sheet code broke a workaround that some sheets were using to implement nested roll queries. Rather than fixing this workaround, we did a little extra work to properly support nested queries. Now, you should be able to nest roll queries inside of each other without needing to use any character codes.

[edit] Related

• Roll Queries & Nesting
• HTML Character Encoder/Decoder
• URL encoding
• How to Escape HTML Characters