Merge remote-tracking branch 'upstream/dev' into scaling-upgrades-M2

Author: chreman

CHANGELOG.md

@@ -0,0 +1,80 @@
+# Changelog
+
+## 2022-01-31
+
+### New features
+
+- new citation button & modal generating citations (APA, MLA, Chicago, ACM) for each paper
+
+### Changes
+
+- unified appearance and functionality of copy buttons in modals
+- FontAwesome update: new icons; reduced dependency on outer page imports
+
+### Bug fixes
+
+- fixed crashing app when a pdf preview was opened during animation
+
+### Internal
+
+- removed unused local examples; added new local examples (triple, viper, covis)
+
+## 2022-01-20
+
+### New features
+
+- backend data sanitization
+- pdfs searchable by the searchbox
+
+### Changes
+
+- data preprocessing refactoring
+
+### Bug fixes
+
+- footer size on narrow screens
+
+### Internal
+
+- test database update
+
+## 2021-12-22
+
+### Changes
+
+- unified HTML & CSS of various paper tags (access tags, dataset tag, custom tags)
+
+## 2021-12-09
+
+### New features
+
+- added abbreviation to list entry items (heading, source, authors)
+
+### Changes
+
+- refactored list entries code
+- heading & list UI changes
+    - moved info button to the context line
+    - moved pdf button
+    - minor list changes
+- major CSS changes (restyled the whole Headstart)
+
+### Removed
+
+- link buttons from list
+
+## 2021-11-25
+
+### New features
+
+- zooming and selecting papers with browser's back/forward buttons
+- adding a zoomed bubble/selected paper name to the page title
+
+### Changes
+
+- improved hot reloading in webpack
+- urls of local examples have changed
+
+### Removed
+
+- dead tracking code (Google Analytics, our custom endpoint) and related config parameter

README.md

@@ -9,7 +9,16 @@ Head Start is a web-based knowledge mapping software intended to give researcher
 ### Client
 To get started, clone this repository. Next, duplicate the file `config.example.js` in the root folder and rename it to `config.js`.
 
-Make sure to have `npm` version 6.11.3 installed (it comes with Node.js 10.17.0, best way to install is with [nvm](https://github.com/nvm-sh/nvm), `nvm install 10.17.0`) and run the following two commands to build the Headstart client:
+Set the `skin` property in the config to one of the following values to use the
+particular data integration skin:
+
+- `"covis"`
+- `"triple"`
+- `"viper"`
+
+or leave it empty (`""`) for the default project website skin.
+
+Make sure to have installed `node` version >= 14.18.1 and `npm` version >=8.1.1 (best way to install is with [nvm](https://github.com/nvm-sh/nvm), `nvm install 14.18.1`) and run the following two commands to build the Headstart client:
 
     npm install
     npm run dev
@@ -20,15 +29,24 @@ Now you can run a local dev server:
 
 	npm start
 
-To run Headstart on a different server (e.g. Apache), you need to set the publicPath in `config.js` to the URL of the `dist` directory:
-* Dev: specify the full path including protocol, e.g. `http://localhost/headstart/dist`
-* Production: specify the full path excluding protocol, e.g. `//example.org/headstart/dist`
+Note: you can also set the skin in this step as an argument to the `npm start` command (e.g. `npm start -- --env skin=triple`).
 
-Point your browser to the following address:
+The browser will automatically open a new window with the example specified by the skin.
 
-	http://localhost:8080/examples/local_files/index.html
+Alternatively, you can point your browser to one of the following addresses:
 
-If everything has worked out, you should see the visualization shown above.
+	http://localhost:8080/project_website/base.html
+	http://localhost:8080/project_website/pubmed.html
+	http://localhost:8080/local_covis/
+	http://localhost:8080/local_triple/map.html
+	http://localhost:8080/local_triple/stream.html
+	http://localhost:8080/local_viper/
+
+If everything has worked out, you should see the example visualization.
+
+To run Headstart on a different server (e.g. Apache), you need to set the publicPath in `config.js` to the URL of the `dist` directory:
+* Dev: specify the full path including protocol, e.g. `http://localhost/headstart/dist`
+* Production: specify the full path excluding protocol, e.g. `//example.org/headstart/dist`
 
 See [client configuration](doc/README.md) for details on adapting the client.
 
@@ -42,7 +60,7 @@ See [Installing and configuring the server](doc/server_config.md) for instructio
 
 Maintainer: [Peter Kraker](https://github.com/pkraker) ([pkraker@openknowledgemaps.org](mailto:pkraker@openknowledgemaps.org))
 
-Authors: [Maxi Schramm](https://github.com/tanteuschi), [Christopher Kittel](https://github.com/chreman), [Asura Enkhbayar](https://github.com/Bubblbu), [Scott Chamberlain](https://github.com/sckott), [Rainer Bachleitner](https://github.com/rbachleitner), [Yael Stein](https://github.com/jaels), [Thomas Arrow](https://github.com/tarrow), [Mike Skaug](https://github.com/mikeskaug), [Philipp Weissensteiner](https://github.com/wpp), and the [Open Knowledge Maps team](http://openknowledgemaps.org/team)
+Authors: [Maxi Schramm](https://github.com/tanteuschi), [Christopher Kittel](https://github.com/chreman), [Jan Konstant](https://github.com/konstiman), [Asura Enkhbayar](https://github.com/Bubblbu), [Scott Chamberlain](https://github.com/sckott), [Rainer Bachleitner](https://github.com/rbachleitner), [Yael Stein](https://github.com/jaels), [Thomas Arrow](https://github.com/tarrow), [Mike Skaug](https://github.com/mikeskaug), [Philipp Weissensteiner](https://github.com/wpp), and the [Open Knowledge Maps team](http://openknowledgemaps.org/team)
 
 
 ## Features
@@ -90,4 +108,4 @@ Head Start is licensed under [MIT](LICENSE).
 ## Citation
 If you use Head Start in your research, please cite it as follows:
 
-Peter Kraker, Christopher Kittel, Maxi Schramm, Rainer Bachleitner, Thomas Arrow, Scott Chamberlain, Asura Enkhbayar, Yael Stein, Philipp Weissensteiner, Mike Skaug, Katrin Leinweber & Open Knowledge Maps team and contributors. (2019, March 7). Headstart 5 (Version v5). Zenodo. http://doi.org/10.5281/zenodo.2587129
+Peter Kraker, Christopher Kittel, Maxi Schramm, Jan Konstant, Rainer Bachleitner, Thomas Arrow, Scott Chamberlain, Asura Enkhbayar, Yael Stein, Philipp Weissensteiner, Mike Skaug, Katrin Leinweber & Open Knowledge Maps team and contributors. (2019, March 7). Headstart 5 (Version v5). Zenodo. http://doi.org/10.5281/zenodo.2587129