MyLists Add-on Manual

Last update: July 27th, 2015

Copyright © 2010-2015 ClickFWD LLC

Chapter 1 MyLists Overview & Installation

The MyLists Add-on for JReviews allows site owners to create predefined lists into which users can add listings (Favorites, Wishlist, Watchlist, etc.); and allow users to create their own public and private lists.

1.1 Features

Unlimited number of admin-created Site Lists for specific Listing Types (i.e. Watchlist for movies, Places I visited for City Guide)

Unlimited number of user-created public or private User Lists.

Quick access to the 'Add to list' dropdown in listing detail pages, category pages and search results.

User Lists Menu to display 'User Lists' sorted by date, number of listings or list title.

My Lists Menu for users to manage their own lists and for other members to view a user's public lists.

Site Lists Joomla module to show the number of users that added the the current listing being viewed to a Site List.

User Lists Joomla module to show the latest lists or to show the lists to which the current listing being viewed has been added.

Built-in migration tool to move native JReviews Favorites into one of the Site Lists.

1.2 MyLists Add-on Installation

The add-on can be installed via the Remote Install & Update menu in the JReviews administration.

To install or update the addon you must have previously purchased it, your JReviews version needs to match or be greater than the one specified for the addon and you must have a valid "Upgrades & Support" package for your JReviews license.

If you purchased the addon, but it still says "addon not active for this license", go to the JReviews admin license screen, clear the local key text area and re-submit the license number. This will fetch a new local key that includes the addon information.

On the Install & Update page, check the Updates checkbox, and click on the Install button next to the MyLists Add-on like on this image:

Reload the page to see the MyLists Add-on link appear under the Add-ons header on the left sidebar:

Chapter 2 Configuration

The add-on comes with these configuration options:

Display 'Add to list' dropdown in the detail page listing header - Disable this if you want to display the dropdown in a custom theme position using this code:

<?php echo $Mylists->listsManager($listing);?>

Display 'Add to list' dropdown on category and search results pages - Disable this if you want to display the dropdown in a custom theme position using this code:

<?php echo $Mylists->listsManager($listing);?>

Select Listing Types in which the 'Add to list' dropdown will be displayed - The 'Add to list' dropdown will be dispayed only in listings that belong to the selected listing types.

Theme Layout - Choose which layout will be used to display listings on the list page.

Display Listing Thumbnail - If enabled, the list will display the Main Media thumbnail of the last listing added to it.

Thumbnail Mode - Choose Scale or Crop mode for thumbnails,

Thumbnail Size - Enter thumbnail dimensions in WIDTHxHEIGHT format,

Allow users to create their own lists - If enabled, users will see the 'Create new list' link in the lists dropdown.

Allow users to make their lists private - Private lists will be visible only to users that created them and site managers.

Set new user lists as private by default - If enabled, user lists will be private by default.

Select Listing Types in which users will be allowed to create their lists - The 'Create new list' link will be available in the lists dropdown of the selected listing types.

Moderate (Hold for approval) - Lists created by users will be submitted unpublished and visible only to site managers and users that created them until approved.

Chapter 3 Site lists & User lists

3.1 Creating Site Lists

Site lists are created by admins and are available to all users to add listings to. They work the same as the native "Add to Favorites" functionality in JReviews.

For example, if you have a site with products, you might want to create these 3 site lists:

Products I have

Products I had

Products I want

To create a new Site list, go the the Site Lists menu in MyLists add-on administration and click the New button in the top right corner, you will get this form:

Title - this is what the users will see in the 'Add to list' dropdown.

Description - optionally add more info about the list here and it will be displayed when users mousover the list in the 'Add to list' dropdown.

Listing Types - select listing types in which the list will appear. If left empty, the list will appear in all listing types.

State - only Published lists will appear to users.

Important - keep in mind that the 'Add to list' dropdown will appear only in the Listing Types that you select in the add-on configuration.

3.2 Adding Listings to lists

Users can add listings to lists using the 'Add to list' dropdown in the listing header:

Site Lists will appear first in the list and then the User Lists if they exist and the 'Create new list' if you allowed users to create their own lists.

3.3 Creating User lists

When users click on the 'Create new list' link, they will get this form and the listing will be automatically added to it after clicking the 'Submit' button:

Chapter 4 MyLists Menus

To create MyLists menu items, go to one of your Menus and click New in Joomla toolbar. In the menu type modal dialog choose JReviews -> MyLists:

4.1 User Lists

The 'User Lists' page allows everyone to see non-private lists that users created.

Configure the parameters in the My Lists tab:

Type of Menu - Select 'User Lists'.

Theme suffix - Allows you to create a custom suffixed lists theme file that will be used for the menu item.

User Lists Order - Choose the ordering of lists on the User Lists page.

User Lists Page total - Total number of User Lists to be shown.

User Lists limit per page - Number of lists per page.

Example of the User Lists page:

4.2 My Lists

The 'My Lists' page allows users to see and manage their own lists, and see default site lists into which they added listings. It is recommended to create this menu item in a 'User Menu'.

Configure the parameters in the My Lists tab:

Type of Menu - Select MyLists.

Theme suffix - Allows you to create a custom suffixed lists theme file that will be used for the menu item.

4.3 Catch-all Lists

The alias of this menu item is used in urls of individual list pages. This menu item should be created in a "hidden menu" (not displayed on the site).

This menu type doesn't use any parameters.

Chapter 5 MyLists Modules

5.1 User Lists Module

The User Lists module can display lists that users created, similar to the User Lists page. When published on the listing detail pages, the module can show lists that include the currently viewed listing.

The module is installed automatically with the add-on installation. You can find it in the Joomla Module Manager where you can configure and publish it.

The module comes with many parameters:

Order - Choose how the lists will be sorted.

In detail view - Choose what will be shown when the module is displayed on the listing detail page.

Display List Description

Trim Description (# words) - Choose the number of list description words that will be shown.

When no results - What will happen when there are no user lists to show.

Theme suffix - Allows you to create a custom suffixed user lists module theme file.

Show Last Listing Thumbnail - Displays the main media of the last listing added to the list.

Thumbnail Position - Choose the thumbnail position in relation to the rest of the list content.

Thumbnail Mode - Choose Scale or Crop mode for thumbnails.

Thumbnail Size - Enter thumbnail dimensions in WIDTHxHEIGHT format.

Positioning of Pagination - Choose the position of slider arrows when the module has multiple slider pages.

Page Transition - Choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).

Enable Slideshow - If enabled, the module will automatically advance slider pages.

Slideshow Interval (sec.) - Time between pages in seconds.

Max. number of results - Total number of results that will be displayed.

Results per page - How many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.

Columns - Choose how many results per row to show.

Show numbers - Adds numbers before each result.

5.2 Site Lists Module

The Site Lists module can be used only on the listing detail pages and its purpose is to show how many users added the currently viewed listing to default site lists created by the site administrator.

Example of the module output on the listing detail page:

The module is installed automatically with the add-on installation. You can find it in the Joomla Module Manager where you can configure and publish it.

Module parameters:

When no results - What will happen when there are no User Lists to show.

Theme suffix - Allows you to create a custom suffixed User Lists Module theme file.

Chapter 6 Theme Customizations

The MyLists add-on theme files are located in this folder:

/components/com_jreviews_addons/mylists/views/themes/mylists/

These theme files should not be customized in the default location, instead copy them to your custom JReviews theme in jreviews_overrides.

6.1 Overriding add-on theme files

For example, the /themes/mylists/lists/lists_list_layout.thtml theme file that is used on to generate individual list content on list pages can be copied to your custom JReviews theme like this:

/templates/jreviews_overrides/views/themes/your_theme/lists/lists_list_layout.thtml

The theme file of the User Lists module /themes/mylists/modules/mylists_userlists.thtml would go to:

/templates/jreviews_overrides/views/themes/your_theme/modules/mylists_userlists.thtml

The theme file of the Site Lists module /themes/mylists/modules/mylists_sitelists.thtml would go to:

/templates/jreviews_overrides/views/themes/your_theme/modules/mylists_sitelists.thtml

6.2 Overriding add-on css styles

CSS styles of the add-on are located in /themes/mylists/theme_css/mylists.css file, but this file should not be copied to your custom JReviews theme. Instead, only copy individual css styles that you want to customize from this file into the custom_styles.css file in your JReviews theme:

/templates/jreviews_overrides/views/themes/your_theme/theme_css/custom_styles.css

6.3 Overriding add-on language strings

The add-on language file is located here:

/components/com_jreviews_addons/mylists/locale/eng/LC_MESSAGES/default.po

If you want to customize specific language strings, copy those individual strings into your main JReviews language override file:

/templates/jreviews_overrides/locale/eng/LC_MESSAGES/default.po