oriel-hub / okhub-html-widget

OKHub-HTML-Widget

The OKhub Javascript Web Widget allows users to configure and embed a widget on their website which automatically displays research content on international development issues from the OKhub.

Please note:

This repository is the codebase for hosting the widget. To access the widget itself and obtain the embed code, please visit the OKhub Javascript Web Widget page

okhub-html-widget's Issues

Update readme

Update the readme file to explain how to install, including wrapper.

Enable source selection

Allow ability on the form to select sources from all available in the hub

Function getArrayTitles in okhubwrapper.response.inc needs updating

The method/function getArrayTitles should call method $object->getField instead of direct reference to property - e.g. $object->title should be $object->getTitle('title')

Country selection as auto-complete

Implement pending code to show the list of countries as an auto-complete box.

Add footer to landing page

The OKhub footer is not included on the page

Form is not in a <form> tag

Add a form tag so that the HTML is valid and allows submission using keyboard.

Customised widget loses filters on search

A customised widget is implemented on a website. If a visitor then makes a text search, the filters are lost and results come from the whole of the OKhub.
There is no way to return to the filtered list (or remove the search as searching for nothing returns no results)

The customised widget should retain all filters once implemented on a site.

getField method is returning an array of titles

Calling $object->getTitle('title') is returning an array for documents objects. I think this is where there are titles in related themes, for example. Where no source is given, it should return the 'hub' version of the document title.

Re-sizing display of document display overlay

Show the document details as an overlay taking up a proportion of the screen, which will allow for smoother transitions between different source versions. Suggest 90% of screen height.

Display name of source, rather than capitalised code

Show the name of the source from the API lookup

Check calls use minimum bandwidth

The code should be reviewed to ensure that the most appropriate call is made to the API so that minimal bandwidth is used. (ie. short/core/full)

Widget fails to load if form submits without javascript

If the customise widget form submits without javascript and the page URL has a list of parameters this makes the widget hang. Only happens very sporadically.

Improve information about sources

Suggest we raise the profile of the providers contribution, especially as links are only to full-text document.

Links to all URLs

Each record may have more than one URL, but only one url is used (Linked from the title).
All url links should be shown below the abstract.

Text colour change not reflected in document list

The text colour only affects the headings, not the list of documents. Similarly, the colour is not reflected in the text of the pop up window.

Change selection of sources to top of screen

On document display overlay, the sources should work as tabs at the top of the content so that it is clear that there are multiple versions available and which is shown by default

Enable "not source" selection

Allow implementing organisations to hide/exclude a specific source from the results (so they can host on their own website)

Country selection auto-complete only allows one country to be chosen

This should include the ability to pick more than one country

Removing of colour does not work

If a colour is set and then removed, the change is not reflected in the code