<title>

The label you specify here is displayed in the Klip's title bar. For example, add My First Klip and reload the Klip.

<title>
  My First Klip
</title>

<version>

You can use this parameter to keep track of the Klip's version. If you ever need to ask the users to provide you with the Klip's version number, they will find it displayed under the About tab of the Customize Klip window.

For example, specifying 1.0 for this parameter will result in the following:

The value set here is also used when the application checks for the availability of a newer version of the Klip. This is discussed in more detail in the <kliplocation> section below.

<description>

You can include a short description of the Klip that the users can refer to under the About tab of the Klip's Customize Klip window.

For example, try updating your Klip so that its description is displayed as follows:

<defaultlink>

This parameter adds a new Klip menu option that is linked to the URL you specify.

For example, update your Klip as follows:

<defaultlink>
  http://www.klipfolio.com
</defaultlink>

When you reload the Klip, you should see an additional Klip menu option, and selecting it should open your default web browser and load http://www.klipfolio.com:

The location of the Open link menu option is set by the application and cannot be changed.

<contentsource>

Your Klip should already be pointing to http://support.klipfolio.com/files/demo/demo.xml.

<icon>

Currently, your Klip is displaying the default icon provided by the application. To change it, specify the URL of the image using this parameter.

Klipfolio Dashboard supports GIF, JPG, 8-bit and 24-bit PNG, as well as ICO images. For the icon, the default size is 19x19 pixels.

	Note
	Klipfolio Dashboard lets the user scale the interface by changing the font size. In order to ensure that the icon image scales well even when the user increases the font size, you should provide an image that is 38x38 pixels or larger.

There are many sample icons available for free under the Klip Assets section of the Klipfolio Dashboard Developer website. For example, try updating your Klip with the following URL:

<icon>
  http://static.klipfolio.com/images/klip-assets/assorted/app.png
</icon>

After saving and reloading the Klip, it should look like this:

<banner>

The Klip banner is a 234x60 pixel image that is displayed in the Customize window of the Klip. For example, try the following:

<banner>
  http://static.klipfolio.com/static/klips/klipfolio/sample_banner.png
</banner>

The banner should be updated to look like this when the Klip is reloaded:

<kliplocation>

Unless you are absolutely certain that the first version of the Klip you provide to your users will never need to be updated, you should provide the Klip location for it.

Klipfolio Dashboard has a built-in mechanism that periodically checks for Klip upgrades at <kliplocation> as long as the automatic Klip Upgrades are turned on under Options. When this occurs, the application compares the <version> set in the Klip at the <kliplocation> against that of the Klip in the local myklips folder. If the value of the local Klip's <version> is different from that of the Klip at the <kliplocation>, the user will be prompted to "upgrade" it. Therefore, it is important to always keep the latest copy of your Klip at kliplocation or none at all to ensure that the users only get notified for the upgrades you intend for them to get.

If you don't set the <kliplocation> for your Klip, you will need to let your users know about the availability of a new version some other way. Be sure to set it to the URL at which you plan to place your Klip(s) including its name. For example:

<kliplocation>
  http://www.klipfolio.com/basic.klip
</kliplocation>
                                

Refer to Chapter 4, Upgrading and Publishing Your Klips for more information on how to make your Klips available to your users.

<refresh>

Every time a Klip refreshes, it checks the content source for any updates in its data. By default, the refresh rate is 120 minutes. This means that, without the <refresh> parameter defined, the Klip will automatically refresh every 2 hours from the time it was last refreshed.

To set your own refresh rate, specify a value measured in minutes. For example, to have the Klip automatically refresh every 2 minutes:

<refresh>
  2
</refresh> 

Or, to have it refresh every 3 hours:

<refresh>
  180
</refresh> 

You should set the refresh rate to a value that is most appropriate for the type of information you are presenting, while also taking into consideration the number of users and amount of traffic your server can handle.

<autoremove>

By default, every item in the Klip is kept based on the length of time specified in the "Automatically remove old items" drop-down list located on the Items tab in the Options window. For example, if "More than one day old" is selected, each item will be kept until it is one day old, and then it is automatically removed. This process is applied to each item regardless of whether it is still available in or has been removed from the source.

However, if you want to disable the automatic removal of the items regardless of each user's Item Management setting, you can have the Klip ignore it by setting this parameter to false:

<autoremove>
  false
</autoremove> 

Note that the item management setting applies to how long it takes for the items already in the Klip to be removed automatically, regardless of whether they still exist in the data source. This means that all items that ever came into the Klip are kept when it has <autoremove>false</autoremove> set. If you want to have items that no longer exist in the data source automatically removed, use the <purge> parameter.

<purge>

By default, items in the Klip are not removed based on their availability in the data source.

If you want the items to be automatically removed from the Klip when they are no longer in the data source, use the <purge> parameter. There are three options available:

<columns>

To display column headers in the Klip, your users can select Display settings > Show column headers from the Klip's menu. However, you can have them displayed by default by setting the <columns> parameter to true.

In addition, if you want to prevent the column headers from truncating, you can add truncate="false":

<columns truncate="false">
  false
</columns> 

The labels in the column header can be specified by using the CSS property, collabel, label or name, discussed in the following section.