This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
reviews:createwidget [2011/04/07 18:22] jposeika created |
reviews:createwidget [2013/03/29 08:42] (current) georgina |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====Creating covers widget==== | + | ======How to create a book covers widget====== |
{{http://chilifresh.com/static/cwidget_example.jpg}} | {{http://chilifresh.com/static/cwidget_example.jpg}} | ||
- | ===Here are steps to take for creating covers widget like the one in example:=== | + | =====Steps to create a widget as in the above image:===== |
- | - Log on to [[http://chilifresh.com|ChiliFresh Admin Panel]] | + | - Log on to the [[http://chilifresh.com|ChiliFresh Admin Panel]] |
- | - Since you can create several widgets for different locations of your library, to switch between the libraries navigate to **General** tab -> **Switch between libraries** and choose the library you want to create the widget for | + | - Decide which library you want to create a widget for, and choose it in "Switch between libraries" on the "General" tab |
- | - Navigate to **Reviews** tab -> **Widgets** section -> **Covers-based widget** section | + | - Go to the "Reviews" tab, choose "Widgets" and "Covers-based widget" |
- | - Input widget name such as "New widget" (for your own reference) in //Create new widget// field and click //Create widget// button which will take you to detailed settings of the widget | + | - Enter a widget name such as "Website widget" (for your own reference) in the //Create new widget// field and click the //Create widget// button to move on to the widget settings page |
- | - You must enter following information: | + | - You must enter the following information: |
- | * //Cover art URL in your OPAC// - if you want to display cover art from your provider, you can add its URL here such as http://www.coverart.com/?isbn={ISBN} - where the {ISBN} token displays where the ISBN from the widget will go. If you leave the field empty, the widget will display cover art provided by ChiliFresh | + | * //Cover art URL in your OPAC// - if you want to display cover art from a provider other than ChiliFresh, you can add the URL here. For example, http://www.coverart.com/?isbn={ISBN} - where the {ISBN} token displays where the ISBN from the widget will go. If you leave the field empty, the widget will display cover art provided by ChiliFresh. |
- | * //ISBN-lookup URL in your OPAC// - this is the URL to link directly to a particular item in your OPAC. Such as http://www.youropac.com/?isbn={ISBN} where the {ISBN} token is where the ISBN in the URL should go to link back to particular OPAC. If you cannot figure it out, please contact us at support@chilifresh.com and we will help you to figure it out | + | * //ISBN-lookup URL in your OPAC// - this is the URL that will be used to link back directly to a particular item in your OPAC. For example, http://www.youropac.com/?isbn={ISBN} where the {ISBN} token is where the ISBN in the URL should go. If you are unsure of what this URL should be, please contact us at support@chilifresh.com and we will help you to figure it out. |
* //Widget placement// - the widget can be placed in a horizontal and vertical positions | * //Widget placement// - the widget can be placed in a horizontal and vertical positions | ||
- | * //Show information from// - you can display the pre-defined lists such as "Recently reviewed items", "Most reviewed items" and "Top rated items" from your particular location you are creating the widget at or the whole library network of yours | + | * //Show information from// - you can display certain pre-defined lists such as "Recently reviewed items", "Most reviewed items", and "Top rated items"; these can be generated for the location you have chosen, or across all libraries. |
- | * //Show item author/title// - whether to show item author and title information by the cover | + | * //Show item author/title// - this sets whether or not to show the item author and title information by the cover |
- | * //Visible items// - number of covers to show on widget's visible part - other covers will be displayed when the widget is scrolled | + | * //Visible items// - you can set the number of covers to show on the initial display of the widget; other covers will be displayed when the widget is scrolled |
- | * //Total items// - how many items should be displayed totally on the widget - both visible and invisible in any of the lists | + | * //Total items// - this refers to how many items should be included in total on the widget, both visible and invisible, in any of the lists |
- | * //Button skip by// - how many covers should be skipped by when clicked on the button | + | * //Button skip by// - how many covers should be skipped when a user scrolls |
- | * //Item lists to show// - which pre-defined and user created custom item lists to show. The checked ones will be displayed and the one marked as "Default" will be displayed on front page of the widget when it loads. You can create and display custom item lists, instructions for it below. | + | * //Item lists to show// - which pre-defined and user-created item lists to show. The checked ones will be displayed and the one marked as "Default" will be displayed on front page of the widget when it loads. You can create and display custom item lists (see instructions below). |
- | - Click **Update widget** button and you will notice changes to the widget right in the "Output example" display | + | |
+ | When you're happy with the settings, just click the "Update widget" button; you'll see the changes applied to the widget in the "Output example" display. | ||
- | There you go - the widget is ready for using. Just copy&paste the code from the "Code to implement" to the place in your web page source code where you want the widget to be displayed in. | + | That's it - the widget is ready to use. Just copy and paste the code from the "Code to implement" box to the place in your web page source code where you want the widget to be displayed. |
- | ===Steps to take for creating custom item lists:=== | + | =====How to create custom item lists:===== |
- | Firstly, the purpose of custom item lists is for you to be able to display specific item lists to your patrons. Examples for lists are "Latest collection additions", "Librarian picks", etc. | + | The purpose of custom item lists is for you to be able to display specific item lists to your patrons. Examples for lists are "Latest collection additions", "Librarian picks", etc. Follow these steps to create a custom list: |
- | - Navigate to the **Covers-based widget** section | + | - In the Admin Panel, go to "Reviews", "Widgets", and "Covers-based widget" |
- | - In **Create new list** field type the list name - this list name will appear on the widget header, so please write something related to the list. You can edit it later though - and click **Create list** button. This will take you to the list editing page where you can add/remove/edit list's items | + | - In the "Create new list" field enter a list name; this list name will appear on the widget header, so write something related to the list that patrons will understand. (You can edit it later, though.) |
- | - There you can edit the list name by changing the **List name** field and clicking **Update** button | + | - Click the "Create list" button to continue to the list editing page, where you can add/remove/edit items on the list |
- | - You can add item to the list by adding item's ISBN or UPC number in the **Add item's ISBN or UPC** field and clicking **Add item**. Once you add the item, it will display item title and the cover which will appear in the widget for that particular item | + | - Here you can edit the list name if required, by changing the "List name" field and clicking the "Update" button |
- | - You can delete item from the list by clicking on the "X" link by the item's identifier | + | - You can add items to the list by adding item ISBN or UPC number(s) in the "Add item ISBN or UPC" field and clicking "Add items". You can add several item ISBNs or UPCs at once, separating them by a line-break. Once you add the item, it will display the title and cover which will appear in the widget for that particular item. |
- | - You can edit the item ISBN/UPC number by changing it in the "ISBN" field and clicking the **Update** button | + | - You can delete an item from the list by checking the "Delete" check-box by the item and clicking the "Update" button |
+ | - You can edit the item ISBN/UPC number by changing it in the "ISBN" field and clicking the "Update" button | ||
- | ===Please note following things:=== | + | =====Please note:===== |
- | * Widgets and custom item lists are location-based, so this means that if you create a widget while logged on to ChiliFresh location, you will not see the same widget and custom item lists you created after switching to a different location | + | * Widgets and custom item lists are location-based, so this means that if you create a widget while logged on to one particular ChiliFresh location, you will not see the same widget and custom item lists that you created from a different location. Use "Switch between libraries" on the "General" tab to look at other locations' widgets/lists. |
- | * You can display multiple different widgets on the same web page | + | * You can display multiple widgets on the same web page. |
- | * Once you add the widget to your web site, you can still edit it on the Admin panel - the code does not change. Which means - whenever you make a change to the widget on Admin panel, the changes will be instantly applied to the widget where it is implemented | + | * Once you add a widget to your web site, you can still edit it in the Admin Panel - the code does not change. This means that when you make a change to the widget in the Admin Panel, the changes will be instantly applied to the widget wherever it is implemented. |