MKWS demo: Reference Universe widget

From: Wolfram Schneider Date: Sat, 31 May 2014 20:06:08 +0000 (+0000) Subject: Merge branch 'master' of ssh://git.indexdata.com:222/home/git/private/mkws X-Git-Tag: 1.0.0~556^2~2 X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=668d2300bc5f6e809a566244a15d9e20fe358b2a;hp=002850e798def87c2ca04fbc449e9a221bb52afd;p=mkws-moved-to-github.git Merge branch 'master' of ssh://git.indexdata.com:222/home/git/private/mkws --- diff --git a/examples/htdocs/mike2.html b/examples/htdocs/mike2.html index 606c657..c51f022 100644 --- a/examples/htdocs/mike2.html +++ b/examples/htdocs/mike2.html @@ -4,8 +4,10 @@ MKWS demo: Reference Universe widget diff --git a/examples/htdocs/mkws-widget-credo-bs.js b/examples/htdocs/mkws-widget-credo-bs.js new file mode 100644 index 0000000..7c143c1 --- /dev/null +++ b/examples/htdocs/mkws-widget-credo-bs.js @@ -0,0 +1,118 @@ +// The Google Images database returns links like: +// http://images.google.com/url?q=http://eofdreams.com/fish.html&sa=U&ei=RAB-U9XNDo2Dqga1o4L4Bw&ved=0CC4Q9QEwAA&usg=AFQjCNFhRtn6GMevHbpITZ6kfx6rsHV2ow +// This Handlebars helper avoids a pointless redirect by transforming +// this to the URL of the underling page, in this case +// http://eofdreams.com/fish.html +// +Handlebars.registerHelper('mkws-googleurl', function(obj) { + if (!obj) { + return "obj undefined"; + } else if (!obj[0]) { + return "obj[0] undefined, JSON=" + $.toJSON(obj); + } else { + return mkws.getParameterByName('q', obj[0]); + } +}); + + +// ### This works inefficiently by having multiple teams all run the +// same search against different sets of targets. A much better +// approach would be run a single search, with all these panels +// members of the same team, but picking out only the results relevant +// to them. That will be more work. + +mkws.registerWidgetType('Credo', function() { + var that = this; + + this.team.registerTemplate('CredoImage', '\ +

\ + \ + {{#mkws-first md-thumburl}}\ + {{../md-title}}

\ + {{/mkws-first}}\ +
\ + \ +

\ +

\ +'); + + var s = [] + // Main panel: encylopaedia and images on the left, topics on the right + s.push('

'); + + s.push('

'); + //s.push(section('encyclopaedia', 'Topic Page: ', + s.push(this.subwidget('Reference', { _team: 'ref', paragraphs: 1 })); + // The Images widget needs to be in our team so we can set its template + s.push('

'); + + s.push('

'); + s.push(section('mindmap', 'Create a Mind Map for ', + this.subwidget('Mindmap', { _team: 'main', facet: 'subject' }))); + s.push(section('topics', 'Related Topics', + this.subwidget('Facet', { _team: 'main', facet: 'subject' }))); + s.push('

'); + + s.push('

'); + s.push(section('image col-md-12', 'Images', this.subwidget('GoogleImage', { maxrecs: 4, template: 'CredoImage' }))); + s.push('

'); + + + s.push('

'); + s.push(section('entries clearfix col-md-4 col-sm-6', 'Credo Entries', + this.subwidget('Records', { _team: 'main' }))); + s.push(section('articles clearfix col-md-4 col-sm-6', 'Articles', + this.subwidget('Records', { _team: 'articles', targetfilter: 'categories=articles' }))); + s.push(section('books clearfix col-md-4 col-sm-6', 'Books', + this.subwidget('Records', { _team: 'books', targetfilter: 'categories=books' }))); + s.push(section('news col-md-4 col-sm-6', 'News', + this.subwidget('Records', { _team: 'news', targetfilter: 'categories=news' }))); + s.push(section('resources col-md-4 col-sm-6', 'Suggested Resources', + "### Not yet implemented")); + s.push('

'); + this.node.html(s.join('')); + + // Fill in the titles from the query once widgets have all been prepared + var that = this; + this.team.queue("ready").subscribe(function() { + var query = toTitleCase(that.config.query); + that.log("got query '" + query + "' from team config"); + mkws.$('.x-mkws-title').html(query); + mkws.$('title').html("MKWS: " + query); + + mkws.$(".mkwsSummary img").addClass("media-object"); + console.log(mkws.$("body").html()); + + // Derived from http://stackoverflow.com/questions/196972/convert-string-to-title-case-with-javascript + function toTitleCase(str) { + return str.replace(/\w\S*/g, function(txt) { + return txt.charAt(0).toUpperCase() + txt.substr(1); + }); + } + }); + + + function section(xclass, title, content) { + var s = []; + s.push('

'); + s.push('

' + title + '

'); + s.push('

' + content + '

'); + s.push('

'); + return s.join(''); + } + + function sectionRow(xclass, title, content) { + var s = []; + s.push('

'); + s.push(section(xclass, title, content)); + s.push('

'); + return s.join(''); + } +}); + + +mkws.registerWidgetType('Mindmap', function() { + this.node.html("### We do not yet have a Mindmap widget"); +}); diff --git a/examples/htdocs/mkws-widget-credo.css b/examples/htdocs/mkws-widget-credo.css index 2b7d71b..57c51cf 100644 --- a/examples/htdocs/mkws-widget-credo.css +++ b/examples/htdocs/mkws-widget-credo.css @@ -77,3 +77,12 @@ width: 98%; } +.mkwsCredit { + font-size: small; + text-align: right; +} + +.mkwsCredit::before { + content: "Source: "; + font-weight: bold; +} diff --git a/examples/htdocs/mkws-widget-credo.js b/examples/htdocs/mkws-widget-credo.js index a41ec88..59a9a13 100644 --- a/examples/htdocs/mkws-widget-credo.js +++ b/examples/htdocs/mkws-widget-credo.js @@ -44,7 +44,7 @@ mkws.registerWidgetType('Credo', function() { s.push(''); s.push(section('encyclopaedia', 'Topic Page: ', - this.subwidget('Reference', { _team: 'ref' }))); + this.subwidget('Reference', { _team: 'ref', paragraphs: 1 }))); // The Images widget needs to be in our team so we can set its template s.push(section('image', 'Images', this.subwidget('GoogleImage', { maxrecs: 4, template: 'CredoImage' }))); diff --git a/examples/htdocs/ref-bootstrap.html b/examples/htdocs/ref-bootstrap.html new file mode 100644 index 0000000..91430f0 --- /dev/null +++ b/examples/htdocs/ref-bootstrap.html @@ -0,0 +1,40 @@ + + + + + + + MKWS demo: Compound reference widget + + + + + + + + + + + + + + diff --git a/src/mkws-handlebars.js b/src/mkws-handlebars.js index 916ddba..605282f 100644 --- a/src/mkws-handlebars.js +++ b/src/mkws-handlebars.js @@ -1,13 +1,26 @@ // Handlebars helpers + Handlebars.registerHelper('mkws-json', function(obj) { return $.toJSON(obj); }); -Handlebars.registerHelper('mkws-paragraphs', function(obj) { +// This is intended to handle paragraphs from Wikipedia, hence the +// rather hacky code to remove numbered references. +// +Handlebars.registerHelper('mkws-paragraphs', function(obj, count) { var acc = []; - for (var i = 0; i < obj.length; i++) { - acc.push('

', obj[i], '

'); + + // For some reason, Handlebars provides the value + // {"hash":{},"data":{}} for parameters that are not provided. So we + // have to be prepared for actual numbers, explicitly undefined + // values and this dumb magic value. + if (count === undefined || count.hasOwnProperty('hash') || count == 0 || count > obj.length) { + count = obj.length; + } + + for (var i = 0; i < count; i++) { + acc.push('

', obj[i].replace(/\[[0-9,]+\]/g, ''), '

'); } return acc.join(''); }); diff --git a/src/mkws-widget-reference.js b/src/mkws-widget-reference.js index 7bccbcf..041d9e4 100644 --- a/src/mkws-widget-reference.js +++ b/src/mkws-widget-reference.js @@ -12,8 +12,7 @@ mkws.registerWidgetType('Reference', function() { {{#if md-title-responsibility}}\ {{md-title-responsibility}}\ {{/if}}\ -

\ - {{{mkws-paragraphs md-description}}}\ -

\ + {{{mkws-paragraphs md-description ' + this.config.paragraphs + '}}}\ +

Wikipedia

\ '); });