Loading...
 

HPN user documentation

Historical Place Names Microservice end-user documentation

 

 

Introduction

The Historical Place Names (HPN) microservice have been developed by Vilnius University Faculty of Communication and VšĮ “Atvirojo kodo sprendimai”. HPN microservice are semi-automatic historical geo-information management functions designed for aggregation and enhanced usage of digital heritage information. HPN web service has been developed during LoCloud project, the Best Practice Network consisting of 30 different European countries and partly-funded by the European Commission.

HPN microservice is available at: <http://hpn.aksprendimai.lt/unitedgeo/>.

 

This user manual includes simple instructions on how to use the LoCloud HPN Microservice.

Have a nice trip to historical space!

 

Rimvydas Laužikas, Associated professor, Vilnius University Faculty of Communication

Justinas Jaronis, Director, VšĮ “Atvirojo kodo sprendimai”

 

 

User interface overview

The main screen (Home page) is divided into five areas which are the main components ofthe user interface:

 

Image  

1. The header area containing logo and website title.

2. The top menu area containing menu buttons for navigation:

  • HPN button – return to the main screen (Home page).
  • Search/Propose HPN button – redirects to the search/propose HPN screen, which allows providers and aggregators to search for HPN in LoCloud HPN Thesaurus and/or individually crowdsource and enrich their historic geodata.
  • Send HPN database button - redirects to the send HPN database screen, which allows providers and aggregators to transfer big HPN sets from local systems to LoCloud HPN Thesaurus.
  • Web Service button - redirects to the API.
  • Documentation button - redirects to HPN microservice documentation (microservice description and end-user documentation).
  • Register – redirects to new user registration screen.
  • Login – login screen for registered users.

3. The left area containing a short description of HPN microservice.

4. The right (map) area containing an interactive clusstered map – visualization, showing LoCloud HPM Thesaurus content on contemporary map.

5. The footer area containing partners logotypes, Terms of Service and Privacy.

This section of the manual contains step by step instructions on how to perform specific HPN microservice tasks.

 

 

Search/Propose HPN

Task description: by using this screen microservice allows providers and aggregators to crowdsource and enrich their historic geodata, including the possibility of providing individual historical geo-data manually via a user interface. By using this screen user can check availability of HPN in LoCloud HPN Thesaurus and propose a new HPN. 

 

Search/Propose HPN screen:

Image  

It consists of:

  1. The header area containing logo and website title.
  2. The top menu area containing menu buttons for navigation (see description of the main screen/Home page).
  3. The description area containing a short description of the search/propose HPN task.
  4. Search/Propose HPN user interfacearea allowing providers and aggregators to search for HPN in LoCloud HPN Thesaurus. 

 

Performing “Search HPN” task

  • Search HPN user interface (area No. 4) allows providers and aggregators to search for HPN in LoCloud HPN Thesaurus. In order to perform this task user can fill the form by writing historical place name or coordinates, or click on any contemporary place name on the map (clicking also fills the coordinates field). Make sure You have entered the coordinates or place name.
  • Results could be filtered by language and temporal criteria (by filling the Language and Temporal fields).
  • User can start search task by clicking “Submit” button.
  • By “Clear All” button user can clear all fields in the searching form.
  • After submitting user will be redirected to LoCloud HPN Thesaurus screen. The latter is divided into five areas:
  •  

Image  

1. The header area containing logo and website title.

2. The map area showing searched Historical Place Name on contemporary map.

3. The information area containing the description of searched Historical Place Name:

  • United geoname – matched contemporary geoname
  • Geographical distance – distance between matched geoname and user selected coordinates (in case of coordinates search)
  • Ngram distance – ngram distance between HPN and contemporary place name (in case of HPN search)
  • Percentage - ranked accuracy by using special algorithm (e.g. if name and coordinates are exact, it will be ranked as 100%; if name is exact, but coordinates deviate by 100%, it will be ranked as 55%; if name is exact, but coordinates deviate by 50%, it will be ranked as 75%; if name is not exact and coordinates do not match allowed deviation, it will be ranked as 0%).
  • Remark – remarks (only if they are added to HPN in LoCloud HPN Thesaurus)
  • Best match – user possibility (function) to mark and submit (by clicking “Submit” button) information about the best matching result between searched HPN and LoCloud HPN Thesaurus record.
  • Synonyms – information about matched place names, including place name, WGS coordinates, regions and subregions.

4. HPN proposal area, which can be used for providing individual new historical geo-data manually.

5. The footer area containing partners logotypes.

 

Performing “Propose HPN” task

  • If user wants to propose new individual HPN manually he/she must repeat the “search HPN” task.
  • After submitting user will be redirected to LoCloud HPN Thesaurus screen, without matched HPN results in LoCloud HPN Thesaurus.

 

Image  

 

  • User can click “Add place to match with” hyperlink in the HPN proposal area

 

Image  

 

  • After clicking user opens LoCloud HPN Thesaurusproposal interface

 

Image  

In LoCloud HPN Thesaurus proposal interface user can fill the following fields:

  • United geoname (required field) – contemporary place name, which overlaps with the HPN proposed by user. If proposed HPN can’t be overlapped with any contemporary place name, user must choose the possible nearest contemporary place name and show the distance between proposed HPN place and contemporary place via field Geographical distance.
  • Geographical distance (not-required field) – distance between centre (point coordinates) of the place with the HPN proposed by user and the centre of matched contemporary geoname (field United geoname).
  • Ngram distance (not-required field)] – ngram distance between HPN and contemporary place name (in case of  HPN search)
  • Percentage (not-required field) - rank accuracy between proposed HPN and matched contemporary geoname (field United geoname). The field constitutes users personal opinion about semantic relevance from 0% (absolutely not relevant) to 100 % (absolutely relevant). E.g. we know HPN “Memel” is 100% semantically relevant to contemporary place name Klaipėda, but geographical distances between centres of polygons “Memel in 16th century” and “Klaipėda in 21th century” could be about 1,5 kilometres.
  • Remark (required field) – remarks about proposed HPN. Note: chronological information about proposed HPN (existence of HPN) is usually limited in time (from...to).
  • Best match (required field) – must be ticked by user (marked by tick).

 

 
Send HPN database

Task description: this screen allows providers transfer large HPN sets from local systems to LoCloud HPN Thesaurus. HPN geo-data could be be imported in on of these formats: GeoJSON,  JSON, CSV, SQL, TXT. Imported datasets will be matched with other historical geo-data in HPN Thesaurus by using an automatic HPN data Import tool. After the matching a manual quality check should be carried out by user and a new HPN will be added to the HPN Thesaurus.
 

“Send HPN database” screen

Image

 
1. The header area containing logo and website title.
2. The top menu area containing menu buttons for navigation (see description of the main screen/Home page).
3. The description area containing short description of “Send HPN database” task.
4. “Send HPN database” user interface allowing providers and aggregators to send HPN database to LoCloud HPN Thesaurus.
5. The footer area containing partners logotypes.

 

Performing “Send HPN database” task

  • “Send HPN database” user interface (area No. 4) allows providers and aggregators to transfer large HPN sets from local systems to LoCloud HPN Thesaurus. In order to perform this task user should choose GeoJSON, JSON, CSV, SQL or TXT file from personal computer and fill the form in the field “E-mail” (your e-mail and required information for further contacts) as well as the field “Information” (more information about transferred database is not required).
  • User can send the file by clicking “Submit” button.
  • HPN geo-data will be automatically matched with other historical geo-data in LoCloud HPN Thesaurus.
  • After the matching user will be informed about updating process and will be asked to check/correct questioned historical geo-data.
  • After manual quality check new HPN database will be integrated into LoCloud HPN Thesaurus.

 

 

Webservice (API) functions


If You wish to use our API for Geographical names submitting and query service, please register at the HPN website.

Demo login and technical details are present here:
LoCloud D3.5 HPN microservice v1.3 (276,4 KB)
Base webservice URL is present at <http: api="" hpn="" tautosaka.llti.lt="">
For more information please contact us <info@aksprendimai.lt>

 

 


Show php error messages