<div dir="ltr">If I understand this correctly:<div><div>This is about the html inserted by PmWki, rather than as follows:</div><div><font color="#4c1130">%hlt html%[@<div some html>@]</font> will highlight correctly and <b>will not </b>generate warnings from the html.<br></div><div>or</div><div><div><font color="#4c1130">%hlt html%@@<div some html>@@ (no html generated by PmWiki - and is html_escaped)</font></div><div><font color="#4c1130"><br></font></div><div><font color="#4c1130">Instead it is about </font></div><div><span style="color:rgb(76,17,48)">%hlt html%@@'''PmWiki markup generating  html'''@@</span><font color="#4c1130"><br></font></div><div><span style="color:rgb(76,17,48)">such as</span></div><div><span style="color:rgb(76,17,48)">%hlt html%@@$DefaultName@@</span><span style="color:rgb(76,17,48)"><br></span></div><div><br></div><div><div>Is it possible to restrict  the highlighting, for example, to the text only  between the <a> and </a> tags? (i.e. excluding the tags)</div><div>Otherwise I favour stripping the HTML within @@ @@ (but am interested in more discussion)</div></div><div><br></div><div>I think that links to  $pmwikivariables in HTML are less important than highlighting. These variables, and thus links, can be incorporated elsewhere in the documentation outside of the example code </div><div>This is the practice I have taken in updating documentation. </div><div><br></div><div>This means that we should not use @@$variable@@ in the markup any more to use the mono font to distinguish it from normal text, a practice we also use for file names. e.g. @@local/config.php@@ and some similar .</div><div>Of course not all $variables documented are core pmwiki variables and have links.</div><div><br></div><div><br></div><div>thanks</div><div><br></div><div>Simon</div><br></div></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, 17 Jun 2022 at 19:59, Petko Yotov <<a href="mailto:5ko@5ko.fr">5ko@5ko.fr</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello,<br>
<br>
There is an effort in progress to beautify / syntax highlight the PHP <br>
snippets in the documentation.<br>
<br>
The benefit is obvious -- it is very nice, it allows to easily notice <br>
the different parts of the configuration.<br>
<br>
There are unfortunately 2 relatively important downsides.<br>
<br>
<br>
1. The Highlight.js library only expects plain text in the code blocks, <br>
and if there is any HTML, it strips it keeping the plain text, and it <br>
outputs many rather ominous warnings in the JavaScript console of the <br>
browser saying:<br>
<br>
   One of your code blocks includes unescaped HTML.<br>
   This is a potentially serious security risk.<br>
   One of your code blocks includes unescaped HTML.<br>
   This is a potentially serious security risk.<br>
   One of your code blocks includes unescaped HTML.<br>
   This is a potentially serious security risk.<br>
<br>
This is for every processed/highlighted block, sometimes 20 times in a <br>
page.<br>
<br>
These warnings are unacceptable to me, I don't want a wiki admin to <br>
install PmWiki and Highlight.js and to have these warnings appear out of <br>
the box from the core documentation.<br>
<br>
How can unescaped HTML happen? It can if the code is surrounded with <br>
@@...@@ instead of [@...@], then there may be some HTML inside, like <br>
bold, or a PmWiki variable like $EnableDiag or $DefaultPasswords.<br>
<br>
This leads to:<br>
<br>
2. In highlighted blocks stripped of inner HTML, PmWiki variables from <br>
the documentation like $DefaultPasswords or $EnableUpload no longer link <br>
to the PmWiki/Variables documentation sections where these variables are <br>
explained.<br>
<br>
<br>
What do you think is more useful to wiki admins installing and <br>
configuring PmWiki?<br>
<br>
* Is it the nice colors for the PHP code?<br>
<br>
* Is is the automatic links to the PmWiki Variables documentation?<br>
<br>
<br>
I suspect in a short PHP snippet the documentation links are more useful <br>
to admins than the colors (and BTW the links are colored blue so they <br>
already stand out).<br>
<br>
<br>
I see 2 options:<br>
<br>
1. If the syntax highlighting is more important, we can strip all HTML <br>
in the blocks before highlighting them, just to keep the warnings from <br>
appearing: the Highlight library will strip it anyway, while <br>
complaining.<br>
<br>
2. We can omit PHP blocks containing HTML, especially links to core <br>
variables, from being highlighted. However, this might surprise some <br>
editors with their own code.We can configure a "title" attribute for the <br>
block that explains the reason?<br>
<br>
What do you think?<br>
<br>
Petko<br>
<br>
_______________________________________________<br>
pmwiki-users mailing list<br>
<a href="mailto:pmwiki-users@pmichaud.com" target="_blank">pmwiki-users@pmichaud.com</a><br>
<a href="http://www.pmichaud.com/mailman/listinfo/pmwiki-users" rel="noreferrer" target="_blank">http://www.pmichaud.com/mailman/listinfo/pmwiki-users</a><br>
</blockquote></div>