<commit_before># How you can contribute to Open Access Vis

Please create an [issue](https://github.com/steveharoz/open-access-vis/issues) to:

* Add missing data
* Fix incorrect data
* Add thumbnails (a missing thumbnail or a better version of an existing one)

**Important: Do not retrieve any information from IEEE (especially abstracts and thumbnails). Everything should come from other sources.**

## Adding a workshop:

All you have to do is add the data to [the workshop spreadsheet](https://docs.google.com/spreadsheets/d/11ZNUflBnK47ljl_g0NVJFntP1xb8qsSv-PcpinoeWRw). Email me for more info.

## URLs:

* URLs on an open access repository are prioritized for longevity.
* White-listed open access repositories are in the `OADomains` variable in [js/load.js](../js/load.js#L12). Let me know if others should be added.
* For URLs outside of an open access repository, it must be on the site of an author or their institution.
* The paper must be viewable directly in a browser without any required download.

## Explanation page:

The explanation page is for sites that contain more than the basic information. It's not simply a "landing page", and it includes a simpler description of the project and/or a demo. Good examples:

* [Timecurves](http://www.aviz.fr/~bbach/timecurves/)
* [Timelines Revisited](https://timelinesrevisited.github.io/)
* [Isotype Visualization](http://steveharoz.com/research/isotype/) (blatent self promotion)

## Thumbnails

* The image should be 400 x 300 pixels.
* Try to find a figure that is explanatory rather than just eye candy.
* The filename is the first non-article word in the title + `"_"` + first name of first author + `".png"` (all lower case).  
For example, "A Nifty Vis System" by <NAME> and <NAME> would become `nifty_jane.png`

For now, thumbnails are not in the repository. Feel free to paste new ones into a github issue or email them to me.

## Videos

* Prioritize explanatory videos rather than teasers or eye candy.
* Videos on Youtube, Vimeo, or hosted as an MP4 should all work.
* Youtube spreadsheet format: `[youtube VIDEO_ID]`. For example `youtube Xj-AEmUwsvQ`
* Vimeo spreadsheet format: `[vimeo VIDEO_ID]`. For example `vimeo 223373844`
* Video file spreadsheet format: `[video VIDEO_URL]`.  For example  
`video http://timelinesrevisited.github.io/supplemental/stories/routines.mp4`  
If the video file is hosted on a personal domain (not github), ask for permission before using.<commit_msg>readme formatting<commit_after># How you can contribute to Open Access Vis

Please create an [issue](https://github.com/steveharoz/open-access-vis/issues) to:

* Add missing data
* Fix incorrect data
* Add thumbnails (a missing thumbnail or a better version of an existing one)

**Important: Do not retrieve any information from IEEE (especially abstracts and thumbnails). Everything should come from other sources.**

## Adding a workshop:

All you have to do is add the data to [the workshop spreadsheet](https://docs.google.com/spreadsheets/d/11ZNUflBnK47ljl_g0NVJFntP1xb8qsSv-PcpinoeWRw). Email me for more info.

## URLs:

* URLs on an open access repository are prioritized for longevity.
* White-listed open access repositories are in the `OADomains` variable in [js/load.js](../js/load.js#L12). Let me know if others should be added.
* For URLs outside of an open access repository, it must be on the site of an author or their institution.
* The paper must be viewable directly in a browser without any required download.

## Explanation page:

The explanation page is for sites that contain more than the basic information. It's not simply a "landing page", and it includes a simpler description of the project and/or a demo. Good examples:

* [Timecurves](http://www.aviz.fr/~bbach/timecurves/)
* [Timelines Revisited](https://timelinesrevisited.github.io/)
* [Isotype Visualization](http://steveharoz.com/research/isotype/) (blatent self promotion)

## Thumbnails

* The image should be 400 x 300 pixels.
* Try to find a figure that is explanatory rather than just eye candy.
* The filename is the first non-article word in the title + `"_"` + first name of first author + `".png"` (all lower case).  
For example, "A Nifty Vis System" by <NAME> and <NAME> would become `nifty_jane.png`

For now, thumbnails are not in the repository. Feel free to paste new ones into a github issue or email them to me.

## Videos

* Prioritize explanatory videos rather than teasers or eye candy.
* Videos on Youtube, Vimeo, or hosted as an MP4 should all work.
* Youtube spreadsheet format: `youtube VIDEO_ID`. For example `youtube Xj-AEmUwsvQ`
* Vimeo spreadsheet format: `vimeo VIDEO_ID`. For example `vimeo 223373844`
* Video file spreadsheet format: `video VIDEO_URL`.  For example  
`video http://timelinesrevisited.github.io/supplemental/stories/routines.mp4`  
If the video file is hosted on a personal domain (not github), ask for permission before using.
{'fraction_non_alphanumeric': 0.08529650690495533, 'fraction_numerical': 0.010560519902518278, 'mean_word_length': 4.496651785714286, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1499120', 'n_tokens_mistral': 1525, 'n_tokens_neox': 1421, 'n_words': 644}