back-links section appears twice

[clemens]

The TracBackLinkPlugin (revision r17971) appears twice if the HTML file is saved to local file.

Background

This is a minor issue with Java-Script code which inserts HTML elements (such as the TracBackLinkPlugin section) into the DOM. If you use your browser to save the final HTML page to a file, then when viewing the produced HTML file the affected HTML fragment (TracBackLinkPlugin section) appears twice:

1. as static HTML as written by the browser
2. as dynamically (Java-Script) created HTML.

Of course this issue is not very critical. But sometimes people (like me) save TRAC ticket HTML files.

Patch

The issue is easy to fix. Java-Script shall simply check if the HTML sections to be inserted already exist. I am going to submit a simply patch.

[clemens]

TracBackLinkPlugin [17971] duplicate

[clemens]

This is a propose patch for #13954. The Java-Script code simply checks if the HTML section (i.e. #backlinks) to be inserted already exist in the DOM. We avoid inserting it a second time.

[Jun Omae]

The issue is well known. Almost of web applications have the same issue. At least, section anchors in Trac are added twice on saved html file.

tracbacklink/htdocs/base.js

@@ -12 +12 @@
         return;
 
     var content = $('<div>').html(data.content).contents();
+    var target;
+    var method;
     switch (data.type) {
     case 'ticket':
-        $('div#ticket').after(content);
+        target = 'div#ticket';
+        method = 'after';
         break;
     case 'wiki':
-        $('div#content div.wikipage.searchable').after(content);
+        target = 'div#content div.wikipage.searchable';
+        method = 'after';
         break;
     case 'milestone':
-        $('div#attachments').before(content);
+        target = 'div#attachments';
+        method = 'before';
         break;
+    default:
+        return;
     }
+    target = $(target);
+    if (target.siblings('div#backlinks').length !== 0)
+        return;
+    target[method](content);
 });

[Jun Omae]

Also, Save a web page, complete feature doesn't save raw html.

[Jun Omae]

That is a browser issue, not an issue of this plugin. I won't fix it.