Skip to content
This repository has been archived by the owner on Jun 14, 2020. It is now read-only.

Commit

Permalink
Tip docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Craga89 committed Jun 6, 2012
1 parent ae76d8b commit 85fe7ea
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
3 changes: 2 additions & 1 deletion docs/plugins/ajax.md
Expand Up @@ -215,4 +215,5 @@ $('.selector').qtip({
* [content.text](../content.md#text)

### Notes
* Even though the content.text will not be used, it must be set to something valid i.e. non-blank, so that the qTip will be considered valid and rendered.
* Even though the content.text will not be used, it must be set to something valid i.e. non-blank, so that the qTip will be considered valid and rendered.
* This option an extension of the regular [jQuery.ajax](http://api.jquery.com/jQuery.ajax/) object and **is not** a core jQuery.ajax option. It will only work with qTip<sup>2</sup>!
4 changes: 3 additions & 1 deletion docs/plugins/bgiframe.md
Expand Up @@ -2,13 +2,15 @@

<a name="overview"></a>
## Overview
This plugin is simply a wrapper around the [BGIFrame jquery plugin](http://plugins.jquery.com/project/bgiframe) by Brandon Aaron,
This plugin is simply a wrapper around the [IE6 BGIFrame jquery plugin](http://plugins.jquery.com/project/bgiframe) by Brandon Aaron,
utilising qTip<sup>2</sup>'s [API](../api.md) to keep the plugin updated and compatible.

<a name="usage"></a>
## Usage
This particular plugin requires no additional user configuration. In order to utilise it, simply make sure it's included in your [qTip<sup>2</sup> build](http://craigsworks.com/projects/qtip2/tutorials/github).

Note that this is a compatability plugin for IE6 only, and will have no effect in any other browser.

<a name="elements"></a>
## Elements
**In IE6 only**, the created BGIframe element is available through the API's elements object:
Expand Down
8 changes: 4 additions & 4 deletions docs/plugins/tips.md
Expand Up @@ -62,7 +62,7 @@ true, [&quot;Corner&quot;](../position.md#basics), false *(Default: true)*
Defines where in relation to the **tooltip** the speech bubble tip is applied. Check-out the [positioning docs](../position.md#basics) for a full set of corner strings.

### Examples
Let's create a regular qTip with a tip whose corner is inherited from the [position.my](<?=WEB_DIR;?>/docs/position.md#my) option:
Let's create a regular qTip with a tip whose corner is inherited from the [position.my](../position.md#my) option:

```js
$('.selector').qtip({
Expand All @@ -77,7 +77,7 @@ $('.selector').qtip({
});
```

We can also manually specify a different corner like so (if [viewport adjustment](<?=WEB_DIR;?>/docs/position.md#viewport) is enabled, the tip position *will not* be adjusted):
We can also manually specify a different corner like so (if [viewport adjustment](../position.md#viewport) is enabled, the tip position *will not* be adjusted):

```js
$('.selector').qtip({
Expand All @@ -93,8 +93,8 @@ $('.selector').qtip({
```

### See also
* [position.viewport](<?=WEB_DIR;?>/docs/position.md#viewport)
* [position.my](<?=WEB_DIR;?>/docs/position.md#my)
* [position.viewport](../position.md#viewport)
* [position.my](../position.md#my)

### Notes
* When set to true, the tip position will be inherited from the [position.my](../position.md#my) property and adjusted automatically if [viewport adjustment](../position.md#viewport) is enabled.
Expand Down

0 comments on commit 85fe7ea

Please sign in to comment.