Basic tutorial

0. Install JCollection

Download the zip file jcollection-x.x.x.zip, currently version 0.9.19 is the most recent. (For version prior to 0.9.12, you'd also have to download the plugins plg_jcollection_rating-x.x.x.zip and plg_jcollection_listcat-x.x.x.zip).

Then install the component: in the Joomla backend, browse to "extensions - install/uninstall", then upload com_jcollection-x.x.x.zip. Alternatively, upload the files to an empty folder on your webserver and point the install routine to this folder - this might be neccessary if your server throws a script error. See the Joomla manual for more information on the installation of Joomla extensions.
*Important note*
- during the installation of the component, JCollection checks if it is possible to contact other webservers to download data, i.e. if it is possible to use webservices. A warning is produced if this is not possible.

I. Configuration

There are some configurations that you might want to change now, but you can also change them at any other point.
In the Joomla backend, browse to "components - JCollection - items". In the top toolbar, click on "configuration".
-> if you have an Amazon associates id, you can enter it here!
-> if you want to use Google maps or any of the Yahoo webservices, you can enter your access keys here!

II. Create a new category

In the Joomla backend, browse to "components - JCollection - categories". In the top toolbar, click on "new".
Enter a name and a description for your first category.
Name: Books
Description: My library.
Parent: -root-

If you want to add an image, click on "upload" and upload an image to the folder "images/jcollection". Then click on "apply" to reload the page, otherwise the image will not appear in the image selection list.

III. Create an item

In the Joomla backend, browse to "components - JCollection - items". In th top toolbar, click on "new".
Add a name and description for your new item:
Name: Twilight
Description: The cult novel.

Click on "apply", otherwise it is not possible to add info sets.

Then add one (or more) info set(s). Select a type (there are some predefined types such as book, music or movie, but you can also add your own types) and fill in the information fields:
Info type: Book
Title: Twilight
Description: ...
Image:
URL:
Author: Stephenie Meyer
Publisher:
Pages:

If you want to use a webservice to fetch information about this book, select the webservice on the parameter panel, f.e. Amazon. Click on "select" to search for the book.

Do not forget to click on "save" (next to the name of the info set)!
You can also add another info set of the same or of a different type.

IV. Create the menu entry

In the Joomla backend, browse to "menus - main menu" and in the top toolbar click "new". Then select "internal link - JCollection - Category". In the following screen you can select which category will be displayed (if you do not set this, the root category will be shown).

V. Check the frontend

Go to the frontend and check your newly created menu entry. See if your item is displayed correctly. If you want the webservice information to be shown in the category view already, make sure that you have set the parameter "overwrite_cats" (in the backend, see also "parameters").

Extended tutorial

I. Create new info types

For a custom info set type, browse to "components - JCollection - types" and click on "new" on the top toolbar. Each type has to have a name, and 10 labels for the 10 info fields. Each info fields has a HTML code assigned to it, where "{INFO1}" - "{INFO10}" is replaced by thee actual info field content. Moreover, 5 rating labels can be defined. For a new info set type storing information about stuffed animals, use the following settings:
Info 1 label: Manufacturer
Info 2 label: Animal
Info 3 label: Color
Info 1 HTML: {INFO1}
Info 2 HTML: A {INFO3} {INFO2}
Info 3 HTML:


II. Use different webservices

Each info set can use one or more webservices to fetch information. The override parameters give the order in which the individual info fields are fetched, stopping after the first success. For example, if the info set refers to a book, and the webservices Amazon, Google book and ISBNdb should be used.
The following parameter settings
info1overwrite: amazon,googlebook,isbndb
info2overwrite: isbndb,googlebook,amazon
means that for the first info field (author) the webservice Amazon is used. If for some reason Amazon does not deliver the author, Google books is used, and if this fails ISBNdb is used. For the second info field we use a different order.