=== Biovista Vizit WP Plugin ===
Contributors: vasvir
Tags: biovista vizit, pubmed, data integration
Requires at least: 5.2
Tested up to: 6.8.2
Requires PHP: 5.6
Stable tag: trunk
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl.html

Integrate Biovista Vizit in your site with a simple shortcode.

== Description ==
This plugin enable Wordpress Users with a **valid Biovista Vizit Licence** for their site to integrate it in their desired posts and pages with a simple shortcode.

Plugin also handles the 'Google Indexing' support required for social networks in order to provide a nice preview of Vizit graph urls.

= Usage =

Use the shortcode '[biovista-vizit]' in the post you want to embed Biovista Vizit. Shortcode represents a div that can be styled through **style** and **class** attributes in the shortcode itself. Biovista Vizit div needs a height specification. By default Biovista Vizit will use all the available width of the parent container and it will auto sense browser resize events.

The shortcode can preload a graph by using the **bv_gid** attribute. If shortcode has content then this is used to hide Vizit behind it. In that case a button with an id needs to also be specified in order to be possile to reveal the Vizit.

The availablle options are:
* style -- HTML attribute
* class -- HTML attribute
* bv_gid -- graph to preload. It doesn't change the url
* show_vizit -- Selector of a clickable element (button) that unhides the Vizit
* show_help -- default: false. Show help buttons outside Vizit
* add_and_expand -- Another way to load a simple graph (rosetta) without changing the browser’s url is to specify an entity via the entity_name and automatically perform a one-step expansion. The option variables are separated by the pipe symbol (|):
  * Option1: entity_name -- Required. the name of the entity you want to add to your graph.
  * Option2: entity_type -- Optional. Specifies an entity type for the initial entity. If omitted Vizit will try to match to any of the supported entity. types. Valid entity_types are Gene, Pathway, Disease etc.
  * Option3: expand_entity_type -- Optional. The entity type of the expanded entities. If omitted will try to auto guess an expansion type.
  * Example: add_and_expand = 'hif1a|Gene|Pathway' which is eqivalent to add_and_expand = 'hif1a'.
  * Note: This function requires that no graph loading takes place - that means that bv_gid should not be defined for this function to work.

Examples:

** Don't hide Vizit - no graph preloading **
```
[biovista-vizit style='height: 600px; border: 1px solid gray;']
```

** Hide Vizit - preload a graph **

```
[biovista-vizit style='height: 600px; border: 1px solid gray;' bv_gid='7e9dff9e1d36f2e79fbca0e54e777b09' showVizit='#showVizitButton']<div>Add more text. Center the button. Style everything</div><button id='showVizitButton'>Explore Pubmed</button>[/biovista-vizit]
```

to make it look like Biovista Vizit's page here is the markup

```
[biovista-vizit style='height: 600px; border: 1px solid gray;' bv_gid='7e9dff9e1d36f2e79fbca0e54e777b09' show_vizit='#showVizitButton']<h1>A new way to explore PubMed</h1><div class='bv-center'><h3>Is there something relevant I'm missing?</h3></div><h3 class='bv-big'><a id='showVizitButton' href='javascript:;'><span class='bv-round-button'>Start</span> connecting</a></h3>[/biovista-vizit]
```
= Image API =
Biovista Vizit exposes graph image in various formats via its image API. In order to access the image of a known graph such as 7e9dff9e1d36f2e79fbca0e54e777b09 use one of the following urls:
* PNG: /vizit-image/7e9dff9e1d36f2e79fbca0e54e777b09.png
  * optional dpi argument (default: 96). Example /vizit-image/7e9dff9e1d36f2e79fbca0e54e777b09.png?dpi=300
* SVG : /vizit-image/7e9dff9e1d36f2e79fbca0e54e777b09.svg
* EPS : /vizit-image/7e9dff9e1d36f2e79fbca0e54e777b09.eps

= Roadmap =
* Gallery: Custom Post Types for Vizit graphs

== Installation ==
* Download Biovista Vizit WP plugin from https://www.biovista.com/wordpress-plugins/biovista-vizit.zip
* In Wordpress go to plugins and click add new. Upload the zip file
* Activate the plugin through the Plugins menu in WordPress
* Go to Settings/Biovista Vizit WP Plugin and customize it for your site
	
== Frequently Asked Questions ==
Q: Can I use more than one Biovista Vizit in one page?

A: No you can use only one Biovista Vizit instance per page.

== Screenshots ==
1. Embed Biovista Vizit in your Page or Post
2. Create a graph
3. Post it to social networks

== Changelog ==

= 1.9.7 =
* Fixes for PHP 8.4

= 1.9.1 =
* BUGFix: display properly the contributors in the plugin View details
* Update compatibility requirements a bit

= 1.8.1 =
* BUGFix: Minor image logging bug
* Update compatibility requirements a bit

= 1.8 =
* Expose Vizit Image API

= 1.7.3 =
* LinkedIn adjustemnt: It was getting confused from the REST and OEMBED wordpress API

= 1.7.2 =
* BUGFix: Handle wordpress title in ajax crawling case (requires WP >= 4.4)

= 1.7.1 =
* BUGFix: escape properly \n

= 1.7 =
* Handle All In One SEO Pack

= 1.6 =
* Implemented add_and_expand functionality
* BUGFix: Show help also when Vizit is not hidden

= 1.5 =
* More shortcode options

= 1.4 =
* Settings page

= 1.3 =
* Parse readme.txt markdown

= 1.2 =
* Auto update functionality

= 1.1 =
* Server side handling - google indexing support

= 1.0 =
* Stable Release
* Client side handling

= 0.9 =
* Development Release

== Upgrade Notice ==
Upgrades should be handled automatically.

Please upgrade regularly to keep your Biovista Vizit Plugin as current as possible.
