Metrixstream - New pages [en]

Site:API:UserCookieData

2012-08-30T04:31:08Z

MetrixAdmin: Created page with "= User Cookie Data = User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the..."

= User Cookie Data =

User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the ability to have them persist across different computers. This means when a user logs in from home and work, the experience will be the same.

The big difference between a user cookie and a browser cookie, is that a user cookie requires an authenticated session.... meaning no anonymous preferences are supported. Note: you are not forced to choose one or the other, so you can mix and match each solution to fit your requirements.

== Set User Cookie ==

This API call is responsible for setting a user cookie.

=== Authentication Restrictions ===

An authenticated user.

=== Required Parameters ===

* <code>action=usercookie</code>
* <code>verb=set</code>
* <code>name</code>: the name of the user cookie.
:: this has a maximum of 48 characters.
* <code>value</code>: the value of the user cookie.
:: this has a maximum of 1000 characters.

=== Successful Response ===

* <code>status=ok</code>

== Delete User Cookie ==

This API call is responsible for deleting a user cookie. The response will still succeed, if the cookie doesn't exist.

=== Authentication Restrictions ===

This API call is responsible for setting a user cookie.

=== Required Parameters ===

* <code>action=usercookie</code>
* <code>verb=del</code>
* <code>name</code>: the name of the user cookie.

=== Successful Response ===

* <code>status=ok</code>

Site:API:Users

2012-08-21T04:57:19Z

MetrixAdmin: /* Optional Parameters */

= Users =

== Add User ==

This API call is responsible for creating a user.

=== Authentication Restrictions ===

Administrator only.

=== Required Parameters ===

* <code>action=user</code>
* <code>verb=adduser</code>
* <code>username</code>: the username of the user

=== Optional Parameters ===

* <code>email</code>
* <code>commission_pto_percentage</code>
* <code>commission_ppm_percentage</code>
* <code>commission_gift_percentage</code>
* <code>commission_bandwidth_percentage</code>
* <code>activity_summary_duration_secs</code>

=== Successful Response ===

* <code>status=ok</code>
* <code>item</code>
** <code>user</code>
*** <code>id</code>: the id of the user

== Edit User ==

This API call is responsible for editing a user object.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

* <code>action=user</code>
* <code>verb=edituser</code>

=== Optional Parameters ===

* <code>user</code>: the username of the user being updated.
:: this parameter is only available if the authenticated user is an Administrator.
* <code>username</code>
* <code>password</code>
* <code>email</code>
* <code>newsletter</code>
* <code>external_id</code>
* <code>phone</code>
* <code>fax</code>
* <code>dob</code>
* <code>dob_day</code>
* <code>dob_month</code>
* <code>dob_year</code>
* <code>description</code>
* <code>display_name</code>
* <code>display_status</code>
* <code>lang</code>
* <code>sex</code>
* <code>relationship</code>
* <code>interests</code>
* <code>activities</code>
* <code>music</code>
* <code>tv</code>
* <code>books</code>
* <code>location</code>
* <code>hometown</code>
* <code>change_username</code>
* <code>allow_login</code>
* <code>price_level</code>
* <code>billing_fname</code>
* <code>billing_lname</code>
* <code>billing_company</code>
* <code>billing_address</code>
* <code>billing_address2</code>
* <code>billing_city</code>
* <code>billing_state</code>
* <code>billing_zip</code>
* <code>billing_country</code>
* <code>billing_email</code>
* <code>billing_phone</code>
* <code>billing_fax</code>
* <code>shipping_fname</code>
* <code>shipping_lname</code>
* <code>shipping_company</code>
* <code>shipping_address</code>
* <code>shipping_address2</code>
* <code>shipping_city</code>
* <code>shipping_state</code>
* <code>shipping_zip</code>
* <code>shipping_country</code>
* <code>shipping_email</code>
* <code>shipping_phone</code>
* <code>shipping_fax</code>
* <code>bank_name</code>
* <code>bank_address</code>
* <code>bank_address2</code>
* <code>bank_city</code>
* <code>bank_state</code>
* <code>bank_zip</code>
* <code>bank_country</code>
* <code>bank_account</code>
* <code>bank_routing</code>
* <code>bank_swift</code>
* <code>bank_phone</code>
* <code>bank_iban</code>
* <code>review</code>
* <code>status</code>
* <code>commission_ppm_percentage</code>
* <code>commission_pto_percentage</code>
* <code>commission_gift_percentage</code>
* <code>commission_bandwidth_percentage</code>
* <code>activity_summary_duration_secs</code>
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code>
* <code>cst_*</code>: custom fields related to this user
:: replace the * with the appropriate custom field name

=== Successful Response ===

* <code>status=ok</code>
* <code>properties</code>
** <code>pending</code>
** <code>approved</code>

Site:API:Content

2012-08-21T03:45:15Z

MetrixAdmin: /* Required Parameters */

= Content =

== Add Content ==

This API call is responsible for creating a content item.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

* <code>action=addcontent</code>
* <code>type</code>: blog,news,album,inventory,object,product,photoset,project,pledge,playlist,event
* <code>title</code>: the content item title; no more than 1000 characters

=== Optional Parameters ===

* <code>description</code>: the content item description; no more than 65k characters
* <code>release_date</code>: the release date of this content item
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.
* <code>credits_to_own</code>: the current amount of credits to purchase this item.
* <code>price</code>: the cash value of this item.
:: only available for types that are not a product or project.
* <code>inventory</code>: only available for types that are event.
* <code>label</code>: will be prefixed by the site's user prefix label.
* <code>addcategory</code>: an array of category ids
* <code>addtag</code>: an array of tags
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.
* <code>cst_*</code>: custom fields related to content
:: replace the * with the appropriate custom field name

=== Successful Response ===

* <code>status=ok</code>
* <code>item</code>
** <code>contentId</code>: the id of the newly created content item
** <code>canonicalId</code>: the canonical id of the newly created content item.

== Edit Content ==

This API call is responsible for editing a content item.

=== Authentication Restrictions ===

Moderators and Comment authors.

=== Required Parameters ===

* <code>action=editcontent</code>
* <code>contentId</code>: the id of the content item

=== Optional Parameters ===

* <code>title</code>
* <code>description</code>
* <code>access</code>
* <code>release_date</code>
* <code>event_date</code>
* <code>live_host</code>
* <code>live_mode</code>
* <code>preview_offset</code>
* <code>preview_duration</code>
* <code>external_id</code>
* <code>allow_oversell</code>
* <code>price</code>
* <code>price1</code>
* <code>price2</code>
* <code>price3</code>
* <code>price4</code>
* <code>price_formula</code>
* <code>credits_to_own</code>
* <code>credits_per_minute</code>
* <code>commission_ppm_percentage</code>
* <code>commission_pto_percentage</code>
* <code>commission_gift_percentage</code>
* <code>commission_bandwidth_percentage</code>
* <code>review</code>
* <code>gift_credits</code>
* <code>user</code>
* <code>chat_muted</code>
* <code>img:selected</code>
* <code>img:title</code>
* <code>img:position</code>
* <code>photo_hint</code>
* <code>add:relationship</code>
* <code>del:relationship</code>
* <code>playlist:media_id</code>
* <code>image (multipart)</code>
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code>
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10</code>
* <code>banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo</code>
* <code>banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot</code>
* <code>inventory</code>
* <code>inventory:stock:quantity</code>
* <code>featured_on_content_id</code>
* <code>tags</code>
* <code>addtag</code>
* <code>deletetag</code>
* <code>categories</code>
* <code>addcategory</code>
* <code>deletecategory</code>
* <code>label</code>
* <code>label_hint</code>
* <code>cst_*</code>: custom fields related to content
:: replace the * with the appropriate custom field name.

=== Successful Response ===

* <code>status=ok</code>
* <code>properties</code>
** <code>pending</code>
** <code>approved</code>

Site:API:Authentication

2012-07-03T00:42:43Z

MetrixAdmin: /* Required Parameters */

= Authentication =

== Login ==

This API call is responsible for logging in a user.

=== Authentication Restrictions ===

None.

=== Required Parameters ===

* <code>action=login</code>
* <code>username</code>: the username of the user
* <code>password</code>: the password of the user

=== Successful Response ===

* <code>status=ok</code>

== Signup ==

This API call is responsible for signing up a user.

=== Authentication Restrictions ===

None.

=== Required Parameters ===

* <code>action=signup</code>
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user

=== Optional Parameters ===

* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice
* <code>phone</code>: the primary phone number for this user
* <code>fax</code>: the primary fax number for this user
* <code>dob</code>: the user's date of birth; this is
* <code>sex</code>: the sex of the user
* <code>description</code>: the bio of the user
* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only
* <code>display_status</code>: the display status of the user; this is common for social websites
* <code>billing_first_name</code>: the first name of the billing contact
* <code>billing_last_name</code>: the last name of the billing contact
* <code>billing_company</code>: the company name of the billing contact
* <code>billing_address</code>: the address of the billing contact
* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact
* <code>billing_city</code>: the city of the billing contact
* <code>billing_state</code>: the state of the billing contact
* <code>billing_zip</code>: the zip code of the billing contact
* <code>billing_country</code>: the country of the billing contact
* <code>billing_phone</code>: an optional phone number related to the billing contact
* <code>billing_fax</code>: an optional fax number related to the billing contact
* <code>billing_email</code>: an optional email related to the billing contact
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves

=== Successful Response ===

* <code>status=ok</code>

== Logout ==

This API call is responsible for logging out a user.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

* <code>action=logout</code>

=== Successful Response ===

* <code>status=ok</code>

== Forgot Password ==

This API call is responsible for sending a forgot password email to a successful match of a username or email address.

=== Authentication Restrictions ===

None.

=== Required Parameters ===

* <code>action=forgotpassword</code>
* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience

=== Successful Response ===

* <code>status=ok</code>: this response is returned regardless if the param:username field actually matches a user's username or email address; the reason for this is so that someone can't run a brute force attack and discover all the email addresses that belong to your users

Site:Frontend:SEOFriendlyURLS

2012-07-01T23:33:10Z

MetrixAdmin:

== Introduction ==

The format of your URLs actually matter. Depending on how you structure your URLs, your site may or may not be SEO friendly. SEO friendly URLs are important because it allows your website to be properly indexed by various search engines.

A simple way to be in compliance with SEO friendliness is to do your best to never use URL parameters. Search engine spiders are expecting a directory type format for your URL.

=== Not SEO Friendly ===

http://www.example.com/?page=content&contentId=This.is.my.new.bike

=== SEO Friendly ===

http://www.example.com/content/This.is.my.new.bike

== URL Patterns ==

Each site is able to specify various URL patterns to customize how it should handle its URL structure. These patterns can be customized by clicking on the "URL PATTERNS" link under each site.

Each URL Pattern consists of the following:

; name
: this is a simple name to identify the pattern.
; regex pattern
: this is the actual regular expression used to parse the pattern.
; variable matches
: this is a list of variables that should be matched to the corresponding regular expression.
; defaults
: this is a list of variables that should be implied, if this pattern successfully matches the active URL.
; final
: whether or not to continue onto the next pattern of this pattern successfully matches the active URL.
; layout
: this allows the patterns to be organized based on priority. Sometimes it may matter which patterns get matched first.

== Example ==

To match the SEO Friendly URL listed above, you would create the following URL pattern:

; name
: content 1up
; regex pattern
: /([^\/]+)\/([^\/]+)\/?$/
; variable matches
: page, contentId

Site:Frontend:Controllers

2012-06-20T17:31:42Z

MetrixAdmin: /* Using registerProfileFunctions */

= Introduction =

A Controller is a javascript class used to organize all javascript functionality within a particular page or module. A controller can hold other controllers, so you can imagine a site controller managing all of the page controllers.

This class is broken down by functionality and should only be instantiated when necessary.

= Basic Site Controller =

<script type="text/javascript">
function siteController(authUser, publicUser, publicContentId) {
this.authUser = authUser;
this.publicUser = publicUser;
this.contentId = publicContentId;
this.urls = [];
}

siteController.prototype.registerUrls = function(urls) {
this.urls = urls;
};

siteController.prototype.registerProfileFunctions = function() {
var myThis = this;

$('#getUserState').click(function(e) {
e.preventDefault();
$.ajax({
type: 'get',
url: myThis.urls['userStateUrl'],
data: {
'user': myThis.publicUser
},
success: function(data) {
alert('This user is '+ data.state);
}
});
});
};
</script>

== Instantiating ==

In the example controller, siteController is instantiated with the authenticated username, the public username, and the public contentId which are stored so they can be accessed throughout the class.

<script type="text/javascript">
var site = new siteController('Justin', 'Roy', <nowiki>''</nowiki>);
$(document).ready(function() {
site.registerUrls({
'userStateUrl' : 'http://example.com/userstate'
});
});
</script>

== Using registerProfileFunctions ==

In the example above, we never called the registerProfileFunctions function, meaning the getUserState listener is never active.

Example
site.registerProfileFunctions();

Once its active and getUserState is clicked, the script references myThis.urls['userStateUrl'] which was set earlier in the registerUrls function.

Site:Frontend:BestPractices

2012-06-18T17:29:00Z

MetrixJustin: Created page with "= Readability and Whitespace = Keeping one line of clearsilver per line ends up being hard to read, as well as added markup since each line of clearsilver turns into a blank lin..."

= Readability and Whitespace =

Keeping one line of clearsilver per line ends up being hard to read, as well as added markup since each line of clearsilver turns into a blank line in the finalized document. To keep things neat we wrap the beginning clearsilver line with the line above it.

This
<nowiki><h1>News</h1></nowiki>
<?cs if:News ?>
<?cs call:showNews() ?>
<?cs /if ?>

Would turn into
<nowiki><h1>News</h1></nowiki><?cs
if:News ?><?cs
call:showNews() ?><?cs
/if ?>

This keeps the white space away and you can easily scan the beginning of each line to clearly see what is happening in the code.

= Site and Module Controllers =

Each site should have a siteController.js file containing all the javascript required to run the site. Each stand-alone module will also have its own controller managing functions specific to that module.

The controller is made up of classes that control different parts of the site/module. This allows us to only enable functions and listeners that are required on the page, instead of having them always active. This also ensures that when concatenating the javascript file that function and listeners wont overlap.

Site:Frontend:BestPrices

2012-06-18T17:27:06Z

MetrixJustin: /* Readability and Whitespace */

Site:Frontend:Forms

2012-06-15T19:38:48Z

66.214.240.97: /* Retry */

= Introduction =

= Parameters =

== Mode ==

This optional parameter sets the response type.

Avaliable modes: xml, json

<input type="hidden" name="mode" value="xml" />

== Continue ==

This optional parameter is the page you will be redirected to after a successful form submit.

<input type="hidden" name="continue" value="http://example.com/?page=some-successful-page" />

== Retry ==

This optional parameter is the page you will be redirected to after a unsuccessful form submit. This page will also contain the MS.error HDF value with the error/reason why the form wasn't successful.

<input type="hidden" name="retry" value="http://example.com/?page=some-failed-page" />

= Ajax Forms =

The jQuery javascript library offers a simple function to handle your forms using Ajax. This allows you to send form data and get the response from the server without having to reload the page.

== Basic Script ==

The following snippet will listen for a form with the ID of "someFormId" to be submitted.

$('#someFormId').submit(function(e) {
e.preventDefault();
var form = $(this):

if(form.data('disabled') == 'true') return;
form.data('disabled', 'true');

$.ajax({
type: form.attr('method'),
url: form.attr('action'),
data: form.serialize(),
success: function(data) {
if('ok' == $('status', data).text()) {
// Form has returned successfully
} else {
// Form has returned with an error
}
form.removeData('disabled');
},
error: function() {
// Could not get data back from the post
}
});
});

This script should be placed in the appropriate controller and instantiated only when necessary.

= Custom Fields =

Custom fields can be updated just like other form fields but require different naming. The custom field is prefixed with cst_ followed by the custom field name.

Ex. If a custom field on a user object is "specialNote", the input name would be "cst_specialNote".

<input type="text" name="cst_specialNote" value="<?cs var:MS.site.user.custom.specialNote.value ?>" />

Site:Frontend:Modules

2012-06-15T18:53:34Z

MetrixJustin: /* Listing Content */

= Introduction =

Modules contain stand-alone code, files, pages, and page includes required to perform the tasks of the module.

= Module Integration =

== Adding a Module to a Page ==
After a module is created or imported, it will be listed under Module Integration while editing a site page.

Selecting the module will populate MS.module.data with the contents of the module. Calling MS.module.data on the page will inject the contents onto the page.

<html>
<head>
<title>Module Test</title>
</head>
<body>
<?cs var:MS.module.data ?>
</body>
</html>

== Accessing Module Pages ==

Since modules are injected into a parent page, pages within a module need to be called with the '''mpage''' URL parameter.

For example, if your parent page is "auth" and your module page is "login":

http://example.com/?page=auth&mpage=login

== Module Only ==

Some modules contain pages that serve up JSON or XML content and should ignore the included header and footer. This can be done by adding the URL parameter "output=moduleonly"

Example:
http://example.com/?page=auth&mpage=users.json&output=moduleonly

= Creating a Module =

== Common ==

=== Default Page ===

This is the default page that loads when no mpage is set.

=== Autoload ===

Autoloaded modules will be included on every page of the site. This is helpful for caching and including JS and CSS files throughout the site.

=== Key / Value Pairs ===

Key / Value pairs are module-wide variables that can easily be changed. These are often used as settings for the module.

For example, if we have a setting called "show_stats" and want to see if its set to "yes"

<?cs if:'<!show_stats!>' == 'yes' ?>
Showing Stats
<?cs /if ?>

=== Initialization ===

Initialization is the first part of the module that is loaded. If there are any required modules to be loaded before this module you will need to include them here.

If you're using the stack module, all CSS/JS stack includes would be called here

== Javascript Controller ==

Each module that requires javascript should have its own controller. The controller is made up of classes that control different parts of the module. This allows us to only enable functions and listeners that are required on the page, instead of having them always active. This also ensures that when concatenating the javascript file that function and listeners wont overlap.

== Listing Content ==

Listing content relies on the context of module page, not the parent page. For example if the parent page has a context of "My Videos" but the module page doesn't have a context nothing will be listed on the page.

The HDF keys/values will still remain the same, so they can be accessed the same way as a regular page.

Example: Listing the titles of the context Content: All

<?cs each:item = MS.content.items ?>
<?cs var:item.title ?><nowiki><br /></nowiki>
<?cs /each ?>

Site:Frontend:Macros

2012-06-15T18:27:37Z

MetrixAdmin: /* Introduction */

=== Introduction ===

Macros are the Clearsilver equivalent to functions.... almost. They only produce output to the browser rather than supplying a return value. Because of this the term macro is a more suitable name.
Macros let you define a block of code that can be re-used throughout the site.

=== Creating a Macro ===

Macros are made by starting and ending a new clearsilver block with def.

<?cs def:getUsername() ?>
<?cs var:MS.site.auth.username ?>
<?cs /def ?>

With macros there is no returning specific data, anything in the macro will be placed where its called.

=== Macro Parameters ===

You can pass parameters into the macro by setting them after the macro name

<?cs def:getUsername(user) ?>
<?cs var:user.username ?>
<?cs /def ?>

This macro requires the user parameter to generate the username.

Site:Frontend

2012-06-15T17:44:30Z

MetrixJustin:

== Introduction ==

Below you will find links to each particular component of the Frontend Site API. Detailed API information is available by clicking on each link.

=== Main Sections ===

; [[Site:Frontend:BestPractices|Best Practices]]
; [[Site:Frontend:Controllers|Controllers]]
; [[Site:Frontend:Forms|Forms]]
; [[Site:Frontend:Macros|Macros]]
; [[Site:Frontend:Modules|Modules]]

Tutorial:JavaScript

2012-06-06T20:29:07Z

66.214.240.97: /* jQuery */

= Logging =

Logging is your friend. It isn't always supported, so you need to write your own wrapper around it. All logging will go to the console window which is located in the developer tools for most popular web browsers.

<script>

function log(str) {
if (window["console"] && window["console"]["log"]) window["console"]["log"](str);
}

</script>

= Scope =

Scope is important because variables go in and out of existence depending on where they are referenced from. This gets extremely important to understand when using variables of the same name.

== Example ==

=== Code ===

<script>

var value = 10;

log("A: " + value);

if (true) {
var value = 11;

log("B: " + value);
}

log("C: " + value);

</script>

=== Output ===

A: 10
B: 11
C: 11

== Example ==

=== Code ===

<script>

var value = 10;

function test() {
value = 11;

log("test: " + value);
}

log("A: " + value);

test();

log("B: " + value);

</script>

=== Output ===

A: 10
test: 11
B: 11

== Example ==

=== Code ===

<script>

var value = 10;

function test() {
var value = 11;

log("test: " + value);
}

log("A: " + value);

test();

log("B: " + value);

</script>

=== Output ===

A: 10
test: 11
B: 10

= Anonymous Functions =

Anonymous functions are useful because you can limit their execution to a variable... which means you can hide their execution due to scope! A good example of this is the Google Analytics javascript code. Google just wants their code to execute. They don't want anything changed.

== Example: Static Function ==

Notice how once test() is declared, it can always be called.

=== Code ===

<script>

function test() {
log("test");
}

test();

if (true) {
test();
}

function anotherTest() {
test();
}

anotherTest();

</script>

=== Output ===

test
test
test

== Example: Anonymous Function ==

In this example the function only exists within the actual execution of placeholder().

=== Code ===

<script>

function placeholder() {
var testFunc = function() {
log("test");
};

testFunc();
}

placeholder();
testFunc();

</script>

=== Output ===

test
- Uncaught ReferenceError: testFunc is not defined

== Example: Anonymous Function within Anonymous Function ==

The above example was interesting, but seemed a little heavy because we still had to create an actual static function first. This example shows how to create an anonymous function which declares even more stuff inside it and immediately executes so nothing can get intercepted.

=== Code ===

<script>

(function() {
var testFunc = function() {
log("test");
};
testFunc();
})();

testFunc();

</script>

=== Output ===

test
- Uncaught ReferenceError: testFunc is not defined

= jQuery =

jQuery is a library that makes working with javascript much easier.

== Less Error-prone ==

=== Javascript Code ===

Here is an example of hiding an element using JavaScript.

<script>

var obj = document.getElementById("testId");
obj.display.style = "none";

</script>

Notice any problem with that? What happens if the element testId doesn't exist? The code fails, which means the entire webpage stops functioning. jQuery is much more robust where you don't have to check if something exists... meaning simple problems like this don't sneak up when you least expect it (like friday night at midnight when your client is checking their website and no one is around to fix an easy error).

=== jQuery Code ===

<script>

$("#testId").hide();

</script>

== document.ready ==

jQuery provides a great function document.ready which lets you execute code when the page is ready to be accessed by JavaScript. document.ready is different than onload because onload gets triggered after all static resources get loaded. In the example below, document.ready will not be used just to keep the examples shorter. It is a good rule of thumb, to always wrap any immediately executing code in a document.ready block.

=== Code ===

<script>

$(document).ready(function() {
// add your code here
});
</script>
== Selectors ==

jQuery is awesome at selecting HTML elements. The equivalent is very complex and error-prone to do in raw JavaScript. After selection, an action is normally performed, such as: hide(), show(), fadeIn(), fadeOut(), css(), addClass(), removeClass(), etc.

=== Hide all Divs on the webpage ===

<script>

$("div").hide();

</script>

=== Hide all elements of the class "test" on the webpage ===

<script>

$(".test").hide();

</script>

=== Hide all elements of the class "test" on the webpage ===

<script>

$(".test").hide();

</script>

=== Hide all DIV elements of the class "test" on the webpage ===

<script>

$("div.test").hide();

</script>

=== Hide an element of ID test on the webpage ===

<script>

$("#id").hide();

</script>

=== Hide an DIV element of ID test on the webpage ===

<script>

$("div#id").hide();

</script>

=== Hide all inputs that have a type property ===

<script>

$("input[type]).hide();

</script>

=== Hide all inputs that have a name property that is set to myinputname ===

<script>

$("input[name='myinputname']).hide();

</script>

=== Hide all inputs within a form of id=myform ===

You can refine your selection by referencing a context of another element.

<script>

$("input", "#myform").hide();

</script>

== Function Chaining ==

jQuery allows chaining of functions, so your code size can be extremely small.

This example will unhide an input element, give it a default value, add a class on it, and then focus the input.

$("#myinput").show().val("This is my default value").addClass("myClass").focus();

== Advanced Examples ==

=== Specify Input Text that disappears once clicked ===

==== HTML/CSS ====

<style>
.preSelected {
color: #AAA;
}
</style>

<input type=text name=myname value="Please enter your name" class="preSelected">

==== jQuery ====

<script>

$(document).ready(function() {
$(".preSelected").click(function(evt) {
$(this).unbind("click").removeClass("preSelected").val("").focus();
});
});

</script>

Site:API:PCR

2012-05-23T22:04:03Z

MetrixAdmin:

= Property Change Requests =

Property Change Requests are a mechanism that allows you to approve updates to metadata that your users do on their own profile or their content. PCRs get created as a user updates metadata on their own profile or their content. PCRs can be enabled per property on a per site level.

== Edit Property Change Request ==

This API call is responsible for editing a property change request.

=== Authentication Restrictions ===

Adminstrators only.

=== Required Parameters ===

;action=pcr
;verb=edit
;pcrId
:The id of the pcr.
;state
:pending, approved, rejected, delete

=== Successful Response ===

;status=ok

Site:API:Wysiwyg

2012-05-01T17:48:36Z

MetrixAdmin: /* Successful Response */

= Wysiwyg =

== HTML code to inject a Wysiwyg Editor ==

This API call is responsible for generating the appropriate HTML, CSS, and JS to render a Wysiwyg Editor.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

;action=wysiwyg
;field
:the name of the HTML input field that this editor will receive its value upon a form submit.
;width
:the width of the editor in pixels.
;height
:the height of the editor in pixels.

=== Optional Parameters ===

;data
:the default data to edit in the editor
;default_image_size
:the initial cropping size for any images uploaded through the editor; the default size is 600; cropping is lossless, meaning all recrops are from the original file.
;buttons1
:the list of buttons for the 1st row of the editor
:the default list is: "bold,italic,underline,strikethrough,|,justifyleft,justifycenter,justifyright,justifyfull,fontselect,fontsizeselect,|,forecolor,backcolor,link,unlink,image,emotions,code"
;buttons2
:the list of buttons for the 2nd row of the editor
;buttons3
:the list of buttons for the 3rd row of the editor

=== Successful Response ===

; status=ok
; item
::; html

Site:API:Forums

2012-04-30T23:08:01Z

MetrixAdmin: Created page with "= Forums = == Add Forum == This API call is responsible for adding a forum to a site. === Authentication Restrictions === Administrators only. === Required Parameters === ;..."

= Forums =

== Add Forum ==

This API call is responsible for adding a forum to a site.

=== Authentication Restrictions ===

Administrators only.

=== Required Parameters ===

;action=forum
;verb=addforum
;title
:the forum title; this field is used to calculate the canonical_id, if not provided.

=== Optional Parameters ===

; description
: the forum description.
;layout
: the position of this forum relative to other forums.
;label
: allows grouping of forums based on label.
;canonical_id
: the nice looking identifier for human readable ids; filtering will be performed to ensure proper syntax.

=== Successful Response ===

;status=ok
;item

:;forum

::;id
::: the id of the newly created forum.

::;canonical_id
::: the canonical_id of the newly created forum.

== Edit Forum ==

This API call is responsible for editing a forum.

=== Authentication Restrictions ===

Administrators only.

=== Required Parameters ===

;action=forum
;verb=editforum
;forumId
:the forum id.

=== Optional Parameters ===

;title
:the forum title; this field is used to calculate the canonical_id, if not provided.
; description
: the forum description.
;layout
: the position of this forum relative to other forums.
;label
: allows grouping of forums based on label.
;canonical_id
: the nice looking identifier for human readable ids; filtering will be performed to ensure proper syntax.

=== Successful Response ===

;status=ok

== Delete Forum ==

This API call is responsible for deleting a forum and all of its threads and replies.

=== Authentication Restrictions ===

Administrators only.

=== Required Parameters ===

;action=forum
;verb=delforum
;forumId
:the forum id.

=== Successful Response ===

;status=ok

== Add Thread ==

This API call is responsible for adding a thread to a forum.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

;action=forum
;verb=addthread
;forumId
:the forum id
;title
:the thread title; this field is used to calculate the canonical_id, if no canonical_id is supplied.
; description
: the thread description.

=== Optional Parameters ===

;canonical_id
: the nice looking identifier for human readable ids; filtering will be performed to ensure proper syntax.

=== Successful Response ===

;status=ok
;item

:;thread

::;id
::: the id of the newly created thread.

::;canonical_id
::: the canonical_id of the newly created thread.

== Add Reply ==

This API call is responsible for adding a reply to a forum post.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

;action=forum
;verb=addreply
;postId
:the post id; this can be either a thread id or a reply id.
; description
: the reply description.

=== Optional Parameters ===
;quote
:text that you want to quote in your reply; this only applies if postId is a reply id; this is limited to 255 characters.

=== Successful Response ===

;status=ok
;item

:;reply

::;id
::: the id of the newly created reply.

== Edit Post ==

This API call is responsible for editing a forum post.

=== Authentication Restrictions ===

Superuser or user with moderator or administrator access. Post user is only able to update title and description for threads and description for replies.

=== Required Parameters ===

;action=forum
;verb=editpost
;postId
:the post id; this can be either a thread id or a reply id.

=== Optional Parameters ===
; title
: the post title; only applies if postId is a thread id;
; description
: the post description.
;canonical_id
:the canonical id of the forum post; only applies if postId is a thread id.
;forumId
:the id of the forum that this post belongs to; only applies if postId is a thread id.
;sticky=yes|no
:whether or not this post is sticky; only applies if postId is a thread id.
;quote
:text that you want to quote in your reply; only applies if postId is a reply id; this is limited to 255 characters.

=== Successful Response ===

;status=ok

== Delete Post ==

This API call is responsible for deleting a forum post.

=== Authentication Restrictions ===

Administrators or Moderators; Post user is able to delete as long as post is not a thread with a reply count greater than 0.

=== Required Parameters ===

;action=forum
;verb=delpost
;postId
:the post id; this can be either a thread id or a reply id.

=== Successful Response ===

;status=ok

Site:API:Comments

2012-04-30T23:06:25Z

MetrixAdmin: /* Comments */

= Comments =

== Add Comment ==

This API call is responsible for adding a comment to an object.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

;action=comment
;verb=addcomment
;objtype
:content, owner, user
;objid
;msg
:the comment message; no more than 2048 characters.

=== Successful Response ===

;status=ok
;item

:;comment

::;id
::: the id of the newly created comment.

== Edit Comment ==

This API call is responsible for editing a comment.

=== Authentication Restrictions ===

Moderators and Comment authors.

=== Required Parameters ===

;action=comment
;verb=editcomment
;commentId
:The id of the comment.

=== Optional Parameters ===

;msg
:the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.
;approved=yes|no
:the comment approval state; Only Moderators have access to this field.

=== Successful Response ===

;status=ok

== Delete Comment ==

This API call is responsible for deleting a comment.

=== Authentication Restrictions ===

Moderators; Comment owners;

=== Required Parameters ===

;action=comment
;verb=delcomment
;commentId
:The id of the comment.

=== Successful Response ===

;status=ok

Site:API

2012-04-11T00:21:59Z

MetrixAdmin: /* Main Sections */

== Introduction ==

Below you will find links to each particular component of the Site API. Detailed API information is available by clicking on each link.

=== Main Sections ===

; [[Site:API:Comments|Comments]]
; [[Site:API:Forums|Forums]]
; [[Site:API:PCR|Property Change Requests]]
; [[Site:API:Wysiwyg|Wysiwyg Editor]]