Merge branch 'feature/user-guide-cleanup' into develop

3 files changed, 137 insertions, 80 deletions

diff --git a/user_guide_src/source/_themes/eldocs/layout.html b/user_guide_src/source/_themes/eldocs/layout.html
index 7f2fe1a34..535c2f194 100644
--- a/user_guide_src/source/_themes/eldocs/layout.html
+++ b/user_guide_src/source/_themes/eldocs/layout.html
@@ -31,7 +31,7 @@
 	    {%- for cssfile in css_files %}
 	    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
 	    {%- endfor %}
-	
+
     {%- if not embedded %}
 	    <script type="text/javascript">
 	      var DOCUMENTATION_OPTIONS = {
@@ -46,11 +46,13 @@
 	    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
 	    {%- endfor %}
 
+	    <script type="text/javascript" src="{{ pathto('_static/asset/js/method-toc.js', 1) }}"></script>
+
 	    {%- if favicon %}
 	    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
 	    {%- endif %}
 	{%- endif %}
-	
+
 	{%- block linktags %}
 	    {%- if hasdoc('about') %}
 	    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
@@ -96,7 +98,7 @@
 				{%- block rootrellink %}
 				<li><a href="{{ pathto(master_doc) }}">User Guide Home</a>{%- if pagename != 'index' %}&nbsp;&nbsp;{{ reldelim1 }}{%- endif %}</li>
 				{%- endblock %}
-				
+
 				{%- for parent in parents %}
 				<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>&nbsp;&nbsp; {{ reldelim1 }}</li>
 		        {%- endfor %}
@@ -117,8 +119,8 @@
 		{% if pagename not in exclude_comments -%}
 		<!-- {user_guide_comments} -->
 		{% endif %}
-	
-	{%- block footer %}			
+
+	{%- block footer %}
 		<div id="footer">
 			<p class="top"><a href="#header" title="Return to top">Return to top</a></p>
 			<p><a href="http://{{ project_domain }}/">{{ project }}</a> &ndash; Copyright &copy; {{ copyright }}</a></p>
diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index 5cbb37f94..962380b50 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -22,7 +22,7 @@ http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 
 html, body,
 h1, h2, h3, h4, h5, h6,
-p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; } 
+p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; }
 
 body{ background-color: #F9F9F9; color: #444444; font: normal normal 14px "Helvetica", "Arial", Sans-Serif; }
 
@@ -34,10 +34,10 @@ pre,
 #table-contents .toctree-wrapper{ font-size: 12px; }
 
 dfn, var,
-em.dfn, em.var{ 
-	background-color: #FFFDED; 
-	color: #578236; 
-	font-style: italic; 
+em.dfn, em.var{
+	background-color: #FFFDED;
+	color: #578236;
+	font-style: italic;
 	padding: 3px;
 }
 
@@ -53,7 +53,7 @@ h2{ font-size: 24px; font-weight: normal; }
 
 h1, h2, h3, h4, h5, h6{ margin-bottom: 20px; }
 
-h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; }	
+h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; }
 
 h3{ border-color: #E5E5E5; border-width: 1px; }
 
@@ -62,7 +62,7 @@ h4{ background-color: #FFFDED; display: inline-block; font-size: 18px; margin: 0
 	h1 a, h2 a{ font-weight: normal; }
 
 	h1 a, h2 a, h3 a{ text-decoration: none; }
-	
+
 h3, h5, h6{ font-size: 18px; margin: 20px 0; }
 
 	h4, h5, h6{ font-size: 14px; }
@@ -75,57 +75,67 @@ p, dl, ul, ol{ margin: 20px 0; }
 	li > ol{ margin: 0; margin-left: 40px; }
 
 	dl > dd{ margin-left: 20px; }
-	
+
 	li > p { margin: 0; }
 
 #expressionengine-user-guide li em { font-style: normal; }
 
 p, li, dd, dt, pre{ line-height: 1.5; }
 
-table{ 
+table{
 	background-color: #F5FBFF;
 	border: 1px solid #C8DEF0;
 	border-collapse: collapse;
 	margin-bottom: 20px;
 }
 
-	th, td{ 
-		border: 0; 
+	th, td{
+		border: 0;
 		border-bottom: 1px solid #C8DEF0;
-		padding: 8px; 
+		padding: 8px;
 	}
-	
-		th{ 
-			background-color: #326B95; 
+
+		th{
+			background-color: #326B95;
 			color: #FFFFFF;
-			text-align: left; 
+			text-align: left;
 		}
-	
+
 		td{ font-size: 12px; }
 
 	.descname{ color: #000080; font-weight: bold; }
 	.descclassname{ color: #094776; }
-	
+
 	.class .descname{ font-size: 18px; font-style: italic; }
 	.method .descname{ font-style: normal; }
-	
+
 	.class .property{ color: #094776; }
-	
+
 	.method big,
-	.method .optional{ color: #094776; padding: 0 4px 0 6px; }
-	
+	.method .optional
+	.function big,
+	.function .optional{ color: #094776; padding: 0 4px 0 6px; }
+
 	.class em,
-	.method em{ color: #008080; }
-	
-	.method dt{ margin: 20px 0; }
-		
-	.method table{ margin-bottom: 0; margin-left: 20px; }
-	
+	.method em,
+	.function em{ color: #008080; }
+
+	.method dt,
+	.function dt{ margin: 20px 0; }
+
+	.method table,
+	.function table{ margin-bottom: 0; margin-left: 20px; }
+
 	.method th,
-	.method td{ padding: 10px; }
-	
-	.method td > ul{ margin: 0; margin-left: 20px; }
-	.method td.field-body > p { margin: 0; margin-left: 20px; }
+	.method td,
+	.function th,
+	.function td{ padding: 10px; }
+
+	.method td > ul,
+	.function td > ul{ margin: 0; margin-left: 20px; }
+
+	.method td.field-body > p,
+	.function td.field-body > p { margin: 0; margin-left: 20px; }
 
 a:link,
 a:visited{ color: #1A5B8D; }
@@ -137,7 +147,7 @@ a.headerlink{ visibility: hidden; margin-left: 0.4em; }
 
 	:hover > a.headerlink { visibility: visible; }
 
-a img{ 
+a img{
 	border: 0;
 	outline: 0;
 }
@@ -157,37 +167,38 @@ fieldset{ border: 0; }
 .highlight-bash,
 .highlight-perl,
 .highlight-php,
+.highlight-html,
 .cp-path,
-.codeblock{ 
-	background-color: #F9FEFF; 
-	border: 1px solid #C8DEF0; 
+.codeblock{
+	background-color: #F9FEFF;
+	border: 1px solid #C8DEF0;
 	-moz-box-shadow: 4px 4px 0 rgba(0,0,0,0.03);
 	-webkit-box-shadow: 4px 4px 0 rgba(0,0,0,0.03);
 	box-shadow: 4px 4px 0 rgba(0,0,0,0.03);
-	margin: 20px 0; 
-	padding: 10px 10px 8px; 
+	margin: 20px 0;
+	padding: 10px 10px 8px;
 }
 
 .highlight-ci{ background-color: #FEFEFE; border-color: #E5E5E5; }
 
 	.admonition p{ margin: 0; }
-	
+
 	.codeblock{ margin: 10px 0; }
-	
+
 	.cp-path{ background-color: #FAFFF6; border-color: #D1CDB0; }
 	.important, .note{ background-color: #FFFFF2; border-color: #C8C8A5; }
-	
-.admonition-title{ 
+
+.admonition-title{
 	float: left;
-	font-weight: bold;  
-	padding-right: 4px; 
-	text-transform: uppercase; 
+	font-weight: bold;
+	padding-right: 4px;
+	text-transform: uppercase;
 }
 
 .admonition-title:after{ content: ':  '; }
 
 .highlighted{ background-color: #FFF09B; }
-	
+
 #table-contents{
 	bottom: 0;
 	left: -520px;
@@ -195,7 +206,7 @@ fieldset{ border: 0; }
 	top: 0;
 }
 
-#table-contents .toctree-wrapper{ 
+#table-contents .toctree-wrapper{
 	background-color: #444444;
 	background-color: rgba(0,0,0,0.9);
 	*+background-color: #444444;
@@ -209,16 +220,16 @@ fieldset{ border: 0; }
 }
 
 	#table-contents .toctree-wrapper ul{margin-bottom: 0; margin-top: 0; }
-	
+
 		#table-contents .toctree-wrapper li{ color: #999999; line-height: 1.7; padding: 1px 0; }
-		
+
 			#table-contents .toctree-l1{ list-style-type: none; }
-		
-			#table-contents .toctree-l1 > a{ 
-				background: transparent url(../../asset/img/paper-ico.gif) no-repeat 0 0; 
-				font-size: 14px; 
+
+			#table-contents .toctree-l1 > a{
+				background: transparent url(../../asset/img/paper-ico.gif) no-repeat 0 0;
+				font-size: 14px;
 				font-weight: bold;
-				padding-left: 20px; 
+				padding-left: 20px;
 			}
 
 	#header a:link,
@@ -233,15 +244,15 @@ fieldset{ border: 0; }
 
 #content{ background-color: #FFFFFF; padding: 40px 40px 20px; }
 
-#brand{ 
-	background-color: #F5F5F5; 
-	color: #FFFFFF; 
+#brand{
+	background-color: #F5F5F5;
+	color: #FFFFFF;
 	overflow: hidden;
-	padding: 10px 20px 13px; 
+	padding: 10px 20px 13px;
 }
 
 	#brand > *{ float: left; }
-	
+
 	#brand p{ font-size: 14px; margin: 2px 0 0 5px; }
 	#brand.ci p{ margin-top: 8px; }
 
@@ -250,16 +261,16 @@ fieldset{ border: 0; }
 	#brand.mm{ background-color: #222627; }
 	#brand.el{ background-color: #4A0202; }
 
-#header{ 
+#header{
 	background-color: #3B7EB0;
 	border-top: 2px solid #539ECC;
-	color: #FFFFFF; 
-	overflow: hidden; 
-	padding: 15px 15px 16px 20px; 
+	color: #FFFFFF;
+	overflow: hidden;
+	padding: 15px 15px 16px 20px;
 }
 
 	#header form{ float: right; overflow: hidden; }
-	
+
 	#header input{ float: left; }
 
 	#header input[type="text"]{
@@ -271,9 +282,9 @@ fieldset{ border: 0; }
 		padding: 5px;
 		width: 175px;
 	}
-	
+
 		#header input[type="text"]:focus{ background-color: #FFFDED; outline: 0; }
-		
+
 	#header input[type="submit"]{
 		background: #F0F9FF url(../../asset/img/grades.gif) repeat-x 0 -58px;
 		border: 1px solid #033861;
@@ -284,18 +295,18 @@ fieldset{ border: 0; }
 		padding: 5px 10px;
 		text-transform: uppercase;
 	}
-	
+
 		#header input[type="submit"]:hover{ background-position: 0 -83px; }
-	
-	#header ul{ 
+
+	#header ul{
 		float: left;
 		list-style-type: none;
-		margin: 0; 
+		margin: 0;
 		overflow: hidden;
 	}
-	
+
 		#header li{ float: left; margin: 4px 5px 0 0; }
-		
+
 #footer{ background-color: #F9F9F9; border-top: 1px solid #CCCCCC; padding: 20px; }
 
 	#footer p{ margin: 0; }
@@ -323,8 +334,8 @@ fieldset{ border: 0; }
 	-webkit-box-sizing: border-box;
 	box-sizing: border-box;
 	margin-bottom: 10px;
-	resize: none; 
-	width: 100%; 
+	resize: none;
+	width: 100%;
 }
 
 #comment_form input[type="submit"]{ margin-top: 10px; }
@@ -350,4 +361,4 @@ fieldset{ border: 0; }
 	h3,h4,h5,h6{ font-size: 14px; }
 }
 
-#header input[type="submit"], x:-moz-any-link{ padding: 4px 10px; }
\ No newline at end of file
+#header input[type="submit"], x:-moz-any-link{ padding: 4px 10px; }
diff --git a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
new file mode 100644
index 000000000..a926b3da9
--- /dev/null
+++ b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
@@ -0,0 +1,44 @@
+/* modified from http://stackoverflow.com/a/12459801 */
+$(function (){
+    var createList = function(selector){
+
+        var ul = $('<ul>');
+        var selected = $(selector);
+
+        if (selected.length === 0){
+            return;
+        }
+
+        selected.clone().each(function (i,e){
+
+            var p = $(e).children('.descclassname');
+            var n = $(e).children('.descname');
+            var l = $(e).children('.headerlink');
+
+            var a = $('<a>');
+            a.attr('href',l.attr('href')).attr('title', 'jump to ' + n + '()');
+
+            a.append(p).append(n);
+
+            var entry = $('<li>').append(a);
+            ul.append(entry);
+        });
+        return ul;
+    }
+
+    var c = $('<div>');
+
+    var ul0 = c.clone().append($('.submodule-index'))
+
+    customIndex = $('.custom-index');
+    customIndex.empty();
+    customIndex.append(ul0);
+
+    var l = createList('dl.method > dt, dl.function > dt');
+    if (l) {
+        var ul = c.clone()
+            .append('<h3>Methods / Functions</h3>')
+            .append(l);
+    }
+    customIndex.append(ul);
+});
\ No newline at end of file