Various docs fixes

qTip2 · Jun 6, 2012 · b4761ba · b4761ba
1 parent 17eb088
commit b4761ba
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 18 deletions.
diff --git a/docs/content.md b/docs/content.md
@@ -89,7 +89,7 @@ This is useful for image galleries and other image-oriented sites that need to p
 ## content.title.text
 
 ### Values
-function(), jQuery([ ]), "String", false *(Default: false)*
+function(){}, jQuery([ ]), "String", false *(Default: false)*
 
 ### Overview
 Text/HTML which will appear inside the title element of the content. If set to false, no title will be created. An anonymous function can also be used to return
@@ -150,11 +150,14 @@ $('.selector').qtip({
 ## content.title.button
 
 ### Values
-jQuery([ ]), "String", true *(Default: false)*
+jQuery([ ]), "String", true, false *(Default: false)*
 
 ### Overview
 Text/HTML which will appear inside the title's button element (e.g. close link) located to the right of the title content. The button will close the tooltip when clicked.
 
+If it is set to *true* the default styled icon will be used. If a jQuery element is provided it will be used as the button and appended to the titlebar element. Finally, if a
+string is provided it will be used as the buttons innerText and title/aria-title attributes.
+
 ### Examples
 Create another "About me" tooltip which opens on click and only hides when the title button is clicked
 

diff --git a/docs/core.md b/docs/core.md
@@ -31,6 +31,7 @@ $('#ui-tooltip-myTooltip');
 ### Notes
 * By default, this is a unique positive integer.
 * Value must be unique and contain no special characters.
+* If a qTip is already present with this ID, the ID will be discarded and a numeric ID used instead.
 
 
 
@@ -40,7 +41,8 @@ $('#ui-tooltip-myTooltip');
 true, false *(Default: false)*
 
 ### Overview
-By default, tooltips are rendered on thier first show event, rather than on page load. Setting this to true will cause tooltips to be created on page load.
+By default, tooltips are rendered when they are first triggered, rather than on page load. Setting this to true will cause tooltips to be created on page load, which can have
+significant page load increases if a large set of elements are being targeted.
 
 ### Examples
 Create a simple tooltip and create it on page load
@@ -68,7 +70,8 @@ $('.selector').qtip({
 true, false *(Default: false)*
 
 ### Overview
-Determines if, then the .qtip() method is called on an element with a qTip already present, the new one overrides (i.e. destroys) the old one. By default this is true.
+Determines if, when the .qtip() method is called on an element with a qTip already present, the new one overrides (i.e. destroys) the old one. By default this is true i.e.
+calling .qtip() on an element will always destory any previous bound qTips by default.
 
 ### Examples
 Create a tooltip that will not overridde (destroy) the previous qTip, but fail silently:

diff --git a/docs/global.md b/docs/global.md
@@ -4,11 +4,11 @@ This section covers qTips **global options**, which effect every qTip created on
 
 <a name="version"></a>
 ## $.fn.qtip.version
-Stores the version of qTip2 library included on the page in the format "2.x.x".
+Stores the version of qTip<sup>2</sup> library included on the page in the format "2.x.x".
 
 <a name="defaults"></a>
 ## $.fn.qtip.defaults
-Holds all the default qTip values inherited by your .qtip() calls.
+Holds all the default qTip<sup>2</sup> values inherited by your .qtip() calls.
 
 ```js
 $.fn.qtip.defaults = {
@@ -95,7 +95,7 @@ $.fn.qtip.defaults = {
 ```
 
 ### Notes
-* Take a look at the [Override defaults](./tutorials/advanced#override) tutorial for details on how to edit this object properly.
+* Take a look at the [Override defaults](http://craigsworks.com/projects/qtip2/tutorials/advanced#override) tutorial for details on how to edit this object properly.
 
 
 <a name="nextid"></a>
@@ -123,7 +123,7 @@ $('.selector').qtip({
 ```
 
 ### See also
-* [id option](./docs/core/#id)
+* [id option](./core.md#id)
 
 ### Notes
 * This **MUST** be an *integer only!* If you want to assign a string as an identifier, check-out the individual [id option](./core.md#id).
@@ -159,7 +159,7 @@ $('.selector').qtip({
 ```
 
 ### See also
-* [hide.inactive](./docs/hide/#inactive)
+* [hide.inactive](./hide.md#inactive)
 
 ### Notes
 * This effects all qTips on the page, included those already created (but only if you happen to update a setting which cause the event handlers to be rebound).

diff --git a/docs/hide.md b/docs/hide.md
@@ -28,7 +28,7 @@ $('.selector').qtip({
 jQuery([]), false *(Default: false)*
 
 ### Overview
-Defines the HTML element(s) which will trigger your specified [hide.event](#hideevent). When set to false, the element the .qtip() method was called upon is used.
+Defines the HTML element(s) which will trigger your specified [hide.event](#event). When set to false, the element the .qtip() method was called upon is used.
 
 ### Examples
 This example will cause the first H1 element to hide the tooltip when the [hide.event](#event) is triggered (in this case mouseleave):
@@ -61,7 +61,7 @@ $('.selector').qtip({
 ```
 
 ### See also
-* [hide.event](#hideevent)
+* [hide.event](#event)
 
 ### Notes
 * Setting a different hide target **does not** effect the positioning, which is controlled via the [position.target](./position.md/#target) option.
@@ -91,7 +91,7 @@ $('.selector').qtip({
 });
 ```
 
-You can also specify multiple events using a space separated string. This example will make your tooltips appear when the [hide.target](#hidetarget) is clicked or a mouseout occurs:
+You can also specify multiple events using a space separated string. This example will make your tooltips appear when the [hide.target](#target) is clicked or a mouseout occurs:
 
 ```js
 $('.selector').qtip({
@@ -118,10 +118,10 @@ $('.selector').qtip({
 Integer *(Default: 0)*
 
 ### Overview
-Time in milliseconds by which to delay hiding of the tooltip when the [hide.event](#hideevent) is triggered on the [hide.target](#hidetarget)
+Time in milliseconds by which to delay hiding of the tooltip when the [hide.event](#event) is triggered on the [hide.target](#target)
 
 ### Examples
-This tooltip will only hide after hovering the [hide.target](#hidetarget) for 1000ms (1 second):
+This tooltip will only hide after hovering the [hide.target](#target) for 1000ms (1 second):
 
 ```js
 $('.selector').qtip({
@@ -161,10 +161,10 @@ $('.selector').qtip({
 ```
 
 ### See also
-* [hide.event](#hideevent)
+* [hide.event](#event)
 
 ### Notes
-* In 1.0 the inactive event was applied via the [hide.event](#hideevent) option and used the [hide.delay](#hidedelay) to define the duration of inactivity needed.
+* In 1.0 the inactive event was applied via the [hide.event](#event) option and used the [hide.delay](#delay) to define the duration of inactivity needed.
 
 
 <a name="fixed"></a>
@@ -191,7 +191,7 @@ $('.selector').qtip({
 ```
 
 ### See also
-* [hide.event](#hideevent)
+* [hide.event](#event)
 
 ### Notes
 * Adding a [hide delay](#delay) is generally done when this is enabled to give the user time to mouseover the tooltip before hiding
@@ -223,7 +223,7 @@ $('.selector').qtip({
 ```
 
 ### See also
-* [hide.event](#hideevent)
+* [hide.event](#event)
 
 ### Notes
 * **This only applies when using mouseout or mouseleave as (one of) your hide event(s)**