Getting Started

Integrating the UserVoice Widgets Module into your site, requires three steps.
  1. Create an account and API channel at UserVoice
  2. Install and configure the UserVoice Widgets Module in Orchard
  3. Add the widgets to the your site

Create an account and API channel at UserVoice

The first step is to get setup at UserVoice. You'll want to read through the UserVoice offerings and terms of service on the UserVoice.com website. We won't address those here. Once you've created your account there are a few things to gather.
  • Account name - this is subdomain you configured when registering with UserVoice.
  • Host - this is the host name that UserVoice created for you based on your Account name.
  • API Key - This is acquired by Adding an API channel in the Settings section of the Admin panel. Once you create it, you'll be assigned a "Key".

Install and configure the UserVoice Widgets Module in Orchard

There are two ways to install the UserVoice Widgets module.
  1. Download the package from this site and manually upload it in the Orchard admin section.
  2. Use the Ochard Modules page in the admin section to search the gallery and download it directly into Orchard.

Once you have the UserVoice Widgets module installed and enabled, locate the UserVoice option under Settings in the Admin section of your Orchard site. On this page, provide the three pieces of data you collected when setting up your UserVoice account.

Add the widgets to your site

First, let's add the Feedback widget to your site.
  1. Click the Widgets tab in the admin section of your site.
  2. Choose a Zone (for the Feedback widget, the Zone does not matter, though the Header or Footer is probably appropriate) and click Add.
  3. Choose the Feedback Widget.
  4. Now, you can configure the settings for your widget. These settings are optional. If you don't provide a setting, UserVoice provides a default in the widget definition on their site.
  5. Click Save and check that the Feedback tab shows up on your site.

Now, we'll configure the Suggestions widget.
  1. Click the Widgets tab in the admin section of your site.
  2. Choose a Zone and click Add.
  3. Choose the Suggestions Widget.
  4. In the settings, choose a Forum that you want to display suggestions for.
  5. Click Save and check that the Suggestions Widget shows up on your site.

Last edited Apr 15, 2011 at 11:15 PM by drewby, version 2

Comments

No comments yet.