Changeset 201101

Timestamp:

02/02/2010 03:46:56 PM (15 years ago)

Author:

ShaneF

Message:

updated documentation

File:

• woopra/trunk/js/jquery.tracking.js (modified) (10 diffs)

woopra/trunk/js/jquery.tracking.js

@@ -12 +12 @@
 *
 * Copyright (c) 2009 Pranshu Arya
-* Modifed by Shane <shane@bugssite.org> to work for the WordPress Woopra Plugin
+* Modifed by Shane <shane@bugssite.org> to work for the WordPress Woopra Plugin
 * 
-* Version 1.1
+* Version 1.
 **
 * Licensed under the MIT license:
@@ -70 +70 @@
          _load_woopra();
     }
-
-  /**
-   * Tracks an event using the given parameters. 
-   *
-   * The woopraEvent method takes as few or as many property pairs as you provide:
-   * http://www.woopra.com/forums/topic/how-do-i-title-a-custom-event)
-   *
-   * Defaults for title, event_name, and skip_internal are specified at the bottom
-   *
-   *  title - name of custom event
-   *  var1, var2, var3, ...
-   *  event_name - name of the event you want to track
-   *  skip_internal - optional boolean value. If true then internal links are not tracked.
-   *
-   */
-  $.woopraEvent = function(title, woopra_options) {
+    
+    /**
+     * Process a Woopra Event Manually
+     */
+    $.woopraEvent = function(title, woopra_options) {
         if ( woopraTracker == 'undefined' ) {
             debug('FATAL: woopraTracker is not defined'); // blocked by whatever
@@ -91 +80 @@
             var w_event = new WoopraEvent(title);
             // For each property pair passed to woopraEvent, add it to w_event
-            $.each(woopra_options, function(i,val){
-                w_event.addProperty(i,val);
+            $.each(woopra_options, function(i,val){
+                w_event.addProperty(i,val);
             });
             w_event.fire();
@@ -98 +87 @@
     };
     
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     $.fn.trackEvent = function(woopra_options) {
         
-        // Add event handler to all matching elements
-        return this.each(function() {
+        /**
+         * 
+         */
+        return this.each( function() {
             var element = $(this);
             var parent = $(element).parent();
@@ -122 +130 @@
                 // text, evaluate them if they are functions.
                 var options = {};
-                $.each(woopra_options, function(i,val){
-                    options[i] = evaluate(element,val);
+                $.each(woopra_options, function(i,val){
+                    options[i] = evaluate(element,val);
                 });  
             }
@@ -147 +155 @@
                     var title = evaluate($(parent).children().eq(index), woopra_settings.title);
                     options = {}
-                    $.each(woopra_options, function(i,val){
+                    $.each(woopra_options, function(i,val){
                         options[i] = evaluate($(parent).children().eq(index), val);
                     });
@@ -159 +167 @@
         });
         
-        
         /**
-         * Checks whether a setting value is a string or a function.
          * 
-         * If second parameter is a string: returns the value of the second parameter.
-         * If the second parameter is a function: passes the element to the function and returns function's return value.
          */
         function evaluate(element, text_or_function) {
@@ -173 +177 @@
         };
     };
-
+    
     /**
-    * Prints to Firebug console, if available. To enable:
-    *   $.fn.track.trackEvent.debug = true;
-    */
+     * Debug Information
+     */
     function debug(message) {
         if (typeof console != 'undefined' && typeof console.debug != 'undefined' && $.fn.trackEvent.defaults.debug) {
@@ -183 +186 @@
         }
     };
-
+    
     /**
-    * Default (overridable) settings.
-    */
+    
+    */
     $.fn.trackEvent.defaults = {
         title           : function(element) { return (element[0].hostname == location.hostname) ? 'internal' : 'external'; },
@@ -193 +196 @@
         debug           : true
     };
+
 })(jQuery);