SurVis release 0.1.0

README.md

@@ -4,19 +4,32 @@
 
 SurVis is a flexible online browser to present and analyze scientific literature. The system is made for authors of survey articles, theses, or books who want to share their references in a user-friendly way. All you need to start is a bib file and a list of keywords for your papers.
 
-SurVis reference literature database:
+Test SurVis with a reference literature database: http://dynamicgraphs.fbeck.com
 
-* Dynamic Graph Visualization - http://dynamicgraphs.fbeck.com
-
-Other literature databases using SurVis:
+## How To Use SurVis for Your Literature Collection
 
-* Visualizing Group Structures in Graphs - http://go.visus.uni-stuttgart.de/groups-in-graphs/
-* Performance Visualization - http://idav.ucdavis.edu/~ki/STAR/
-* Visualization for Software Reuse - http://www.cos.ufrj.br/~schots/survis_reuse/
-* Set Visualization - http://www.cvast.tuwien.ac.at/~alsallakh/SetViz/literature/www/index.html
-* Visualizing High-Dimensional Data - http://www.sci.utah.edu/~shusenl/highDimSurvey/website/
+Dowload the latest SurVis release or fork this repository.
+
+To start SurVis, open 'src/index.html' in your browser.
+
+The bibliography data is stored in 'bib/references.bib' in BibTeX format.
+
+Supplemental data is contained in 'src/data/':
+* 'tag_categories.js': list of special tag categories; they can be used as a prefix for the tags and appear, for instance, 'a:b' refers to tag 'b' in tag category 'a'
+* 'authorized_tags.js': tags that are defined through a description (highlighted in SurVis, description appears as a tooltip)
+* 'search_stopwords.js': a list of stopwords used to exclude terms from search queries
+* 'papers_pdf' (optional): PDF files of the papers, please use the BibTeX id as a file name
+* 'papers_img' (optional): PNG thumbnails for the papers, please use the BibTeX id as a file name
+
+Please do not edit the files in 'src/data/generated/' because they are created automatically. 
+
+After completing your changes, just run 'update_data.py' with Python 3. Reload SurVis in the browser to see the changed bibliography. The script will continue to check for updates on the bib file until you stop it.
 
-Currently, the system is distributed on request only. Please contact [email protected] if you are interested.
+If the edit mode is activated, BibTeX entries can be modified in the browser, but are not stored in the 'bib' directory. To make those changes persistent, use 'download BibTex' in SurVis and copy the BibTeX data to your bib file in the 'bib' directory. You can also use the features to save and load the data from local storage of the browser; be careful, however, these features are still experimental.
+
+Further properties of SurVis, such as the title of the page, can be modified in the file 'src/properties.js'. For the publication of your literature collection, you should usually deactivate the edit mode in the properties ('editable = false;').
+
+Enjoy SurVis and send feedback if you like.
 
 ## Learn more
 
@@ -27,6 +40,17 @@ Beck, Fabian; Koch, Sebastian; Weiskopf, Daniel: Visual Analysis and Disseminati
 * DOI: http://dx.doi.org/10.1109/TVCG.2015.2467757
 * Preview video: https://vimeo.com/136206061 
 
+## List of Literature Collections Using Survis
+
+* Dynamic Graph Visualization - http://dynamicgraphs.fbeck.com
+* Visualizing Group Structures in Graphs - http://go.visus.uni-stuttgart.de/groups-in-graphs/
+* Performance Visualization - http://idav.ucdavis.edu/~ki/STAR/
+* Visualization for Software Reuse - http://www.cos.ufrj.br/~schots/survis_reuse/
+* Set Visualization - http://www.cvast.tuwien.ac.at/~alsallakh/SetViz/literature/www/index.html
+* Visualizing High-Dimensional Data - http://www.sci.utah.edu/~shusenl/highDimSurvey/website/
+
+Please contact me ([email protected]) if you know other collections using SurVis.
+
 ## Contact
 
 Fabian Beck

bib/references.bib

@@ -0,0 +1,14 @@
+@article{Beck2016Visual,
+  abstract = {Bibiographic data such as collections of scientific articles and citation networks have been studied extensively in information visualization and visual analytics research. Powerful systems have been built to support various types of bibliographic analysis, but they require some training and cannot be used to disseminate the insights gained. In contrast, we focused on developing a more accessible visual analytics system, called SurVis, that is ready to disseminate a carefully surveyed literature collection. The authors of a survey may use our Web-based system to structure and analyze their literature database. Later, readers of the survey can obtain an overview, quickly retrieve specific publications, and reproduce or extend the original bibliographic analysis. Our system employs a set of selectors that enable users to filter and browse the literature collection as well as to control interactive visualizations. The versatile selector concept includes selectors for textual search, filtering by keywords and meta-information, selection and clustering of similar publications, and following citation links. Agreement to the selector is represented by word-sized sparkline visualizations seamlessly integrated into the user interface. Based on an analysis of the analytical reasoning process, we derived requirements for the system. We developed the system in a formative way involving other researchers writing literature surveys. A questionnaire study with 14 visual analytics experts confirms that SurVis meets the initially formulated requirements.},
+  author = {Beck, Fabian and Koch, Sebastian and Weiskopf, Daniel},
+  doi = {10.1109/TVCG.2015.2467757},
+  journal = {IEEE Transactions on Visualization and Computer Graphics},
+  keywords = {type:system, visual_analytics, sparklines, information_retrieval, clustering, literature_browser},
+  number = {01},
+  publisher = {IEEE},
+  volume = {22},
+  series = {TVCG},
+  title = {Visual Analysis and Dissemination of Scientific Literature Collections with {SurVis}},
+  url = {http://www.visus.uni-stuttgart.de/uploads/tx_vispublications/vast15-survis.pdf},
+  year = {2016}
+}

src/about.html

@@ -0,0 +1,46 @@
+<html>
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+	<style type="text/css">
+	html {
+		margin: 0px;
+		padding: 0px;
+	}
+
+	body {
+		font-family: Calibri, Arial, Sans;
+		margin: 0px;
+		padding: 0px;
+	}
+
+	label {
+		background: #FFFFEE;
+		border: 1px solid black;
+	}
+
+	a {
+		color: #223388;
+	}
+
+	iframe {
+		border: none;
+	}
+
+	a:active {
+		color: #223388;
+	}
+
+	a:visited {
+		color: #223388;
+	}
+
+	h1 {
+		font-size: 14pt;
+		border-bottom: 1px solid black;
+	}
+	</style>
+</head>
+<body>
+<p>This is a sample about page.</p>
+</body>
+</html>

src/data/authorized_tags.js

@@ -0,0 +1,7 @@
+define({
+	authorizedTags: {
+		"type:system": {
+			"description": "paper describing a system"
+		}
+	}
+});

src/data/available_pdf.js

@@ -0,0 +1 @@
+define({availablePdf: ["Ahn2011Task","Cengiz2013Visualization"]});