Add description field to ticket enums

[Ryan J Ollos]

A description field will be added for each ticket enum. This was discussed in comment:10:ticket:1233.

[Ryan J Ollos]

After this ticket is implemented, we should consider creating a macro to list the enums and optionally their descriptions. This would be useful for listing the Resolution descriptions on the TracTicketTriage#StatusandResolution page.

[Ryan J Ollos]

#11872 is needed to implement this ticket.

[Ryan J Ollos]

Narrowing focus for milestone:1.2. Please move ticket to milestone:1.2 if you intend to fix it.

[Ryan J Ollos]

Proposed changes in rjollos.git:t11649_enum_description. The "string replace" used to modify the reports is similar to that in db13.py​. I've also tried to make the reports for new environments more robust against the need for changes ([cc17233d/rjollos.git]).

Upgrade step documented in 1.3/TracUpgrade@12 and 1.3/TracUpgrade@13.

[Jun Omae]

At least, enum.name is incorrectly formatted as javascript.

       jQuery(document).ready(function($) {
         $("#description").autoPreview("${href.wiki_render()}", {
             realm: "${enum.type}",
-            id: "${enum.name}"
+            id: ${to_json(enum.name)|safe}
           }, $("#preview").showOnPreview());
       });

[Ryan J Ollos]

Replying to Jun Omae:

At least, enum.name is incorrectly formatted as javascript.

       jQuery(document).ready(function($) {
         $("#description").autoPreview("${href.wiki_render()}", {
             realm: "${enum.type}",
-            id: "${enum.name}"
+            id: ${to_json(enum.name)|safe}
           }, $("#preview").showOnPreview());
       });

That would also be true then for other instances in which an arbitrary string is used for id, such as in milestone_edit_form.html​?

[Jun Omae]

Yes. I think we should check whether it is needed to use to_json or javascript_quote in the following locations.

$ git grep ": *[\"']\${"
trac/ticket/templates/admin_components.html:            realm: "${component.resource.realm}",
trac/ticket/templates/admin_components.html:            id: "${component.resource.id}"
trac/ticket/templates/admin_enums.html:            realm: "${enum.type}",
trac/ticket/templates/admin_enums.html:            id: "${enum.name}"
trac/ticket/templates/admin_versions.html:            realm: "${version.resource.realm}",
trac/ticket/templates/admin_versions.html:            id: "${version.resource.id}"
trac/ticket/templates/milestone_edit_form.html:          realm: "${milestone.resource.realm}",
trac/ticket/templates/milestone_edit_form.html:          id: "${milestone.resource.id}"
trac/ticket/templates/report_edit.html:            realm: "report", id: "${report.id}"
trac/versioncontrol/templates/admin_repositories.html:            realm: "repository",  id: "${reponame}"
trac/versioncontrol/templates/browser.html:                range_min_secs: '${dir.range_min_secs}',
trac/versioncontrol/templates/browser.html:                range_max_secs: '${dir.range_max_secs}'
trac/versioncontrol/templates/revisionlog.html:        var canvas = $('<canvas>').css({width: '${graph.columns * 2}em',
trac/versioncontrol/templates/revisionlog.html:                                        height: '${len(items) * 2}em'})
trac/wiki/templates/wiki_edit.html:              realm: "${page.resource.realm}", id: "${page.resource.id}"

[Ryan J Ollos]

Committed to trunk in r15933. I'll address the comment:11 changes in #3776.

[Ryan J Ollos]

Replying to Ryan J Ollos:

After this ticket is implemented, we should consider creating a macro to list the enums and optionally their descriptions. This would be useful for listing the Resolution descriptions on the TracTicketTriage#StatusandResolution page.

This can probably be handled in #11702, or in tickets that follow from that one. I've updated comment:description:ticket:11702 to include consideration of a Ticket enum macro.