--- /dev/null
+.mkwsReferenceUniverse {
+ font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+ background: #FCFBFA;
+ padding: 0.5em 1em 0.25em;
+ box-shadow: 0 0 2px 0 #7F8F93;
+ border-radius: 0 0 1.5em;
+ -moz-border-radius: 0 0 1.5em;
+ -webkit-border-radius: 0 0 1.5em;
+ line-height: 1.4;
+ color: #86979B;
+ background: radial-gradient(ellipse at center, #ffffff 0%,#f8f8f8 100%);
+}
+
+h2 {
+ font-size: 100%;
+ color: #4A5456;
+ padding-bottom: .5em;
+}
+
+.record, .mkwsSummary {
+ margin: .95em .25em;
+ padding-top: .75em;
+ border-top: 1px dotted #BEC8CC;
+ font-size: 90%;
+}
+
+a {
+ text-decoration: none;
+ font-weight:normal;
+ color: #2B77AF;
+}
--- /dev/null
+<html>
+ <div style="max-width: 18em; margin: 1.5em 1.5em">
+ <script src="//mkws.indexdata.com/mkws-complete.js"></script>
+ <script src="mkws-widget-ru.js"></script>
+ <link rel="stylesheet" type="text/css" href="mkws-widget-ru.css" />
+ <div class="mkwsReferenceUniverse" autosearch="!param!q"></div>
+ </div>
+</html>
--- /dev/null
+mkws.registerWidgetType('ReferenceUniverse', function() {
+ //this.team.config.service_proxy_auth = "http://mkws.indexdata.com/service-proxy/?command=auth&action=login&username=paratext&password=paratext_mkc";
+ // this.team.config.perpage_default = 5;
+ // this.team.config.sort_default = "position";
+ var teamClass = 'mkwsTeam_' + this.team.name();
+ var html = "<h2>Reference Universe results:</h2>\n";
+ html += '<div class="mkwsRecords ' + teamClass
+ + '" autosearch="' + $(this.node).attr("autosearch")
+ + '" sort="position" perpage="5"></div>';
+ $(this.node).html(html);
+});
--- /dev/null
+# Embedding Reference Universe with MKWS
+
+## Quick start
+Simply paste this inline with the markup on any page:
+
+ <script src="//mkws.indexdata.com/mkws-complete.js"></script>
+ <script src="//mkws.indexdata.com/mkws-widget-ru.js"></script>
+ <link rel="stylesheet" type="text/css" href="//mkws.indexdata.com/mkws-widget-ru.css" />
+ <div class="mkwsReferenceUniverse" autosearch="!param!q"></div>
+
+## A bit more detail
+
+The MasterKey Widget Set ([MKWS](http://mkws.indexdata.com/)) lets you easily embed search-enabled widgets which run in the client browser and display results from a web service. In this case, it searches Reference Universe.
+
+You need to include two scripts: one for MKWS and one for the Reference Universe widget. This can be inline as above or you can include them in the header or aggregate them with your application's scripts.
+
+ <script src="//mkws.indexdata.com/mkws-complete.js"></script>
+ <script src="//mkws.indexdata.com/mkws-widget-ru.js"></script>
+
+The provided stylesheet is generic and you're encouraged to replace it entirely by styling the new elements to fit seamlessly with your content.
+
+ <link rel="stylesheet" type="text/css" href="//mkws.indexdata.com/mkws-widget-ru.css" />
+
+Any element you give the class `mkwsReferenceUniverse` will have is contents replaced by the top results from a search against the Reference Universe service for the current query.
+
+ <div class="mkwsReferenceUniverse" autosearch="!param!q"></div>
+
+### Finding the query
+
+The `autosearch` attribute of the widget container lets it know where to find the query. There are three places it might look to find that you're searching for *water*:
+
+* `!param!foo` indicates a GET parameter and would match `http://site.tld/search?foo=water`
+* `!path!2` will take the 2nd path component from the end of the url and would find the query in `http://site.tld/apps/search/water/mobile`
+* `!var!foo` will look for the query in a JavaScript variable named `foo` in the `window` context (ie. a top level variable)
function selectorForAllWidgets() {
- if (mkws.config.scan_all_nodes) {
+ if (mkws.config && mkws.config.scan_all_nodes) {
// This is the old version, which works by telling jQuery to
// find every node that has a class beginning with "mkws". In
// theory it should be slower than the class-based selector; but
}
- $(document).ready(function() {
+ function init(rootsel) {
+ if (!rootsel) var rootsel = ':root';
var saved_config;
if (typeof mkws_config === 'undefined') {
log("setting empty config");
}
var then = $.now();
- makeWidgetsWithin(1, $(':root'));
+ makeWidgetsWithin(1, $(rootsel));
var now = $.now();
log("walking MKWS nodes took " + (now-then) + " ms");
// raw pp2
runAutoSearches();
}
+ };
+ $(document).ready(function() {
+ var widgetSelector = selectorForAllWidgets();
+ if (widgetSelector && $(widgetSelector).length !== 0) init();
});
})(jQuery);
projects / mkws-moved-to-github.git / commitdiff