Readme.md 2.29 KB
Newer Older
Tobias Steiner's avatar
Tobias Steiner committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Histhub widget
The histhub widget can display sameas resources from histhub linking services. You can integrate it into your site and display links to other providers. __The widget and the apis are in beta status. They may change in the future.__
## Webcomponent
The widget itself is a [webc omponent](https://en.wikipedia.org/wiki/Web_Components). It integrates smoothly into an existing website. You just need to add some markup and load a javascript file.
## Integration
Just have a look at the examp,e folder. There you can find a set of working examples.
```html
<html>
<head>
    <!-- load the script in your header -->
    <script src="../src/histhub-widget.js"></script>
</head>
</html>
```
```html
<!-- add the component wehre you like to display the links -->
<histhub-widget endpoint="ENDPOINT" resolver="RESOLVER" location="URL TO LOOK FOR"></histhub-widget>
```
## API
### Endpoint
The endpoint defines the restapi, where the widget makes the call to get the links. Currently we provide three endpoints for different resource types.
* Tagcloud https://api.tagcloud.histhub.ch/v1/sameas/
* Geolinker https://api.geolinker.histhub.ch/v1/sameas/
* Geolinker https://api.geolinker.histhub.ch/v1/similarto/
25
26
* Geolinker https://api.geolinker.histhub.ch/v1-1/sameas/ (newer apis)
* Geolinker https://api.geolinker.histhub.ch/v1-1/similarto/ (newer apis)
Tobias Steiner's avatar
Tobias Steiner committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
* Orgalinker https://api.orgalinker.histhub.ch/v1/sameas/

Choose one of the endpoint to get links for your resource
### Resolver
The endpoint uses different technologies to generate the links. Those technologies calls resolver. You need to define a resolver to get the links for your preferences.

__Tagcloud and Orgalinker__

For those two services we provide the `resolvermanual` . The links provided by this resolver are done by humans. See examle 1 and example 2

__Geolinker__

The geolinker provides for the `sameas` endpoint the  `resolverneo4j` resolver. The links provided by this resolver are done semiautomatical. See example 3

For the `similarto` endpoint the geolinker provides a `elasticsearchresolver`. The data are guessed based on a matching algorithm. See example 4

### Location
The location is an optional parameter. By default the widget uses the current window.location.href to make the request. You can specify the url to look for over the url parameter