Skip to content

Commit b8f57c4

Browse files
committed
adding files and packages for documentation
1 parent 1bfd2d0 commit b8f57c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+129872
-0
lines changed

documentation/doc.conf.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"plugins": [
3+
"node_modules/jsdoc-vuejs",
4+
"plugins/markdown"
5+
],
6+
"source": {
7+
"include": ["src/"],
8+
"exclude": ["src/documentation/documentation_postprocess.js"],
9+
"includePattern": "\\.(vue|js)$",
10+
"excludePattern": "\\.(spec.js)$"
11+
},
12+
"recurseDepth": 10,
13+
"opts": {
14+
"encoding": "utf8",
15+
"destination": "./documentation/html/",
16+
"recurse": true,
17+
"template": "./node_modules/ink-docstrap/template"
18+
},
19+
"templates": {
20+
"cleverLinks": true,
21+
"monospaceLinks": true,
22+
"outputSourceFiles": true,
23+
"outputSourcePath": true,
24+
"systemName": "FAIRsharing.org",
25+
"copyright": "DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.",
26+
"theme": "yeti",
27+
"linenums": true,
28+
"inverseNav": true,
29+
"dateFormat": "ddd MMM Do YYYY"
30+
},
31+
"tags": {
32+
"allowUnknownTags": true
33+
}
34+
}
19.7 KB
Binary file not shown.

documentation/html/fonts/glyphicons-halflings-regular.svg

Lines changed: 288 additions & 0 deletions
Loading
44.3 KB
Binary file not shown.
22.9 KB
Binary file not shown.
17.6 KB
Binary file not shown.
8.57 KB
Loading
12.5 KB
Loading

documentation/html/scripts/docstrap.lib.js

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
window.SearcherDisplay = (function($) {
2+
/**
3+
* This class provides support for displaying quick search text results to users.
4+
*/
5+
function SearcherDisplay() { }
6+
7+
SearcherDisplay.prototype.init = function() {
8+
this._displayQuickSearch();
9+
};
10+
11+
/**
12+
* This method creates the quick text search entry in navigation menu and wires all required events.
13+
*/
14+
SearcherDisplay.prototype._displayQuickSearch = function() {
15+
var quickSearch = $(document.createElement("iframe")),
16+
body = $("body"),
17+
self = this;
18+
19+
quickSearch.attr("src", "quicksearch.html");
20+
quickSearch.css("width", "0px");
21+
quickSearch.css("height", "0px");
22+
23+
body.append(quickSearch);
24+
25+
$(window).on("message", function(msg) {
26+
var msgData = msg.originalEvent.data;
27+
28+
if (msgData.msgid != "docstrap.quicksearch.done") {
29+
return;
30+
}
31+
32+
var results = msgData.results || [];
33+
34+
self._displaySearchResults(results);
35+
});
36+
37+
function startSearch() {
38+
var searchTerms = $('#search-input').prop("value");
39+
if (searchTerms) {
40+
quickSearch[0].contentWindow.postMessage({
41+
"searchTerms": searchTerms,
42+
"msgid": "docstrap.quicksearch.start"
43+
}, "*");
44+
}
45+
}
46+
47+
$('#search-input').on('keyup', function(evt) {
48+
if (evt.keyCode != 13) {
49+
return;
50+
}
51+
startSearch();
52+
return false;
53+
});
54+
$('#search-submit').on('click', function() {
55+
startSearch();
56+
return false;
57+
});
58+
};
59+
60+
/**
61+
* This method displays the quick text search results in a modal dialog.
62+
*/
63+
SearcherDisplay.prototype._displaySearchResults = function(results) {
64+
var resultsHolder = $($("#searchResults").find(".modal-body")),
65+
fragment = document.createDocumentFragment(),
66+
resultsList = document.createElement("ul");
67+
68+
resultsHolder.empty();
69+
70+
for (var idx = 0; idx < results.length; idx++) {
71+
var result = results[idx],
72+
item = document.createElement("li"),
73+
link = document.createElement("a");
74+
75+
link.href = result.id;
76+
link.innerHTML = result.title;
77+
78+
item.appendChild(link)
79+
resultsList.appendChild(item);
80+
}
81+
82+
fragment.appendChild(resultsList);
83+
resultsHolder.append(fragment);
84+
85+
$("#searchResults").modal({"show": true});
86+
};
87+
88+
return new SearcherDisplay();
89+
})($);

0 commit comments

Comments
 (0)