commit c97d1a26237322aa3e2d0c0da76ce3c59c0fc3e0
author Chris Broadfoot <cbro@golang.org> Mon Nov 28 15:24:11 2016 -0800
committer Chris Broadfoot <cbro@golang.org> Tue Nov 29 00:47:29 2016 +0000
tree 17f2918c0804cd642fb9d0a5137b6f25794dcb99
parent 6c803ab014286e086881c410cba381b02317423c

godoc: add on-hover permalink anchors across the site

We already have anchors for godoc types and functions. Add them for
every heading (and "dl") on every other page on the site.

Change-Id: Ibad77f04442e48dd5a41de759010625f89b48604
Reviewed-on: https://go-review.googlesource.com/33641
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>

godoc/static/godocs.js

diff --git a/godoc/static/godocs.js b/godoc/static/godocs.js
index 10183cb..7e353d9 100644
--- a/godoc/static/godocs.js
+++ b/godoc/static/godocs.js
@@ -305,9 +305,36 @@
   }
 }
 
+function addPermalinks() {
+  function addPermalink(source, parent) {
+    var id = source.attr("id");
+    if (id == "" || id.indexOf("tmp_") === 0) {
+      // Auto-generated permalink.
+      return;
+    }
+    if (parent.find("> .permalink").length) {
+      // Already attached.
+      return;
+    }
+    parent.append(" ").append($("<a class='permalink'>&#xb6;</a>").attr("href", "#" + id));
+  }
+
+  $("#page .container").find("h2[id], h3[id]").each(function() {
+    var el = $(this);
+    addPermalink(el, el);
+  });
+
+  $("#page .container").find("dl[id]").each(function() {
+    var el = $(this);
+    // Add the anchor to the "dt" element.
+    addPermalink(el, el.find("> dt").first());
+  });
+}
+
 $(document).ready(function() {
   bindSearchEvents();
   generateTOC();
+  addPermalinks();
   bindToggles(".toggle");
   bindToggles(".toggleVisible");
   bindToggleLinks(".exampleLink", "example_");

godoc/static/static.go

diff --git a/godoc/static/static.go b/godoc/static/static.go
index f6e267e..2d5fbe4 100644
--- a/godoc/static/static.go
+++ b/godoc/static/static.go
@@ -875,9 +875,36 @@
   }
 }
 
+function addPermalinks() {
+  function addPermalink(source, parent) {
+    var id = source.attr("id");
+    if (id.indexOf("tmp_") === 0) {
+      // Auto-generated permalink.
+      return;
+    }
+    if (parent.find("> .permalink").length) {
+      // Already attached.
+      return;
+    }
+    parent.append(" ").append($("&nbsp;<a class='permalink'>&#xb6;</a>").attr("href", "#" + id));
+  }
+
+  $("#page .container").find("h2[id], h3[id]").each(function() {
+    var el = $(this);
+    addPermalink(el, el);
+  });
+
+  $("#page .container").find("dl[id]").each(function() {
+    var el = $(this);
+    // Add the anchor to the "dt" element.
+    addPermalink(el, el.find("> dt").first());
+  });
+}
+
 $(document).ready(function() {
   bindSearchEvents();
   generateTOC();
+  addPermalinks();
   bindToggles(".toggle");
   bindToggles(".toggleVisible");
   bindToggleLinks(".exampleLink", "example_");
@@ -1599,8 +1626,8 @@
 	</script>
 
 	{{if $.IsMain}}
-		{{comment_html .Doc}}
 		{{/* command documentation */}}
+		{{comment_html .Doc}}
 	{{else}}
 		{{/* package documentation */}}
 		<div id="short-nav">
@@ -2849,7 +2876,7 @@
 .permalink {
 	display: none;
 }
-h2:hover .permalink, h3:hover .permalink {
+:hover > .permalink {
 	display: inline;
 }
 

godoc/static/style.css

diff --git a/godoc/static/style.css b/godoc/static/style.css
index fd26bd8..b21bc24 100644
--- a/godoc/static/style.css
+++ b/godoc/static/style.css
@@ -46,7 +46,7 @@
 .permalink {
 	display: none;
 }
-h2:hover .permalink, h3:hover .permalink {
+:hover > .permalink {
 	display: inline;
 }