Sign up
This repository

public / erldocs Octocat-spinner-32

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

include apps in index

  • Loading branch information...
commit 5fc3e1e6265cb65110481098008fcbe76340e6b2 1 parent 6a5e3ed
Bob Ippolito authored

Showing 2 changed files with 38 additions and 23 deletions. Show Diff Stats Hide Diff Stats

  1. 37  priv/static/erldocs.js
  2. 24  src/erldocs.erl
37  priv/static/erldocs.js
View 
@@ -42,7 +42,7 @@ var ErlDocs = (function(index) {
42 42 
         $("#funwrapper").animate({"top":details.fTop}, "normal", fun);
43 43 
     };
44 44
45   
-    function scrollIntoView($parent, $child) {
  45 
+    function scrollIntoView($parent, $child, force) {
46 46
47 47 
         var childTop     = $child.position().top - RESULT_OFFSET_Y,
48 48 
             scrollTop    = $parent[0].scrollTop,
 
@@ -50,6 +50,11 @@ var ErlDocs = (function(index) {
50 50 
             parentHeight = $parent.height(),
51 51 
             newTop       = null;
52 52
  53 
+	if (force) {
  54 
+	    $parent[0].scrollTop = scrollTop + childTop;
  55 
+	    return;
  56 
+	}
  57 
+
53 58 
         if (childTop < 0) {
54 59 
             newTop = scrollTop + childTop;
55 60 
         } else if (childTop + childHeight > parentHeight) {
 
@@ -65,7 +70,7 @@ var ErlDocs = (function(index) {
65 70 
         }
66 71 
     };
67 72
68   
-    function setSelected(x) {
  73 
+    function setSelected(x, force) {
69 74
70 75 
         var sel, children = $results.children("li");
71 76 
 
@@ -76,7 +81,7 @@ var ErlDocs = (function(index) {
76 81 
 	        selected = x;
77 82 
 	        sel = children.eq(x).addClass("selected");
78 83 
             if (sel.length > 0) {
79   
-                scrollIntoView($results, sel);
  84 
+                scrollIntoView($results, sel, force);
80 85 
             }
81 86 
         }
82 87 
     };
 
@@ -115,7 +120,7 @@ var ErlDocs = (function(index) {
115 120
116 121 
         for (i = 0; i < len; i += 1) {
117 122 
             item = index[i];
118   
-            if (item[0] === "mod") {
  123 
+            if (item[0] === "mod" || item[0] === "app") {
119 124 
                 results.push(item);
120 125 
             }
121 126 
         }
 
@@ -143,7 +148,7 @@ var ErlDocs = (function(index) {
143 148
144 149 
     function formatResults(results, str) {
145 150
146   
-        var i, item, hash, url, html = "",
  151 
+        var i, item, hash, url, path, html = "",
147 152 
             len       = results.length,
148 153 
             searchStr = isSearchStr(str) ? "&search="+str : "";
149 154 
 
@@ -151,15 +156,19 @@ var ErlDocs = (function(index) {
151 156
152 157 
             item = results[i];
153 158
154   
-	        hash = (item[0] === "fun") ? "#" + item[2].split(":")[1] : "";
155   
-
156   
-	        url = CURRENT_ROOT + item[1] + "/" + item[2].split(":")[0]
157   
-                + ".html?i=" + i + searchStr + hash ;
  159 
+	    if (item[0] === "app") {
  160 
+		hash = "#" + item[1];
  161 
+		path = "index";
  162 
+	    } else {
  163 
+		hash = (item[0] === "fun") ? "#" + item[2].split(":")[1] : "";
  164 
+		path = item[1] + "/" + item[2].split(":")[0];
  165 
+	    }
  166 
+	    url = CURRENT_ROOT + path + ".html?i=" + i + searchStr + hash;
158 167
159   
-	        html += '<li class="' + item[0] + '"><a href="' + url + '">'
160   
-	            + '<span class="name">' + item[2] + "</span>"
161   
-	            + '<br /><span class="sub">' + item[3] + '</span>'
162   
-	            + '</a></li>';
  168 
+	    html += '<li class="' + item[0] + '"><a href="' + url + '">'
  169 
+	        + '<span class="name">' + item[2] + "</span>"
  170 
+	        + '<br /><span class="sub">' + item[3] + '</span>'
  171 
+	        + '</a></li>';
163 172 
         }
164 173
165 174 
         return html;
 
@@ -223,7 +232,7 @@ var ErlDocs = (function(index) {
223 232 
         }
224 233
225 234 
         if (qs && qs.i) {
226   
-            setSelected(parseInt(qs.i, 10));
  235 
+            setSelected(parseInt(qs.i, 10), true);
227 236 
         } else {
228 237 
             setSelected(0);
229 238 
         }
24  src/erldocs.erl
View 
@@ -44,7 +44,8 @@ build_apps(Conf, Tpl, App, Index) ->
44 44 
     AppName = bname(App),
45 45 
     log("Building ~s (~p files)~n", [AppName, length(Files)]),
46 46 
     Map = fun (F) -> build_file_map(Conf, Tpl, AppName, F) end,
47   
-    pmapreduce(Map, fun lists:append/2, [], Files) ++ Index.
  47 
+    [["app", AppName, AppName, "(application)"] |
  48 
+     pmapreduce(Map, fun lists:append/2, [], Files) ++ Index].
48 49
49 50 
 build_file_map(Conf, Tpl, AppName, File) ->
50 51 
 
@@ -133,7 +134,7 @@ module_index(Conf, Index) ->
133 134 
     log("Creating index.html ...~n"),
134 135
135 136 
     Html = "<h1>Module Index</h1><hr /><br /><div>"
136   
-        ++ lists:flatten(io_lib:format("<!--~n~p~n-->~n", [Index]))
  137 
+        %% ++ lists:flatten(io_lib:format("<!--~n~p~n-->~n", [Index]))
137 138 
         ++ xml_to_str(emit_apps([X || X = ["mod"|_] <- lists:sort(Index)]))
138 139 
         ++ "</div>",
139 140 
 
@@ -153,18 +154,23 @@ emit_apps([], _App) ->
153 154 
 emit_apps([X=["mod", App | _] | Rest], App) ->
154 155 
     [mod(X) | emit_apps(Rest, App)];
155 156 
 emit_apps(L=[["mod", App | _] | _], _OtherApp) ->
156   
-    [{h1, [], [App]} | emit_apps(L, App)].
  157 
+    [{a, [{name, App}], []}, {h1, [], [App]} | emit_apps(L, App)].
157 158
158 159 
 mod(["mod", App, Mod, Sum]) ->
159 160 
     Url = App ++ "/" ++ Mod ++ ".html",
160 161 
     {p,[], [{a, [{href, Url}], [Mod]}, {br,[],[]}, Sum]}.
161 162
162   
-sort_index(["app" | _], ["mod" | _])             -> true;
163   
-sort_index(["app" | _], ["fun" | _])             -> true;
164   
-sort_index(["mod" | _], ["fun" | _])             -> true;
165   
-sort_index(["mod", _, M1, _], ["mod", _, M2, _]) ->
166   
-    string:to_lower(M1) < string:to_lower(M2);
167   
-sort_index(_, _)                                 -> false.
  163 
+type_ordering("app") -> 1;
  164 
+type_ordering("mod") -> 2;
  165 
+type_ordering("fun") -> 3.
  166 
+
  167 
+index_ordering([Type, App, Mod, _Sum]) ->
  168 
+    [string:to_lower(App),
  169 
+     type_ordering(Type),
  170 
+     string:to_lower(Mod)].
  171 
+
  172 
+sort_index(A, B) ->
  173 
+    index_ordering(A) =< index_ordering(B).
168 174
169 175 
 javascript_index(Conf, FIndex) ->
170 176

0 notes on commit 5fc3e1e

Please sign in to comment.
Something went wrong with that request. Please try again.