Getting started guide for Sociable

From CjWiki
Revision as of 03:54, 17 February 2020 by Corejoomla (talk | contribs)
Jump to navigation Jump to search

Introduction and setup

This guide allows you to set up a Sociable extension on your website. Before starting, make sure you have the necessary packages, such as Sociable package and CjLib package, downloaded from the corejoomla.com website. To know more about how to install an extension, please read the following guide:

https://docs.joomla.org/Installing_an_extension

Sometimes, Joomla does not enable all plugins by default during the installation process. To make sure all Sociable plugins are enabled, go to Extensions -> Plugins -> Search for Sociable on this page.
Make sure to enable all core plugins. There are many integration plugins that are shipped with the package, you need not enable them if you do not have such a third-party extension installed on your site. For example, all corejoomla extensions integration plugins can be found on the plugins page. Enable them only if you have respective extensions installed.

Configuration

Permissions.PNG

Sociable comes with many configuration options to customize the look and feel, features support and so on. After installing the extension, go to Components -> Sociable and click on the Options button the toolbar. Now you will be shown with a list of configurable options. Each option is documented on its label for easy reference. Make sure to review all the options and customize them according to your needs.

  • Profile: These options allow you to customize how the profile page looks and allow you to enable/disable Sociable core features of profiles.
  • List Layouts: These settings apply to the list layouts such as group topics listing etc.
  • Media settings: These settings allow you to customize the behavior of user uploads and how the photos/videos are displayed on the wall etc.
  • Shared options: These are the common settings that apply to the component.
  • Integration: Using these settings, you can integrate the extension with third-party extensions, customize the default layout according to your template's Bootstrap version, customize the color theme, etc.
  • Permissions: These are permissions that you can configure to allow your users to authorize the functions available in the component.

Permissions

In the options page, you can customize the component permissions in the Permissions tab. Every user group has certain permissions that you can allow. For example which user group can create posts etc. Configure the permissions according to your needs.

Menu items setup

Once you setup the options and permissions, the next step is configuring the menu items. Apart from allowing your user's access to the component, menu items define your component URLs. So they are very important in setting up search engine friendly URLs and easy access to your extension pages. Sociable provides the menu item for each supported feature. You need not show all menu items on your front-end site. Simply add a new Menus, let's say Sociable Menu, and add all available menu items of Sociable to these Menus. You can create a Menu Alias type menu item to link to one of these Menus in your Main Menu. This way, your users will be shown only one Menu item which is needed to access the site and other menu items are used to render the URLs. You can set up one of the Sociable menu items as your home page menu item if you would like to use Sociable as a default home page.

To learn more about Joomla menu creation, please read the following documentation.
https://docs.joomla.org/Menu
https://docs.joomla.org/Adding_a_new_menu_item

Multi-profile setup

Sociable allows you to configure multiple profiles according to your user groups. You will need to set up at least one profile that will act as a default/favorite profile and apply it to the user automatically when the user registers on your site. Any other profiles that you create can be assigned manually to the users (feature available from v1.0.2). To learn more about how to set up multiple profiles, read the following documentation.

https://wiki.corejoomla.com/Configuring_multiple_profiles_in_Sociable

Please note that you must select Sociable as the profile/avatar system in the component options in order to use the built-in profile system. If you wish to use any supported third-party profile/avatars system you can do so by setting up the respective option in the component options. Go to Components -> Sociable and click on the Options button the toolbar and click on the Integration tab to configure the integration settings.

If you are a developer and you would like to integrate Sociable profile and avatar systems into your custom extension, please read the following documentation.
https://wiki.corejoomla.com/Sociable_Profile_API
https://wiki.corejoomla.com/Sociable_Avatars_API

Initial user sync

When Sociable installed for the first time, it will not have any information about your users. It needs to be synced up with your existing users in order to allow them integrated with the Sociable profile system. To do this, go to Components -> Sociable -> Users and click on the Sync button on the toolbar. The process will show the progress and may take a while depending on the number of users existing on your site. Once the sync is completed, your user profiles are created and assigned default profile according to the profiles that you created.

Setting up the points system

Sociable has a built-in points system that allows you to award points for the actions done on your site. To learn more about how to set up the points system, read the following documentation.

https://wiki.corejoomla.com/Setting_up_points_system_for_Sociable

If you are a developer and you would like to extend the Sociable points system to your custom extensions, please read the following documentation.
https://wiki.corejoomla.com/Sociable_Points_System_API

Setting up the badge system

Sociable has a built-in badge system that allows users to get rewarded for active participation on your site and get involved. You can reward multiple different badges according to activity, for example when the user posts 10 photos, 20 photos, 50 photos and so on. This way, your users will get the motivation to be involved in their interested pages.

To learn more about how to set up the badge system, please read the following documentation.
https://wiki.corejoomla.com/Setting_up_badge_system_for_Sociable

Setting up the activity streams

Sociable has a built-in activity stream system that allows your users to post content directly on their wall and also allows you to integrate the content from supported third-party extensions. User's privacy can be maintained using the scopes, i.e. the users can only see the content which they are allowed to see. They can set up the scope for each activity that they post on the wall. For example, the "Friends" scope can allow the posts visible to only the friends of the user and hidden from other users.

To learn more about how to set up the activity stream system, please read the following documentation.
https://wiki.corejoomla.com/Setting_up_activity_streams_system_for_Sociable