diff doc/upgrading.txt @ 5156:882fa4d9bead

issue2550795: @dispname query args in page.html search links not valid html. Some queries with names that include spaces are not properly url encoded/quoted. I.E. a space should be replaced with %20. Fixes to allow a url_query method to be applied to HTMLStringProperty to properly quote string values passed as part of a url.
author John Rouillard <rouilj@ieee.org>
date Fri, 22 Jul 2016 15:48:57 -0400
parents f608eeecf638
children 63294ed25e84
line wrap: on
line diff
--- a/doc/upgrading.txt	Fri Jul 22 15:24:00 2016 -0400
+++ b/doc/upgrading.txt	Fri Jul 22 15:48:57 2016 -0400
@@ -186,6 +186,27 @@
 templates (e.g. a missing caller.edit.html template) can be satisfied
 by the _generic.edit.html template.
 
+Properly quote query dispname (displayed name) in page.html
+-----------------------------------------------------------
+
+A new method has been added to HTMLStringProperty called url_quote.
+The default templates have been updated to use this in the "Your
+Query" section of the trackers html/page.html file. You will want to
+change your template. Lines starting with - are the original line and
+you want to change it to match the line starting with the + (remove
+the + from the line)::
+
+      <tal:block tal:repeat="qs request/user/queries">
+  -    <a href="#" tal:attributes="href string:${qs/klass}?${qs/url}&@dispname=${qs/name}"
+  +    <a href="#" tal:attributes="href string:${qs/klass}?${qs/url}&@dispname=${qs/name/url_quote}"
+	  tal:content="qs/name">link</a><br>
+      </tal:block>
+
+Find the tal:repeat line that loops over all queries. Then
+change the value assigned to @dispname in the href attribute from
+${qs/name} to ${qs/name/url_quote}. Note that you should *not* change
+the value for tal:content.
+
 Schema change to allow "Show Unassigned" issues link to work for Anonymous user
 -------------------------------------------------------------------------------
 

Roundup Issue Tracker: http://roundup-tracker.org/