Skip to content

Commit 6c46ea9

Browse files
wilzbachwilzbach
committed
Ddoc: in-site (Ddox-like) search
1 parent e85a156 commit 6c46ea9

File tree

5 files changed

+128
-56
lines changed

5 files changed

+128
-56
lines changed

‎css/ddox.css‎

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -53,52 +53,6 @@ a.inherited:after { content: url(../images/ddox/inherited.png); padding-left: 3p
5353

5454
#symbolSearch { width: 112pt; }
5555

56-
#symbolSearchResults {
57-
background: #F5F5F5;
58-
border: 1px solid #CCC;
59-
font-size: small;
60-
list-style: none;
61-
margin: 0;
62-
margin-top: 5px;
63-
padding: 0.3em;
64-
position: absolute;
65-
right: -1px;
66-
top: 100%;
67-
width: 100%;
68-
z-index: 1000;
69-
}
70-
71-
#symbolSearchResults li {
72-
background-repeat: no-repeat;
73-
background-position: left center;
74-
padding-left: 18px;
75-
}
76-
77-
#top #symbolSearchResults li a {
78-
color: #B03931;
79-
height: auto;
80-
padding: 0;
81-
}
82-
#symbolSearchResults li a:hover
83-
{
84-
background: transparent;
85-
color: #742620;
86-
text-decoration: underline;
87-
}
88-
89-
#symbolSearchResults .deprecated a { color: gray; }
90-
#symbolSearchResults .module { background-image: url(../images/ddox/module.png); }
91-
#symbolSearchResults .functiondeclaration { background-image: url(../images/ddox/function.png); }
92-
#symbolSearchResults .classdeclaration { background-image: url(../images/ddox/class.png); }
93-
#symbolSearchResults .interfacedeclaration { background-image: url(../images/ddox/interface.png); }
94-
#symbolSearchResults .structdeclaration { background-image: url(../images/ddox/struct.png); }
95-
#symbolSearchResults .variabledeclaration { background-image: url(../images/ddox/variable.png); }
96-
#symbolSearchResults .property { background-image: url(../images/ddox/property.png); }
97-
#symbolSearchResults .enumdeclaration { background-image: url(../images/ddox/enum.png); }
98-
#symbolSearchResults .enummemberdeclaration { background-image: url(../images/ddox/enummember.png); }
99-
#symbolSearchResults .aliasdeclaration { background-image: url(../images/ddox/alias.png); }
100-
#symbolSearchResults .templatedeclaration { background-image: url(../images/ddox/template.png); }
101-
10256
/* Don't show simple handcrafted cheat sheets. DDOX does a good job generating
10357
* them. */
10458
table.simple-cheatsheet { display: none; }

‎css/style.css‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2134,3 +2134,53 @@ Custom modifications to the navigation menu
21342134
margin-bottom: 1em;
21352135
padding-top: 0.5em;
21362136
}
2137+
2138+
/**
2139+
In-site documentation search box and its results.
2140+
*/
2141+
2142+
#symbolSearchResults {
2143+
background: #F5F5F5;
2144+
border: 1px solid #CCC;
2145+
font-size: small;
2146+
list-style: none;
2147+
margin: 0;
2148+
margin-top: 5px;
2149+
padding: 0.3em;
2150+
position: absolute;
2151+
right: -1px;
2152+
top: 100%;
2153+
width: 100%;
2154+
z-index: 1000;
2155+
}
2156+
2157+
#symbolSearchResults li {
2158+
background-repeat: no-repeat;
2159+
background-position: left center;
2160+
padding-left: 18px;
2161+
}
2162+
2163+
#top #symbolSearchResults li a {
2164+
color: #B03931;
2165+
height: auto;
2166+
padding: 0;
2167+
}
2168+
#symbolSearchResults li a:hover
2169+
{
2170+
background: transparent;
2171+
color: #742620;
2172+
text-decoration: underline;
2173+
}
2174+
2175+
#symbolSearchResults .deprecated a { color: gray; }
2176+
#symbolSearchResults .module { background-image: url(../images/ddox/module.png); }
2177+
#symbolSearchResults .functiondeclaration { background-image: url(../images/ddox/function.png); }
2178+
#symbolSearchResults .classdeclaration { background-image: url(../images/ddox/class.png); }
2179+
#symbolSearchResults .interfacedeclaration { background-image: url(../images/ddox/interface.png); }
2180+
#symbolSearchResults .structdeclaration { background-image: url(../images/ddox/struct.png); }
2181+
#symbolSearchResults .variabledeclaration { background-image: url(../images/ddox/variable.png); }
2182+
#symbolSearchResults .property { background-image: url(../images/ddox/property.png); }
2183+
#symbolSearchResults .enumdeclaration { background-image: url(../images/ddox/enum.png); }
2184+
#symbolSearchResults .enummemberdeclaration { background-image: url(../images/ddox/enummember.png); }
2185+
#symbolSearchResults .aliasdeclaration { background-image: url(../images/ddox/alias.png); }
2186+
#symbolSearchResults .templatedeclaration { background-image: url(../images/ddox/template.png); }

‎dlang.org.ddoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ COMMON_SCRIPTS =
3636
$(COMMON_SCRIPTS_DLANG)
3737
_=
3838
COMMON_SCRIPTS_DLANG =
39-
$(SCRIPTLOAD $(STATIC js/codemirror-compressed.js))
39+
$(SCRIPTLOAD $(STATIC js/codemirror-compressed.js), async)
4040
$(SCRIPTLOAD $(STATIC js/run.js))
41+
$(SCRIPTLOAD $(STATIC library/symbols.js), async)
42+
$(SCRIPTLOAD $(STATIC js/ddox.js), async)
4143
_=
4244

4345
COMPATIBILITY_BOX_DEPRECATED = $(MESSAGE_BOX red, $(B Deprecated) - $0)
@@ -411,6 +413,7 @@ SEARCH_BOX=
411413
</select>
412414
))$(SPANID search-submit, <button type="submit"><i class="fa fa-search"></i><span>go</span></button>)
413415
</form>
416+
<ul id="symbolSearchResults" class="symbolList" style="display: none"></ul>
414417
)
415418
SEARCH_OPTIONS_EXTRA=
416419
_=

‎js/ddox.js‎

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ function performSymbolSearch(maxlen)
3434
{
3535
if (maxlen === 'undefined') maxlen = 26;
3636

37-
var searchstring = $("#symbolSearch").val().toLowerCase();
37+
var el = $("#symbolSearch");
38+
if (el.length === 0) el = $("#q");
39+
40+
var searchstring = el.val().toLowerCase();
3841

3942
if (searchstring == lastSearchString) return;
4043
lastSearchString = searchstring;
@@ -118,7 +121,20 @@ function performSymbolSearch(maxlen)
118121
if (np > 0) shortname = ".." + shortname;
119122
else shortname = shortname.substr(1);
120123

121-
el.append('<a href="'+symbolSearchRootDir+sym.path+'" title="'+name+'" tabindex="1001">'+shortname+'</a>');
124+
if (typeof(symbolSearchRootDir) === "undefined") {
125+
// translate ddox path into ddoc path - this is a big messy
126+
var module = ddoxSymbolToDdocModule(sym);
127+
var path;
128+
if (sym.kind === "module") {
129+
path = module;
130+
} else {
131+
var symbol = ddoxSymbolToDdocSymbol(sym);
132+
path = module + "#" + symbol; // combine module + symbol, e.g. core_atomic.html#testCAS
133+
}
134+
el.append('<a href="'+path+'" title="'+name+'" tabindex="1001">'+shortname+'</a>');
135+
} else {
136+
el.append('<a href="'+symbolSearchRootDir+sym.path+'" title="'+name+'" tabindex="1001">'+shortname+'</a>');
137+
}
122138
$('#symbolSearchResults').append(el);
123139
}
124140

@@ -129,12 +145,46 @@ function performSymbolSearch(maxlen)
129145
$('#symbolSearchResults').show();
130146
}
131147

148+
function ddoxSymbolToDdocModule(sym)
149+
{
150+
// sym.path: ./core/atomic/test_cas.html
151+
// ddoc has an individual page for each top-level symbol, so we need to go one level higher to get the actual module name
152+
if (sym.kind === "module")
153+
return sym.name.split(".").join("_") + ".html";
154+
155+
var path = sym.path.slice(0, -5); // strip the html extension from the path, e.g. ./core/atomic/test_cas
156+
path = path.replace(/(.*)\/(.*)$/g, "$1.html"); // the module is one level higher, e.g. ./core/atomic.html
157+
path = path.replace(/\//g, "_"); // ddoc uses _ to divide modules, e.g. ._core_atomic.html
158+
path = path.replace("._", ""); // remove the beginning excess, e.g. core_atomic.html
159+
return path;
160+
}
161+
162+
function ddoxSymbolToDdocSymbol(sym)
163+
{
164+
var pathBaseName = sym.path.replace(/.*?([^\/]*)[.]html(.*)/g, "$1$2"); // the basename on the HTML, e.g. socket_option_level.html#IP
165+
if (sym.path.indexOf("#") >= 0 || pathBaseName.indexOf(".") >= 0) {
166+
// sym.name: std.socket.SocketOptionLevel.IP, sym.path: "./std/socket/socket_option_level.html#IP -> SocketOptionLevel.IP
167+
// this is the difficult case where the symbol is nested
168+
// strategy: take the last two portions of the package name and hope for the best
169+
var parts = sym.name.split(".").slice(-2);
170+
if (parts[0] === parts[1]) {
171+
// an eponymous template
172+
return parts[0];
173+
} else {
174+
return "." + parts.join(".");
175+
}
176+
} else {
177+
// sym.name: core.atomic.testCAS
178+
return sym.name.replace(/(.*)[.](.*)$/g, "$2") // testCAS
179+
}
180+
}
181+
132182
$(function(){
133-
$("#search-box form").on("submit", function(e) {
134-
var searchResults = $('#symbolSearchResults').children();
135-
if (searchResults.length > 0) {
136-
window.location = searchResults.first().find("a").attr("href");
137-
e.preventDefault();
138-
}
139-
});
183+
$("#search-box form").on("submit", function(e) {
184+
var searchResults = $('#symbolSearchResults').children();
185+
if (searchResults.length > 0) {
186+
window.location = searchResults.first().find("a").attr("href");
187+
e.preventDefault();
188+
}
189+
});
140190
});

‎js/dlang.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,20 @@
7474
elem.show();
7575
}
7676
});
77+
78+
// wire the search box to the ddox search
79+
// only for ddoc pages for now
80+
if ($('body').hasClass("std"))
81+
{
82+
var search = $("#q")
83+
search.attr("placeholder", "API Search");
84+
search.attr("autocomplete", "off");
85+
var onChange = function(){
86+
performSymbolSearch(80);
87+
};
88+
search.on("change", onChange);
89+
search.on("keypress", onChange);
90+
search.on("input", onChange);
91+
}
7792
});
7893
})(jQuery);

0 commit comments

Comments
 (0)